pkg/seaice/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.55 2011/12/24 01:09:40 jmc 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.
#undef 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--   options only available in the merged version (from Ian Fenty s code)
#ifndef SEAICE_GROWTH_LEGACY
C-    to ensure heat conservation in the coupled ocean-seaice system
# undef SEAICE_HEAT_CONSERV_FIX
C-    to switch on/off open-water freezing contribution to thickness tendency:
# define SEAICE_DO_OPEN_WATER_GROWTH
C-    ifdef SEAICE_DO_OPEN_WATER_GROWTH then define SEAICE_DO_OPEN_WATER_MELT
C     to also allow open-water air-sea heat fluxes melt ice
# undef SEAICE_DO_OPEN_WATER_MELT
C-    to switch on/off ocean heat contribution to seaice cover reduction:
# define SEAICE_OCN_MELT_ACT_ON_AREA
C-    to preclude infinitesimal ice concentrations:
# undef ALLOW_PRECLUDE_INFINITESIMAL_AREA
#endif

C-    to use the MCPhee formula in computing ocean/ice fluxes
#undef MCPHEE_OCEAN_ICE_HEAT_FLUX

C--   Use the Old version of seaice_solve4temp (formerly seaice_budget_ice)
C     otherwise, use Ian Fenty s version
#define SEAICE_SOLVE4TEMP_LEGACY

C--   By default the freezing point of water is set to the value of
C     the parameter SEAICE_freeze (=-1.96 by default). To use a
C     simple linear dependence of the freezing point on salinity,
C     set the following flag (pressure is assumed to have no effect,
C     which is a good assumption for the top 20 meters). With this
C     option defined the parameter SEAICE_freeze has no effect.
#undef SEAICE_VARIABLE_FREEZING_POINT

C--   Allow SEAICEuseFlooding, which converts snow to ice if submerged.
#define ALLOW_SEAICE_FLOODING

