1 |
dimitri |
1.1 |
C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.61 2012/02/13 23:20:36 gforget 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 |
|
|
C-- By default, the sea-ice package uses 2-category thermodynamics. |
42 |
|
|
C When this flag is set, an 8-category calculation of ice |
43 |
|
|
C thermodynamics is carried out in groatb.F |
44 |
|
|
C Note the pickup_seaice.* generated by this option differ |
45 |
|
|
C from those generated with the default 2-category model. |
46 |
|
|
C Therefore it is not possible to switch between the two |
47 |
|
|
C in the middle of an integration. |
48 |
|
|
#undef SEAICE_MULTICATEGORY |
49 |
|
|
|
50 |
|
|
C-- Use the Old version of seaice_growth (close to cvs version 1.70) |
51 |
|
|
C otherwise, use the merged version (with some of Ian Fenty s code) |
52 |
|
|
#undef SEAICE_GROWTH_LEGACY |
53 |
|
|
|
54 |
|
|
C-- Since the missing sublimation term is now included |
55 |
|
|
C this flag is needed for backward compatibility |
56 |
|
|
#undef SEAICE_DISABLE_SUBLIM |
57 |
|
|
|
58 |
|
|
C-- Suspected missing term in coupled ocn-ice heat budget (to be further |
59 |
|
|
C gtested) |
60 |
|
|
#undef SEAICE_DISABLE_HEATCONSFIX |
61 |
|
|
|
62 |
|
|
C-- The freezing point of water is a simple linear dependence to salinity. |
63 |
|
|
C The flag below is now obsolete, but kept to ease the transition |
64 |
|
|
C from the old constant freezing point default (see seaice_check.F). |
65 |
|
|
#define SEAICE_VARIABLE_FREEZING_POINT |
66 |
|
|
|
67 |
|
|
C-- The functionality of this flag has been moved to SItracer making |
68 |
|
|
C this flag obsolete. |
69 |
|
|
#undef SEAICE_VARIABLE_SALINITY |
70 |
|
|
|
71 |
|
|
C-- Tracers of ice and/or ice cover. |
72 |
|
|
#undef ALLOW_SITRACER |
73 |
|
|
#ifdef ALLOW_SITRACER |
74 |
|
|
C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff. |
75 |
|
|
# define ALLOW_SITRACER_ADVCAP |
76 |
|
|
#endif |
77 |
|
|
|
78 |
|
|
C-- By default the seaice model is discretized on a B-Grid (for |
79 |
|
|
C historical reasons). Define the following flag to use a new |
80 |
|
|
C (not thoroughly) test version on a C-grid |
81 |
|
|
#define SEAICE_CGRID |
82 |
|
|
|
83 |
|
|
C-- Only for the C-grid version it is possible to |
84 |
|
|
#ifdef SEAICE_CGRID |
85 |
|
|
C enable EVP code by defining the following flag |
86 |
|
|
# undef SEAICE_ALLOW_EVP |
87 |
|
|
# ifdef SEAICE_ALLOW_EVP |
88 |
|
|
C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit |
89 |
|
|
C-- viscosities from below and above in seaice_evp |
90 |
|
|
C-- not necessary, and not recommended |
91 |
|
|
# undef SEAICE_ALLOW_CLIPZETA |
92 |
|
|
# endif /* SEAICE_ALLOW_EVP */ |
93 |
|
|
C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM) |
94 |
|
|
# undef SEAICE_ALLOW_TEM |
95 |
|
|
#else /* not SEAICE_CGRID, but old B-grid */ |
96 |
|
|
C-- By default for B-grid dynamics solver wind stress under sea-ice is |
97 |
|
|
C set to the same value as it would be if there was no sea-ice. |
98 |
|
|
C Define following CPP flag for B-grid ice-ocean stress coupling. |
99 |
|
|
# define SEAICE_BICE_STRESS |
100 |
|
|
|
101 |
|
|
C-- By default for B-grid dynamics solver surface tilt is obtained |
102 |
|
|
C indirectly via geostrophic velocities. Define following CPP |
103 |
|
|
C in order to use ETAN instead. |
104 |
|
|
# define EXPLICIT_SSH_SLOPE |
105 |
|
|
C-- Defining this flag turns on a FV-discretization of the B-grid LSOR |
106 |
|
|
C solver. It is smoother and includes all metric terms, similar to the |
107 |
|
|
C C-grid solver. It is here for completeness, but its usefulness is |
108 |
|
|
C unclear. |
109 |
|
|
# undef SEAICE_LSRBNEW |
110 |
|
|
#endif /* SEAICE_CGRID */ |
111 |
|
|
|
112 |
|
|
C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth |
113 |
|
|
C currently only relevant for SEAICE_GROWTH_LEGACY |
114 |
|
|
#undef SEAICE_CAP_HEFF |
115 |
|
|
C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box |
116 |
|
|
#undef SEAICE_CAP_ICELOAD |
117 |
|
|
C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s, |
118 |
|
|
C-- not recommended |
119 |
|
|
#undef SEAICE_ALLOW_CLIPVELS |
120 |
|
|
C-- When set cap the sublimation latent heat flux in solve4temp |
121 |
|
|
C according to the available amount of ice+snow. Otherwise this |
122 |
|
|
C term is treated like all of the others -- residuals heat and |
123 |
|
|
C fw stocks are passed to the ocean at the end of seaice_growth |
124 |
|
|
C in a conservative manner. SEAICE_CAP_SUBLIM is not needed |
125 |
|
|
C as of now, but kept just in case. |
126 |
|
|
#undef SEAICE_CAP_SUBLIM |
127 |
|
|
|
128 |
|
|
C-- enable free drift code |
129 |
|
|
#undef SEAICE_ALLOW_FREEDRIFT |
130 |
|
|
|
131 |
|
|
#endif /* ALLOW_SEAICE */ |
132 |
|
|
#endif /* SEAICE_OPTIONS_H */ |
133 |
|
|
|
134 |
|
|
CEH3 ;;; Local Variables: *** |
135 |
|
|
CEH3 ;;; mode:fortran *** |
136 |
|
|
CEH3 ;;; End: *** |