darwin_baltic_76x72x24/code/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm_contrib/darwin/verification/darwin_baltic_76x72x24/code/SEAICE_OPTIONS.h,v 1.10 2012/02/11 15:53:41 jahn 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"

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--   options only available in the merged version (from Ian Fenty s code)
#ifndef SEAICE_GROWTH_LEGACY
C-    to switch on/off open-water freezing contribution to thickness tendency:
#define SEAICE_DO_OPEN_WATER_GROWTH
C-    to switch on/off ocean heat contribution to seaice cover reduction:
#define SEAICE_OCN_MELT_ACT_ON_AREA
#endif

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

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.
#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
# undef 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
#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--   When set cap the sublimation latent heat flux in solve4temp
C     according to the available amount of ice+snow. Otherwise this
C     term is treated like all of the others -- residuals heat and
C     fw stocks are passed to the ocean at the end of seaice_growth
C     in a conservative manner. SEAICE_CAP_SUBLIM is not needed
C     as of now, but kept just in case.
#undef SEAICE_CAP_SUBLIM

C     enable free drift code
#undef SEAICE_ALLOW_FREEDRIFT

#endif /* SEAICE_OPTIONS_H */

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	jahn	1.11	C $Header: /u/gcmpack/MITgcm_contrib/darwin/verification/darwin_baltic_76x72x24/code/SEAICE_OPTIONS.h,v 1.10 2012/02/11 15:53:41 jahn Exp $
2	jahn	1.3	C $Name: $
3	jahn	1.1
4	jahn	1.7	C ==========================================================
5	jahn	1.1	C \| SEAICE_OPTIONS.h \|
6			C \| o CPP options file for sea ice package. \|
7	jahn	1.7	C ==========================================================
8	jahn	1.1	C \| Use this file for selecting options within the sea ice \|
9			C \| package. \|
10	jahn	1.7	C ==========================================================
11	jahn	1.1
12			#ifndef SEAICE_OPTIONS_H
13			#define SEAICE_OPTIONS_H
14			#include "PACKAGES_CONFIG.h"
15			#include "CPP_OPTIONS.h"
16
17			C-- Write "text-plots" of certain fields in STDOUT for debugging.
18			#undef SEAICE_DEBUG
19
20			C-- Allow sea-ice dynamic code.
21			C This option is provided to allow use of TAMC
22			C on the thermodynamics component of the code only.
23			C Sea-ice dynamics can also be turned off at runtime
24			C using variable SEAICEuseDYNAMICS.
25			#define SEAICE_ALLOW_DYNAMICS
26
27			C-- By default, the sea-ice package uses its own integrated bulk
28			C formulae to compute fluxes (fu, fv, EmPmR, Qnet, and Qsw) over
29			C open-ocean. When this flag is set, these variables are computed
30			C in a separate external package, for example, pkg/exf, and then
31			C modified for sea-ice effects by pkg/seaice.
32	jahn	1.4	#define SEAICE_EXTERNAL_FLUXES
33	jahn	1.1
34			C-- By default, the sea-ice package uses 2-category thermodynamics.
35			C When this flag is set, an 8-category calculation of ice
36			C thermodynamics is carried out in groatb.F
37			C Note the pickup_seaice.* generated by this option differ
38			C from those generated with the default 2-category model.
39			C Therefore it is not possible to switch between the two
40			C in the middle of an integration.
41			#define SEAICE_MULTICATEGORY
42
43	jahn	1.7	C-- Use the Old version of seaice_growth (close to cvs version 1.70)
44			C otherwise, use the merged version (with some of Ian Fenty s code)
45			#define SEAICE_GROWTH_LEGACY
46
47	jahn	1.10	C-- Since the missing sublimation term is now included
48			C this flag is needed for backward compatibility
49			#define SEAICE_DISABLE_SUBLIM
50
51	jahn	1.7	C-- options only available in the merged version (from Ian Fenty s code)
52			#ifndef SEAICE_GROWTH_LEGACY
53			C- to switch on/off open-water freezing contribution to thickness tendency:
54			#define SEAICE_DO_OPEN_WATER_GROWTH
55			C- to switch on/off ocean heat contribution to seaice cover reduction:
56			#define SEAICE_OCN_MELT_ACT_ON_AREA
57			#endif
58
59			C-- Use the Old version of seaice_solve4temp (formerly seaice_budget_ice)
60			C otherwise, use Ian Fenty s version
61			#define SEAICE_SOLVE4TEMP_LEGACY
62	jahn	1.1
63	jahn	1.10	C-- The freezing point of water is a simple linear dependence to salinity.
64			C The flag below is now obsolete, but kept to ease the transition
65			C from the old constant freezing point default (see seaice_check.F).
66	jahn	1.1	#define SEAICE_VARIABLE_FREEZING_POINT
67
68	jahn	1.11	C-- The flags below are obsolete, but kept to ease the transition
69			C from the old default to the new one (see seaice_check.F).
70			#define MCPHEE_OCEAN_ICE_HEAT_FLUX
71			#define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR
72
73	jahn	1.4	C-- By default sea ice is fresh. Set following flag for salty ice.
74	jahn	1.8	#undef SEAICE_VARIABLE_SALINITY
75	jahn	1.4
76	jahn	1.9	C-- Tracers of ice and/or ice cover.
77			#undef ALLOW_SITRACER
78			#ifdef ALLOW_SITRACER
79			C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff.
80			# define ALLOW_SITRACER_ADVCAP
81	jahn	1.7	#endif
82
83			C-- By default the seaice model is discretized on a B-Grid (for
84	jahn	1.1	C historical reasons). Define the following flag to use a new
85			C (not thoroughly) test version on a C-grid
86			#define SEAICE_CGRID
87
88	jahn	1.7	C-- Only for the C-grid version it is possible to
89	jahn	1.1	#ifdef SEAICE_CGRID
90	jahn	1.2	C enable EVP code by defining the following flag
91	jahn	1.7	# undef SEAICE_ALLOW_EVP
92			# ifdef SEAICE_ALLOW_EVP
93			C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit
94			C-- viscosities from below and above in seaice_evp
95			C-- not necessary, and not recommended
96			# undef SEAICE_ALLOW_CLIPZETA
97			# endif /* SEAICE_ALLOW_EVP */
98	jahn	1.2	C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
99	jahn	1.7	# undef SEAICE_ALLOW_TEM
100			#else /* not SEAICE_CGRID, but old B-grid */
101			C-- By default for B-grid dynamics solver wind stress under sea-ice is
102			C set to the same value as it would be if there was no sea-ice.
103			C Define following CPP flag for B-grid ice-ocean stress coupling.
104			# define SEAICE_BICE_STRESS
105
106			C-- By default for B-grid dynamics solver surface tilt is obtained
107			C indirectly via geostrophic velocities. Define following CPP
108			C in order to use ETAN instead.
109			# define EXPLICIT_SSH_SLOPE
110	jahn	1.1	#endif /* SEAICE_CGRID */
111
112			C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth
113			#undef SEAICE_CAP_HEFF
114	jahn	1.7	C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
115			#undef SEAICE_CAP_ICELOAD
116	jahn	1.6	C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
117			C-- not recommended
118			#undef SEAICE_ALLOW_CLIPVELS
119	jahn	1.1
120	jahn	1.10	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	jahn	1.7	C enable free drift code
129			#undef SEAICE_ALLOW_FREEDRIFT
130	jahn	1.5
131	jahn	1.1	#endif /* SEAICE_OPTIONS_H */
132
133			CEH3 ;;; Local Variables: ***
134			CEH3 ;;; mode:fortran ***
135			CEH3 ;;; End: ***