1 |
jmc |
1.20 |
C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.54 2011/12/19 16:22:26 mlosch Exp $ |
2 |
dimitri |
1.8 |
C $Name: $ |
3 |
dimitri |
1.2 |
|
4 |
jmc |
1.17 |
C *==========================================================* |
5 |
jmc |
1.20 |
C | SEAICE_OPTIONS.h |
6 |
|
|
C | o CPP options file for sea ice package. |
7 |
jmc |
1.17 |
C *==========================================================* |
8 |
jmc |
1.20 |
C | Use this file for selecting options within the sea ice |
9 |
|
|
C | package. |
10 |
jmc |
1.17 |
C *==========================================================* |
11 |
dimitri |
1.2 |
|
12 |
edhill |
1.4 |
#ifndef SEAICE_OPTIONS_H |
13 |
|
|
#define SEAICE_OPTIONS_H |
14 |
|
|
#include "PACKAGES_CONFIG.h" |
15 |
dimitri |
1.2 |
#include "CPP_OPTIONS.h" |
16 |
|
|
|
17 |
jmc |
1.20 |
#ifdef ALLOW_SEAICE |
18 |
|
|
C Package-specific Options & Macros go here |
19 |
|
|
|
20 |
dimitri |
1.2 |
C-- Write "text-plots" of certain fields in STDOUT for debugging. |
21 |
|
|
#undef SEAICE_DEBUG |
22 |
|
|
|
23 |
|
|
C-- Allow sea-ice dynamic code. |
24 |
|
|
C This option is provided to allow use of TAMC |
25 |
|
|
C on the thermodynamics component of the code only. |
26 |
|
|
C Sea-ice dynamics can also be turned off at runtime |
27 |
|
|
C using variable SEAICEuseDYNAMICS. |
28 |
|
|
#define SEAICE_ALLOW_DYNAMICS |
29 |
|
|
|
30 |
|
|
C-- By default, the sea-ice package uses its own integrated bulk |
31 |
|
|
C formulae to compute fluxes (fu, fv, EmPmR, Qnet, and Qsw) over |
32 |
|
|
C open-ocean. When this flag is set, these variables are computed |
33 |
|
|
C in a separate external package, for example, pkg/exf, and then |
34 |
|
|
C modified for sea-ice effects by pkg/seaice. |
35 |
dimitri |
1.9 |
#define SEAICE_EXTERNAL_FLUXES |
36 |
dimitri |
1.2 |
|
37 |
dimitri |
1.6 |
C-- By default, the sea-ice package uses 2-category thermodynamics. |
38 |
|
|
C When this flag is set, an 8-category calculation of ice |
39 |
|
|
C thermodynamics is carried out in groatb.F |
40 |
dimitri |
1.8 |
C Note the pickup_seaice.* generated by this option differ |
41 |
|
|
C from those generated with the default 2-category model. |
42 |
|
|
C Therefore it is not possible to switch between the two |
43 |
|
|
C in the middle of an integration. |
44 |
|
|
#undef SEAICE_MULTICATEGORY |
45 |
|
|
|
46 |
jmc |
1.17 |
C-- Use the Old version of seaice_growth (close to cvs version 1.70) |
47 |
|
|
C otherwise, use the merged version (with some of Ian Fenty s code) |
48 |
|
|
#define SEAICE_GROWTH_LEGACY |
49 |
|
|
|
50 |
|
|
C-- options only available in the merged version (from Ian Fenty s code) |
51 |
|
|
#ifndef SEAICE_GROWTH_LEGACY |
52 |
jmc |
1.20 |
C- to ensure heat conservation in the coupled ocean-seaice system |
53 |
|
|
# undef SEAICE_HEAT_CONSERV_FIX |
54 |
jmc |
1.17 |
C- to switch on/off open-water freezing contribution to thickness tendency: |
55 |
jmc |
1.20 |
# define SEAICE_DO_OPEN_WATER_GROWTH |
56 |
|
|
C- ifdef SEAICE_DO_OPEN_WATER_GROWTH then define SEAICE_DO_OPEN_WATER_MELT |
57 |
|
|
C to also allow open-water air-sea heat fluxes melt ice |
58 |
|
|
# undef SEAICE_DO_OPEN_WATER_MELT |
59 |
jmc |
1.17 |
C- to switch on/off ocean heat contribution to seaice cover reduction: |
60 |
jmc |
1.20 |
# define SEAICE_OCN_MELT_ACT_ON_AREA |
61 |
|
|
C- to preclude infinitesimal ice concentrations: |
62 |
|
|
# undef ALLOW_PRECLUDE_INFINITESIMAL_AREA |
63 |
jmc |
1.17 |
#endif |
64 |
|
|
|
65 |
jmc |
1.20 |
C- to use the MCPhee formula in computing ocean/ice fluxes |
66 |
|
|
#undef MCPHEE_OCEAN_ICE_HEAT_FLUX |
67 |
|
|
|
68 |
jmc |
1.17 |
C-- Use the Old version of seaice_solve4temp (formerly seaice_budget_ice) |
69 |
|
|
C otherwise, use Ian Fenty s version |
70 |
|
|
#define SEAICE_SOLVE4TEMP_LEGACY |
71 |
|
|
|
72 |
|
|
C-- By default the freezing point of water is set to the value of |
73 |
dimitri |
1.8 |
C the parameter SEAICE_freeze (=-1.96 by default). To use a |
74 |
jmc |
1.17 |
C simple linear dependence of the freezing point on salinity, |
75 |
dimitri |
1.8 |
C set the following flag (pressure is assumed to have no effect, |
76 |
|
|
C which is a good assumption for the top 20 meters). With this |
77 |
|
|
C option defined the parameter SEAICE_freeze has no effect. |
78 |
gforget |
1.16 |
#define SEAICE_VARIABLE_FREEZING_POINT |
79 |
dimitri |
1.8 |
|
80 |
|
|
C-- Allow SEAICEuseFlooding, which converts snow to ice if submerged. |
81 |
dimitri |
1.9 |
#define ALLOW_SEAICE_FLOODING |
82 |
dimitri |
1.8 |
|
83 |
|
|
C-- By default sea ice is fresh. Set following flag for salty ice. |
84 |
ifenty |
1.19 |
#define SEAICE_VARIABLE_SALINITY |
85 |
dimitri |
1.8 |
|
86 |
dimitri |
1.11 |
C-- Track sea ice age. |
87 |
|
|
#define SEAICE_AGE |
88 |
|
|
|
89 |
jmc |
1.20 |
C-- Tracers of ice and/or ice cover. |
90 |
|
|
#undef ALLOW_SITRACER |
91 |
|
|
#ifdef ALLOW_SITRACER |
92 |
|
|
C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff. |
93 |
|
|
# define ALLOW_SITRACER_ADVCAP |
94 |
|
|
#endif |
95 |
|
|
|
96 |
jmc |
1.17 |
C-- By default the seaice model is discretized on a B-Grid (for |
97 |
dimitri |
1.8 |
C historical reasons). Define the following flag to use a new |
98 |
|
|
C (not thoroughly) test version on a C-grid |
99 |
|
|
#define SEAICE_CGRID |
100 |
|
|
|
101 |
jmc |
1.17 |
C-- Only for the C-grid version it is possible to |
102 |
dimitri |
1.8 |
#ifdef SEAICE_CGRID |
103 |
dimitri |
1.11 |
C enable EVP code by defining the following flag |
104 |
dimitri |
1.14 |
# define SEAICE_ALLOW_EVP |
105 |
|
|
# ifdef SEAICE_ALLOW_EVP |
106 |
mlosch |
1.13 |
C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit |
107 |
|
|
C-- viscosities from below and above in seaice_evp |
108 |
gforget |
1.16 |
C-- not necessary, and not recommended |
109 |
dimitri |
1.14 |
# define SEAICE_ALLOW_CLIPZETA |
110 |
|
|
# endif /* SEAICE_ALLOW_EVP */ |
111 |
dimitri |
1.11 |
C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM) |
112 |
dimitri |
1.14 |
# undef SEAICE_ALLOW_TEM |
113 |
|
|
#else /* not SEAICE_CGRID, but old B-grid */ |
114 |
|
|
C-- By default for B-grid dynamics solver wind stress under sea-ice is |
115 |
|
|
C set to the same value as it would be if there was no sea-ice. |
116 |
|
|
C Define following CPP flag for B-grid ice-ocean stress coupling. |
117 |
|
|
# define SEAICE_BICE_STRESS |
118 |
|
|
|
119 |
|
|
C-- By default for B-grid dynamics solver surface tilt is obtained |
120 |
|
|
C indirectly via geostrophic velocities. Define following CPP |
121 |
|
|
C in order to use ETAN instead. |
122 |
|
|
# define EXPLICIT_SSH_SLOPE |
123 |
jmc |
1.20 |
C-- Defining this flag turns on a FV-discretization of the B-grid LSOR |
124 |
|
|
C solver. It is smoother and includes all metric terms, similar to the |
125 |
|
|
C C-grid solver. It is here for completeness, but its usefulness is |
126 |
|
|
C unclear. |
127 |
|
|
# undef SEAICE_LSRBNEW |
128 |
dimitri |
1.8 |
#endif /* SEAICE_CGRID */ |
129 |
|
|
|
130 |
|
|
C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth |
131 |
|
|
#undef SEAICE_CAP_HEFF |
132 |
jmc |
1.17 |
C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box |
133 |
|
|
#undef SEAICE_CAP_ICELOAD |
134 |
mlosch |
1.12 |
C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s, |
135 |
gforget |
1.16 |
C-- not recommended |
136 |
mlosch |
1.12 |
#define SEAICE_ALLOW_CLIPVELS |
137 |
edhill |
1.4 |
|
138 |
gforget |
1.15 |
C enable free drift code |
139 |
|
|
#define SEAICE_ALLOW_FREEDRIFT |
140 |
|
|
|
141 |
jmc |
1.20 |
#endif /* ALLOW_SEAICE */ |
142 |
edhill |
1.4 |
#endif /* SEAICE_OPTIONS_H */ |
143 |
dimitri |
1.8 |
|
144 |
|
|
CEH3 ;;; Local Variables: *** |
145 |
|
|
CEH3 ;;; mode:fortran *** |
146 |
|
|
CEH3 ;;; End: *** |