C--   By default sea ice is fresh.  Set following flag for salty ice.
#undef 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
#undef SEAICE_ALLOW_FREEDRIFT

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

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	gforget	1.56	C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.55 2011/12/24 01:09:40 jmc Exp $
2	jmc	1.17	C $Name: $
3	heimbach	1.2
4	jmc	1.41	C ==========================================================
5	jmc	1.55	C \| SEAICE_OPTIONS.h
6			C \| o CPP options file for sea ice package.
7	jmc	1.41	C ==========================================================
8	jmc	1.55	C \| Use this file for selecting options within the sea ice
9			C \| package.
10	jmc	1.41	C ==========================================================
11	heimbach	1.2
12	edhill	1.7	#ifndef SEAICE_OPTIONS_H
13			#define SEAICE_OPTIONS_H
14			#include "PACKAGES_CONFIG.h"
15	heimbach	1.2	#include "CPP_OPTIONS.h"
16	jmc	1.55
17	jmc	1.52	#ifdef ALLOW_SEAICE
18	jmc	1.55	C Package-specific Options & Macros go here
19	heimbach	1.2
20	dimitri	1.3	C-- Write "text-plots" of certain fields in STDOUT for debugging.
21	heimbach	1.2	#undef SEAICE_DEBUG
22
23	dimitri	1.3	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	heimbach	1.2	#define SEAICE_ALLOW_DYNAMICS
29	dimitri	1.3
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.28	#define SEAICE_EXTERNAL_FLUXES
36	heimbach	1.2
37	dimitri	1.5	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.10	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	mlosch	1.18	#undef SEAICE_MULTICATEGORY
45	dimitri	1.5
46	jmc	1.41	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	jmc	1.42	#define SEAICE_GROWTH_LEGACY
49	jmc	1.41
50			C-- options only available in the merged version (from Ian Fenty s code)
51			#ifndef SEAICE_GROWTH_LEGACY
52	gforget	1.53	C- to ensure heat conservation in the coupled ocean-seaice system
53	jmc	1.55	# undef SEAICE_HEAT_CONSERV_FIX
54	jmc	1.41	C- to switch on/off open-water freezing contribution to thickness tendency:
55	gforget	1.50	# define SEAICE_DO_OPEN_WATER_GROWTH
56	gforget	1.44	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	gforget	1.50	# undef SEAICE_DO_OPEN_WATER_MELT
59	jmc	1.47	C- to switch on/off ocean heat contribution to seaice cover reduction:
60	gforget	1.50	# define SEAICE_OCN_MELT_ACT_ON_AREA
61			C- to preclude infinitesimal ice concentrations:
62			# undef ALLOW_PRECLUDE_INFINITESIMAL_AREA
63	jmc	1.41	#endif
64
65	gforget	1.43	C- to use the MCPhee formula in computing ocean/ice fluxes
66			#undef MCPHEE_OCEAN_ICE_HEAT_FLUX
67
68	jmc	1.41	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	mlosch	1.13	C the parameter SEAICE_freeze (=-1.96 by default). To use a
74	jmc	1.41	C simple linear dependence of the freezing point on salinity,
75	mlosch	1.13	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			#undef SEAICE_VARIABLE_FREEZING_POINT
79
80	dimitri	1.19	C-- Allow SEAICEuseFlooding, which converts snow to ice if submerged.
81	mlosch	1.33	#define ALLOW_SEAICE_FLOODING
82	dimitri	1.19
83	dimitri	1.27	C-- By default sea ice is fresh. Set following flag for salty ice.
84	ifenty	1.49	#undef SEAICE_VARIABLE_SALINITY
85	dimitri	1.27
86	gforget	1.51	C-- Tracers of ice and/or ice cover.
87			#undef ALLOW_SITRACER
88			#ifdef ALLOW_SITRACER
89			C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff.
90			# define ALLOW_SITRACER_ADVCAP
91			#endif
92
93	jmc	1.41	C-- By default the seaice model is discretized on a B-Grid (for
94	mlosch	1.14	C historical reasons). Define the following flag to use a new
95			C (not thoroughly) test version on a C-grid
96	jmc	1.17	#define SEAICE_CGRID
97	mlosch	1.14
98	jmc	1.41	C-- Only for the C-grid version it is possible to
99	mlosch	1.15	#ifdef SEAICE_CGRID
100	mlosch	1.31	C enable EVP code by defining the following flag
101	dimitri	1.38	# define SEAICE_ALLOW_EVP
102			# ifdef SEAICE_ALLOW_EVP
103	mlosch	1.37	C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit
104			C-- viscosities from below and above in seaice_evp
105			C-- not necessary, and not recommended
106	dimitri	1.38	# undef SEAICE_ALLOW_CLIPZETA
107			# endif /* SEAICE_ALLOW_EVP */
108	mlosch	1.31	C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
109	dimitri	1.38	# undef SEAICE_ALLOW_TEM
110	mlosch	1.33	#else /* not SEAICE_CGRID, but old B-grid */
111			C-- By default for B-grid dynamics solver wind stress under sea-ice is
112			C set to the same value as it would be if there was no sea-ice.
113			C Define following CPP flag for B-grid ice-ocean stress coupling.
114	dimitri	1.38	# define SEAICE_BICE_STRESS
115	mlosch	1.33
116			C-- By default for B-grid dynamics solver surface tilt is obtained
117			C indirectly via geostrophic velocities. Define following CPP
118			C in order to use ETAN instead.
119	dimitri	1.38	# define EXPLICIT_SSH_SLOPE
120	jmc	1.55	C-- Defining this flag turns on a FV-discretization of the B-grid LSOR
121	mlosch	1.54	C solver. It is smoother and includes all metric terms, similar to the
122			C C-grid solver. It is here for completeness, but its usefulness is
123			C unclear.
124			# undef SEAICE_LSRBNEW
125	jmc	1.16	#endif /* SEAICE_CGRID */
126	mlosch	1.15
127	dimitri	1.24	C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth
128			#undef SEAICE_CAP_HEFF
129	jmc	1.41	C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
130			#undef SEAICE_CAP_ICELOAD
131	mlosch	1.36	C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
132			C-- not recommended
133			#undef SEAICE_ALLOW_CLIPVELS
134	dimitri	1.24
135	gforget	1.40	C enable free drift code
136			#undef SEAICE_ALLOW_FREEDRIFT
137
138	jmc	1.52	#endif /* ALLOW_SEAICE */
139	edhill	1.7	#endif /* SEAICE_OPTIONS_H */
140	edhill	1.12
141			CEH3 ;;; Local Variables: ***
142			CEH3 ;;; mode:fortran ***
143			CEH3 ;;; End: ***