lab_sea/code/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/verification/lab_sea/code/SEAICE_OPTIONS.h,v 1.28 2012/03/11 19:05:09 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--   The actual number of ice categories used to solve for seaice flux is
C     now a run-time parameter (SEAICE_multDim).
C     This CPP-flag has been removed from main code and is just used to set
C     default number of category, i.e., =1 if undef, or =MULTDIM (=7 in
C     default SEAICE_SIZE.h) if defined. To be completely removed soon.
C     Note: be aware of pickup_seaice.* compatibility issues when restarting
C     a simulation with a different number of categories.
#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 confirmed)
#undef SEAICE_DISABLE_HEATCONSFIX

C--   The functionality of this flag has been moved to SItracer making
C     this flag obsolete.
#undef 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 viscosities
C     from below and above in seaice_evp: 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 according
C     to the available amount of ice+snow. Otherwise this term is treated
C     like all of the others -- residuals heat and fw stocks are passed to
C     the ocean at the end of seaice_growth in a conservative manner.
C     SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
#undef SEAICE_CAP_SUBLIM

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	jmc	1.29	C $Header: /u/gcmpack/MITgcm/verification/lab_sea/code/SEAICE_OPTIONS.h,v 1.28 2012/03/11 19:05:09 jmc Exp $
2	dimitri	1.8	C $Name: $
3	dimitri	1.2
4	jmc	1.17	C ==========================================================
5	jmc	1.20	C \| SEAICE_OPTIONS.h
6			C \| o CPP options file for sea ice package.
7	jmc	1.17	C ==========================================================
8	jmc	1.20	C \| Use this file for selecting options within the sea ice
9			C \| package.
10	jmc	1.17	C ==========================================================
11	dimitri	1.2
12	edhill	1.4	#ifndef SEAICE_OPTIONS_H
13			#define SEAICE_OPTIONS_H
14			#include "PACKAGES_CONFIG.h"
15	dimitri	1.2	#include "CPP_OPTIONS.h"
16
17	jmc	1.20	#ifdef ALLOW_SEAICE
18			C Package-specific Options & Macros go here
19
20	dimitri	1.2	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	dimitri	1.9	#define SEAICE_EXTERNAL_FLUXES
36	dimitri	1.2
37	jmc	1.28	C-- The actual number of ice categories used to solve for seaice flux is
38	jmc	1.29	C now a run-time parameter (SEAICE_multDim).
39	jmc	1.28	C This CPP-flag has been removed from main code and is just used to set
40	jmc	1.29	C default number of category, i.e., =1 if undef, or =MULTDIM (=7 in
41	jmc	1.28	C default SEAICE_SIZE.h) if defined. To be completely removed soon.
42			C Note: be aware of pickup_seaice.* compatibility issues when restarting
43			C a simulation with a different number of categories.
44			#define SEAICE_MULTICATEGORY
45	dimitri	1.8
46	jmc	1.17	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.28	#undef SEAICE_GROWTH_LEGACY
49	jmc	1.17
50	gforget	1.24	C-- Since the missing sublimation term is now included
51			C this flag is needed for backward compatibility
52	jmc	1.28	#undef SEAICE_DISABLE_SUBLIM
53	gforget	1.24
54	jmc	1.28	C-- Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
55			#undef SEAICE_DISABLE_HEATCONSFIX
56	gforget	1.25
57	jmc	1.28	C-- The functionality of this flag has been moved to SItracer making
58			C this flag obsolete.
59			#undef SEAICE_VARIABLE_SALINITY
60	dimitri	1.8
61	jmc	1.20	C-- Tracers of ice and/or ice cover.
62	gforget	1.21	#define ALLOW_SITRACER
63	jmc	1.20	#ifdef ALLOW_SITRACER
64			C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff.
65			# define ALLOW_SITRACER_ADVCAP
66			#endif
67
68	jmc	1.17	C-- By default the seaice model is discretized on a B-Grid (for
69	dimitri	1.8	C historical reasons). Define the following flag to use a new
70			C (not thoroughly) test version on a C-grid
71			#define SEAICE_CGRID
72
73	jmc	1.17	C-- Only for the C-grid version it is possible to
74	dimitri	1.8	#ifdef SEAICE_CGRID
75	dimitri	1.11	C enable EVP code by defining the following flag
76	dimitri	1.14	# define SEAICE_ALLOW_EVP
77			# ifdef SEAICE_ALLOW_EVP
78	jmc	1.28	C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
79			C from below and above in seaice_evp: not necessary, and not recommended
80			# undef SEAICE_ALLOW_CLIPZETA
81	dimitri	1.14	# endif /* SEAICE_ALLOW_EVP */
82	dimitri	1.11	C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
83	dimitri	1.14	# undef SEAICE_ALLOW_TEM
84			#else /* not SEAICE_CGRID, but old B-grid */
85			C-- By default for B-grid dynamics solver wind stress under sea-ice is
86			C set to the same value as it would be if there was no sea-ice.
87			C Define following CPP flag for B-grid ice-ocean stress coupling.
88			# define SEAICE_BICE_STRESS
89
90			C-- By default for B-grid dynamics solver surface tilt is obtained
91			C indirectly via geostrophic velocities. Define following CPP
92			C in order to use ETAN instead.
93			# define EXPLICIT_SSH_SLOPE
94	jmc	1.20	C-- Defining this flag turns on a FV-discretization of the B-grid LSOR
95			C solver. It is smoother and includes all metric terms, similar to the
96			C C-grid solver. It is here for completeness, but its usefulness is
97			C unclear.
98			# undef SEAICE_LSRBNEW
99	dimitri	1.8	#endif /* SEAICE_CGRID */
100
101	jmc	1.28	C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth;
102			C currently only relevant for SEAICE_GROWTH_LEGACY
103	dimitri	1.8	#undef SEAICE_CAP_HEFF
104	jmc	1.17	C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
105			#undef SEAICE_CAP_ICELOAD
106	mlosch	1.12	C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
107	gforget	1.16	C-- not recommended
108	jmc	1.28	#undef SEAICE_ALLOW_CLIPVELS
109			C-- When set cap the sublimation latent heat flux in solve4temp according
110			C to the available amount of ice+snow. Otherwise this term is treated
111			C like all of the others -- residuals heat and fw stocks are passed to
112			C the ocean at the end of seaice_growth in a conservative manner.
113			C SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
114			#undef SEAICE_CAP_SUBLIM
115	edhill	1.4
116	jmc	1.28	C-- enable free drift code
117	gforget	1.15	#define SEAICE_ALLOW_FREEDRIFT
118
119	jmc	1.20	#endif /* ALLOW_SEAICE */
120	edhill	1.4	#endif /* SEAICE_OPTIONS_H */
121	dimitri	1.8
122			CEH3 ;;; Local Variables: ***
123			CEH3 ;;; mode:fortran ***
124			CEH3 ;;; End: ***