lab_sea/code_ad/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/verification/lab_sea/code_ad/SEAICE_OPTIONS.h,v 1.19 2012/02/13 23:25:08 gforget Exp $
C $Name:  $

C     *==========================================================*
C     | SEAICE_OPTIONS.h
C     | o CPP options file for sea ice package.
C     *==========================================================*
C     | Use this file for selecting options within the sea ice
C     | package.
C     *==========================================================*

#ifndef SEAICE_OPTIONS_H
#define SEAICE_OPTIONS_H
#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"

#ifdef ALLOW_SEAICE
C     Package-specific Options & Macros go here

C--   Write "text-plots" of certain fields in STDOUT for debugging.
#undef SEAICE_DEBUG

C--   Allow sea-ice dynamic code.
C     This option is provided to allow use of TAMC
C     on the thermodynamics component of the code only.
C     Sea-ice dynamics can also be turned off at runtime
C     using variable SEAICEuseDYNAMICS.
#define SEAICE_ALLOW_DYNAMICS

C--   By default, the sea-ice package uses its own integrated bulk
C     formulae to compute fluxes (fu, fv, EmPmR, Qnet, and Qsw) over
C     open-ocean.  When this flag is set, these variables are computed
C     in a separate external package, for example, pkg/exf, and then
C     modified for sea-ice effects by pkg/seaice.
#define SEAICE_EXTERNAL_FLUXES

C--   By default, the sea-ice package uses 2-category thermodynamics.
C     When this flag is set, an 8-category calculation of ice
C     thermodynamics is carried out in groatb.F
C     Note the pickup_seaice.* generated by this option differ
C     from those generated with the default 2-category model.
C     Therefore it is not possible to switch between the two
C     in the middle of an integration.
#define SEAICE_MULTICATEGORY

C--   Use the Old version of seaice_growth (close to cvs version 1.70)
C     otherwise, use the merged version (with some of Ian Fenty s code)
#define SEAICE_GROWTH_LEGACY

C--   Since the missing sublimation term is now included
C     this flag is needed for backward compatibility
#define SEAICE_DISABLE_SUBLIM

C--   Suspected missing term in coupled ocn-ice heat budget (to be further tested)
#define SEAICE_DISABLE_HEATCONSFIX

C--   options only available in the merged version
#ifndef SEAICE_GROWTH_LEGACY
C-    to ensure heat conservation in the coupled ocean-seaice system
# undef SEAICE_HEAT_CONSERV_FIX
C-    to preclude infinitesimal ice concentrations:
# undef ALLOW_PRECLUDE_INFINITESIMAL_AREA
#endif

C--   The freezing point of water is a simple linear dependence to salinity.
C     The flag below is now obsolete, but kept to ease the transition
C     from the old constant freezing point default (see seaice_check.F).
#define SEAICE_VARIABLE_FREEZING_POINT

C--   The flags below are obsolete, but kept to ease the transition
C     from the old default to the new one (see seaice_check.F).
#define MCPHEE_OCEAN_ICE_HEAT_FLUX
#define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR

C--   By default sea ice is fresh.  Set following flag for salty ice.
#define SEAICE_VARIABLE_SALINITY

C--   Tracers of ice and/or ice cover.
#undef ALLOW_SITRACER
#ifdef ALLOW_SITRACER
C--   To try avoid 'spontaneous generation' of tracer maxima by advdiff.
# define ALLOW_SITRACER_ADVCAP
#endif

C--   By default the seaice model is discretized on a B-Grid (for
C     historical reasons). Define the following flag to use a new
C     (not thoroughly) test version on a C-grid
#define SEAICE_CGRID

C--   Only for the C-grid version it is possible to
#ifdef SEAICE_CGRID
C     enable EVP code by defining the following flag
# define SEAICE_ALLOW_EVP
# ifdef SEAICE_ALLOW_EVP
C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit
C--   viscosities from below and above in seaice_evp
C--   not necessary, and not recommended
#  undef SEAICE_ALLOW_CLIPZETA
# endif /* SEAICE_ALLOW_EVP */
C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
# undef SEAICE_ALLOW_TEM
#else /* not SEAICE_CGRID, but old B-grid */
C--   By default for B-grid dynamics solver wind stress under sea-ice is
C     set to the same value as it would be if there was no sea-ice.
C     Define following CPP flag for B-grid ice-ocean stress coupling.
# define SEAICE_BICE_STRESS

C--   By default for B-grid dynamics solver surface tilt is obtained
C     indirectly via geostrophic velocities. Define following CPP
C     in order to use ETAN instead.
# define EXPLICIT_SSH_SLOPE
C--   Defining this flag turns on a FV-discretization of the B-grid LSOR
C     solver. It is smoother and includes all metric terms, similar to the
C     C-grid solver. It is here for completeness, but its usefulness is
C     unclear.
# undef SEAICE_LSRBNEW
#endif /* SEAICE_CGRID */

C--   When set use MAX_HEFF to cap sea ice thickness in seaice_growth
#undef SEAICE_CAP_HEFF
C--   When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
#undef SEAICE_CAP_ICELOAD
C--   When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
C--   not recommended
#undef SEAICE_ALLOW_CLIPVELS

C     enable free drift code
#define SEAICE_ALLOW_FREEDRIFT

