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