beaufort/code/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm_contrib/MPMice/beaufort/code/SEAICE_OPTIONS.h,v 1.3 2011/12/21 23:06:07 dimitri Exp $

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)
#undef SEAICE_GROWTH_LEGACY

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

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

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 functionality of this flag has been moved to SItracer making
C     this flag obsolete.
#define SEAICE_VARIABLE_SALINITY

C--   Tracers of ice and/or ice cover.
#define 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
C     currently only relevant for SEAICE_GROWTH_LEGACY
#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 /* ALLOW_SEAICE */
#endif /* SEAICE_OPTIONS_H */

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