1 |
dimitri |
1.1 |
C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.63 2012/03/08 01:15:02 gforget Exp $ |
2 |
|
|
|
3 |
|
|
C *==========================================================* |
4 |
|
|
C | SEAICE_OPTIONS.h |
5 |
|
|
C | o CPP options file for sea ice package. |
6 |
|
|
C *==========================================================* |
7 |
|
|
C | Use this file for selecting options within the sea ice |
8 |
|
|
C | package. |
9 |
|
|
C *==========================================================* |
10 |
|
|
|
11 |
|
|
#ifndef SEAICE_OPTIONS_H |
12 |
|
|
#define SEAICE_OPTIONS_H |
13 |
|
|
#include "PACKAGES_CONFIG.h" |
14 |
|
|
#include "CPP_OPTIONS.h" |
15 |
|
|
|
16 |
|
|
#ifdef ALLOW_SEAICE |
17 |
|
|
C Package-specific Options & Macros go here |
18 |
|
|
|
19 |
|
|
C-- Write "text-plots" of certain fields in STDOUT for debugging. |
20 |
|
|
#undef SEAICE_DEBUG |
21 |
|
|
|
22 |
|
|
C-- Allow sea-ice dynamic code. |
23 |
|
|
C This option is provided to allow use of TAMC |
24 |
|
|
C on the thermodynamics component of the code only. |
25 |
|
|
C Sea-ice dynamics can also be turned off at runtime |
26 |
|
|
C using variable SEAICEuseDYNAMICS. |
27 |
|
|
#define SEAICE_ALLOW_DYNAMICS |
28 |
|
|
|
29 |
|
|
C-- By default, the sea-ice package uses its own integrated bulk |
30 |
|
|
C formulae to compute fluxes (fu, fv, EmPmR, Qnet, and Qsw) over |
31 |
|
|
C open-ocean. When this flag is set, these variables are computed |
32 |
|
|
C in a separate external package, for example, pkg/exf, and then |
33 |
|
|
C modified for sea-ice effects by pkg/seaice. |
34 |
|
|
#define SEAICE_EXTERNAL_FLUXES |
35 |
|
|
|
36 |
|
|
C-- By default, the sea-ice package uses 2-category thermodynamics. |
37 |
|
|
C When this flag is set, an 8-category calculation of ice |
38 |
|
|
C thermodynamics is carried out in groatb.F |
39 |
|
|
C Note the pickup_seaice.* generated by this option differ |
40 |
|
|
C from those generated with the default 2-category model. |
41 |
|
|
C Therefore it is not possible to switch between the two |
42 |
|
|
C in the middle of an integration. |
43 |
dimitri |
1.2 |
#define SEAICE_MULTICATEGORY |
44 |
|
|
|
45 |
|
|
CToM<<< |
46 |
|
|
C-- run with sea ice thickness distribution; |
47 |
|
|
C set number of categories (nITD) in SIZE.h |
48 |
torge |
1.3 |
#define SEAICE_ITD |
49 |
dimitri |
1.2 |
C |
50 |
|
|
C-- SEAICE_ITD replaces SEAICE_MULTICATEGORY |
51 |
torge |
1.3 |
#ifdef SEAICE_ITD |
52 |
|
|
#undef SEAICE_MULTICATEGORY |
53 |
|
|
#endif |
54 |
dimitri |
1.2 |
C>>>ToM |
55 |
dimitri |
1.1 |
|
56 |
|
|
C-- Use the Old version of seaice_growth (close to cvs version 1.70) |
57 |
|
|
C otherwise, use the merged version (with some of Ian Fenty s code) |
58 |
dimitri |
1.2 |
#undef SEAICE_GROWTH_LEGACY |
59 |
dimitri |
1.1 |
|
60 |
|
|
C-- Since the missing sublimation term is now included |
61 |
|
|
C this flag is needed for backward compatibility |
62 |
|
|
#undef SEAICE_DISABLE_SUBLIM |
63 |
|
|
|
64 |
|
|
C-- Suspected missing term in coupled ocn-ice heat budget (to be further tested) |
65 |
dimitri |
1.2 |
#undef SEAICE_DISABLE_HEATCONSFIX |
66 |
dimitri |
1.1 |
|
67 |
|
|
C-- options only available in the merged version |
68 |
dimitri |
1.2 |
ccc#ifndef SEAICE_GROWTH_LEGACY |
69 |
dimitri |
1.1 |
C- to ensure heat conservation in the coupled ocean-seaice system |
70 |
dimitri |
1.2 |
ccc# undef SEAICE_HEAT_CONSERV_FIX |
71 |
dimitri |
1.1 |
C- to preclude infinitesimal ice concentrations: |
72 |
dimitri |
1.2 |
ccc# undef ALLOW_PRECLUDE_INFINITESIMAL_AREA |
73 |
|
|
ccc#endif |
74 |
|
|
CToM<<< |
75 |
|
|
C-- The freezing point of water is a simple linear dependence to salinity. |
76 |
|
|
C The flag below is now obsolete, but kept to ease the transition |
77 |
|
|
C from the old constant freezing point default (see seaice_check.F). |
78 |
|
|
#define SEAICE_VARIABLE_FREEZING_POINT |
79 |
|
|
C>>>ToM |
80 |
dimitri |
1.1 |
|
81 |
|
|
C-- By default sea ice is fresh. Set following flag for salty ice. |
82 |
dimitri |
1.2 |
#define SEAICE_VARIABLE_SALINITY |
83 |
dimitri |
1.1 |
|
84 |
|
|
C-- Tracers of ice and/or ice cover. |
85 |
dimitri |
1.2 |
#define ALLOW_SITRACER |
86 |
dimitri |
1.1 |
#ifdef ALLOW_SITRACER |
87 |
|
|
C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff. |
88 |
|
|
# define ALLOW_SITRACER_ADVCAP |
89 |
|
|
#endif |
90 |
|
|
|
91 |
|
|
C-- By default the seaice model is discretized on a B-Grid (for |
92 |
|
|
C historical reasons). Define the following flag to use a new |
93 |
|
|
C (not thoroughly) test version on a C-grid |
94 |
|
|
#define SEAICE_CGRID |
95 |
|
|
|
96 |
|
|
C-- Only for the C-grid version it is possible to |
97 |
|
|
#ifdef SEAICE_CGRID |
98 |
|
|
C enable EVP code by defining the following flag |
99 |
|
|
# define SEAICE_ALLOW_EVP |
100 |
|
|
# ifdef SEAICE_ALLOW_EVP |
101 |
|
|
C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit |
102 |
|
|
C-- viscosities from below and above in seaice_evp |
103 |
|
|
C-- not necessary, and not recommended |
104 |
|
|
# undef SEAICE_ALLOW_CLIPZETA |
105 |
|
|
# endif /* SEAICE_ALLOW_EVP */ |
106 |
|
|
C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM) |
107 |
|
|
# undef SEAICE_ALLOW_TEM |
108 |
|
|
#else /* not SEAICE_CGRID, but old B-grid */ |
109 |
|
|
C-- By default for B-grid dynamics solver wind stress under sea-ice is |
110 |
|
|
C set to the same value as it would be if there was no sea-ice. |
111 |
|
|
C Define following CPP flag for B-grid ice-ocean stress coupling. |
112 |
|
|
# define SEAICE_BICE_STRESS |
113 |
|
|
|
114 |
|
|
C-- By default for B-grid dynamics solver surface tilt is obtained |
115 |
|
|
C indirectly via geostrophic velocities. Define following CPP |
116 |
|
|
C in order to use ETAN instead. |
117 |
|
|
# define EXPLICIT_SSH_SLOPE |
118 |
|
|
C-- Defining this flag turns on a FV-discretization of the B-grid LSOR |
119 |
|
|
C solver. It is smoother and includes all metric terms, similar to the |
120 |
|
|
C C-grid solver. It is here for completeness, but its usefulness is |
121 |
|
|
C unclear. |
122 |
|
|
# undef SEAICE_LSRBNEW |
123 |
|
|
#endif /* SEAICE_CGRID */ |
124 |
|
|
|
125 |
|
|
C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth |
126 |
|
|
#undef SEAICE_CAP_HEFF |
127 |
|
|
C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box |
128 |
|
|
#undef SEAICE_CAP_ICELOAD |
129 |
|
|
C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s, |
130 |
|
|
C-- not recommended |
131 |
|
|
#undef SEAICE_ALLOW_CLIPVELS |
132 |
|
|
C-- When set cap the sublimation latent heat flux in solve4temp |
133 |
|
|
C according to the available amount of ice+snow. Otherwise this |
134 |
|
|
C term is treated like all of the others -- residuals heat and |
135 |
|
|
C fw stocks are passed to the ocean at the end of seaice_growth |
136 |
|
|
C in a conservative manner. SEAICE_CAP_SUBLIM is not needed |
137 |
|
|
C as of now, but kept just in case. |
138 |
|
|
#undef SEAICE_CAP_SUBLIM |
139 |
|
|
|
140 |
|
|
C enable free drift code |
141 |
|
|
#undef SEAICE_ALLOW_FREEDRIFT |
142 |
|
|
|
143 |
|
|
#endif /* ALLOW_SEAICE */ |
144 |
|
|
#endif /* SEAICE_OPTIONS_H */ |
145 |
|
|
|
146 |
|
|
CEH3 ;;; Local Variables: *** |
147 |
|
|
CEH3 ;;; mode:fortran *** |
148 |
|
|
CEH3 ;;; End: *** |