#endif /* ALLOW_SEAICE */
#endif /* SEAICE_OPTIONS_H */

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	gforget	1.20	C $Header: /u/gcmpack/MITgcm/verification/lab_sea/code_ad/SEAICE_OPTIONS.h,v 1.19 2012/02/13 23:25:08 gforget Exp $
2	jmc	1.4	C $Name: $
3	heimbach	1.1
4	jmc	1.9	C ==========================================================
5	jmc	1.14	C \| SEAICE_OPTIONS.h
6			C \| o CPP options file for sea ice package.
7	jmc	1.9	C ==========================================================
8	jmc	1.14	C \| Use this file for selecting options within the sea ice
9			C \| package.
10	jmc	1.9	C ==========================================================
11	heimbach	1.1
12			#ifndef SEAICE_OPTIONS_H
13			#define SEAICE_OPTIONS_H
14			#include "PACKAGES_CONFIG.h"
15			#include "CPP_OPTIONS.h"
16
17	jmc	1.14	#ifdef ALLOW_SEAICE
18			C Package-specific Options & Macros go here
19
20	heimbach	1.1	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			#define SEAICE_EXTERNAL_FLUXES
36
37			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			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	heimbach	1.6	#define SEAICE_MULTICATEGORY
45	heimbach	1.1
46	jmc	1.9	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	gforget	1.18	C-- Since the missing sublimation term is now included
51			C this flag is needed for backward compatibility
52			#define SEAICE_DISABLE_SUBLIM
53
54	gforget	1.19	C-- Suspected missing term in coupled ocn-ice heat budget (to be further tested)
55			#define SEAICE_DISABLE_HEATCONSFIX
56
57	gforget	1.17	C-- options only available in the merged version
58	jmc	1.9	#ifndef SEAICE_GROWTH_LEGACY
59	jmc	1.14	C- to ensure heat conservation in the coupled ocean-seaice system
60			# undef SEAICE_HEAT_CONSERV_FIX
61			C- to preclude infinitesimal ice concentrations:
62			# undef ALLOW_PRECLUDE_INFINITESIMAL_AREA
63	jmc	1.9	#endif
64
65	gforget	1.18	C-- The freezing point of water is a simple linear dependence to salinity.
66			C The flag below is now obsolete, but kept to ease the transition
67			C from the old constant freezing point default (see seaice_check.F).
68			#define SEAICE_VARIABLE_FREEZING_POINT
69	jmc	1.9
70	gforget	1.20	C-- The flags below are obsolete, but kept to ease the transition
71			C from the old default to the new one (see seaice_check.F).
72			#define MCPHEE_OCEAN_ICE_HEAT_FLUX
73			#define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR
74
75	jmc	1.9	C-- By default sea ice is fresh. Set following flag for salty ice.
76	ifenty	1.11	#define SEAICE_VARIABLE_SALINITY
77	jmc	1.9
78	jmc	1.14	C-- Tracers of ice and/or ice cover.
79			#undef ALLOW_SITRACER
80			#ifdef ALLOW_SITRACER
81			C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff.
82			# define ALLOW_SITRACER_ADVCAP
83			#endif
84
85	jmc	1.4	C-- By default the seaice model is discretized on a B-Grid (for
86	heimbach	1.1	C historical reasons). Define the following flag to use a new
87			C (not thoroughly) test version on a C-grid
88			#define SEAICE_CGRID
89
90	jmc	1.9	C-- Only for the C-grid version it is possible to
91	heimbach	1.1	#ifdef SEAICE_CGRID
92	jmc	1.9	C enable EVP code by defining the following flag
93			# define SEAICE_ALLOW_EVP
94			# ifdef SEAICE_ALLOW_EVP
95			C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit
96			C-- viscosities from below and above in seaice_evp
97			C-- not necessary, and not recommended
98			# undef SEAICE_ALLOW_CLIPZETA
99			# endif /* SEAICE_ALLOW_EVP */
100			C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
101			# undef SEAICE_ALLOW_TEM
102			#else /* not SEAICE_CGRID, but old B-grid */
103			C-- By default for B-grid dynamics solver wind stress under sea-ice is
104			C set to the same value as it would be if there was no sea-ice.
105			C Define following CPP flag for B-grid ice-ocean stress coupling.
106			# define SEAICE_BICE_STRESS
107
108			C-- By default for B-grid dynamics solver surface tilt is obtained
109			C indirectly via geostrophic velocities. Define following CPP
110			C in order to use ETAN instead.
111			# define EXPLICIT_SSH_SLOPE
112	jmc	1.14	C-- Defining this flag turns on a FV-discretization of the B-grid LSOR
113			C solver. It is smoother and includes all metric terms, similar to the
114			C C-grid solver. It is here for completeness, but its usefulness is
115			C unclear.
116			# undef SEAICE_LSRBNEW
117	heimbach	1.1	#endif /* SEAICE_CGRID */
118
119	jmc	1.9	C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth
120			#undef SEAICE_CAP_HEFF
121			C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
122			#undef SEAICE_CAP_ICELOAD
123			C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
124			C-- not recommended
125			#undef SEAICE_ALLOW_CLIPVELS
126	heimbach	1.3
127	gforget	1.8	C enable free drift code
128	heimbach	1.13	#define SEAICE_ALLOW_FREEDRIFT
129	gforget	1.8
130	jmc	1.14	#endif /* ALLOW_SEAICE */
131	heimbach	1.1	#endif /* SEAICE_OPTIONS_H */
132
133			CEH3 ;;; Local Variables: ***
134			CEH3 ;;; mode:fortran ***
135			CEH3 ;;; End: ***