beaufort/code/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm_contrib/MPMice/beaufort/code/SEAICE_OPTIONS.h,v 1.4 2012/03/14 05:32:10 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--   This CPP flag has been retired.  The number of ice categories
C     used to solve for seaice flux is now specified by run-time
C     parameter SEAICE_multDim.
C     Note: be aware of pickup_seaice.* compatibility issues when
C     restarting a simulation with a different number of categories.
c#define SEAICE_MULTICATEGORY

C--   run with sea Ice Thickness Distribution (ITD);
C     set number of categories (nITD) in SEAICE_SIZE.h
#undef SEAICE_ITD

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--   Default is constant seaice salinity (SEAICE_salt0); Define the following
C     flag to consider (space & time) variable salinity: advected and forming
C     seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
C- Note: SItracer also offers an alternative way to handle variable salinity.
#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--   Enable grease ice parameterization
C     The grease ice parameterization delays formation of solid 
C     sea ice from frazil ice by a time constant and provides a 
C     dynamic calculation of the initial solid sea ice thickness 
C     HO as a function of winds, currents and available grease ice 
C     volume. Grease ice does not significantly reduce heat loss 
C     from the ocean in winter and area covered by grease is thus 
C     handled like open water.
C     (For details see Smedsrud and Martin, 2014, Ann.Glac.)
C     Set SItrName(1) = 'grease' in namelist SEAICE_PARM03 in data.seaice
C     then output SItr01 is SItrNameLong(1) = 'grease ice volume fraction',
C     with SItrUnit(1) = '[0-1]', which needs to be multiplied by SIheff
C     to yield grease ice volume. Additionally, the actual grease ice
C     layer thickness (diagnostic SIgrsLT) can be saved.
#undef SEAICE_GREASE
C--   grease ice uses SItracer:
#ifdef SEAICE_GREASE
# define ALLOW_SITRACER
# 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 JFNK code by defining the following flag
# define SEAICE_ALLOW_JFNK
C     enable LSR to use global (multi-tile) tri-diagonal solver
# undef SEAICE_GLOBAL_3DIAG_SOLVER
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 viscosities
C     from below and above in seaice_evp: not necessary, and not recommended
#  undef SEAICE_ALLOW_CLIPZETA
# endif /* SEAICE_ALLOW_EVP */
C     regularize zeta to zmax with a smooth tanh-function instead
C     of a min(zeta,zmax). This improves convergence of iterative
C     solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
# undef SEAICE_ZETA_SMOOTHREG
C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
# undef SEAICE_ALLOW_TEM
C     Use LSR vector code; not useful on non-vector machines, because it
C     slows down convergence considerably, but the extra iterations are
C     more than made up by the much faster code on vector machines. For
C     the only regularly test vector machine these flags a specified
C     in the build options file SUPER-UX_SX-8_sxf90_awi, so that we comment
C     them out here.
C# define SEAICE_VECTORIZE_LSR
C# ifdef SEAICE_VECTORIZE_LSR
C     Use modified LSR vector code that splits vector loop into two with
C     step size 2. This modification improves the convergence of the vector
C     code dramatically, so that is may actually be useful in general, but
C     that needs to be tested.
C#  define SEAICE_VECTORIZE_LSR_ZEBRA
C# endif
#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 FV-discretization of the B-grid LSOR solver.
C     It is smoother and includes all metric terms, similar to C-grid solvers.
C     It is here for completeness, but its usefulness is unclear.
# undef SEAICE_LSRBNEW
#endif /* SEAICE_CGRID */

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
#undef SEAICE_ALLOW_FREEDRIFT

C--   pkg/seaice cost functions compile flags
c       >>> Sea-ice volume (requires pkg/cost)
#undef ALLOW_COST_ICE
c       >>> Sea-ice misfit to obs (requires pkg/cost and ecco)
#undef ALLOW_SEAICE_COST_SMR_AREA

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

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	dimitri	1.5	C $Header: /u/gcmpack/MITgcm_contrib/MPMice/beaufort/code/SEAICE_OPTIONS.h,v 1.4 2012/03/14 05:32:10 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	dimitri	1.5	C-- This CPP flag has been retired. The number of ice categories
37			C used to solve for seaice flux is now specified by run-time
38			C parameter SEAICE_multDim.
39			C Note: be aware of pickup_seaice.* compatibility issues when
40			C restarting a simulation with a different number of categories.
41			c#define SEAICE_MULTICATEGORY
42
43			C-- run with sea Ice Thickness Distribution (ITD);
44			C set number of categories (nITD) in SEAICE_SIZE.h
45			#undef SEAICE_ITD
46	dimitri	1.3
47	dimitri	1.4	C-- Since the missing sublimation term is now included
48			C this flag is needed for backward compatibility
49			#undef SEAICE_DISABLE_SUBLIM
50
51	dimitri	1.5	C-- Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
52	dimitri	1.4	#undef SEAICE_DISABLE_HEATCONSFIX
53
54	dimitri	1.5	C-- Default is constant seaice salinity (SEAICE_salt0); Define the following
55			C flag to consider (space & time) variable salinity: advected and forming
56			C seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
57			C- Note: SItracer also offers an alternative way to handle variable salinity.
58	dimitri	1.2	#define SEAICE_VARIABLE_SALINITY
59	dimitri	1.1
60	dimitri	1.3	C-- Tracers of ice and/or ice cover.
61	dimitri	1.5	#undef ALLOW_SITRACER
62	dimitri	1.3	#ifdef ALLOW_SITRACER
63			C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff.
64			# define ALLOW_SITRACER_ADVCAP
65			#endif
66
67	dimitri	1.5	C-- Enable grease ice parameterization
68			C The grease ice parameterization delays formation of solid
69			C sea ice from frazil ice by a time constant and provides a
70			C dynamic calculation of the initial solid sea ice thickness
71			C HO as a function of winds, currents and available grease ice
72			C volume. Grease ice does not significantly reduce heat loss
73			C from the ocean in winter and area covered by grease is thus
74			C handled like open water.
75			C (For details see Smedsrud and Martin, 2014, Ann.Glac.)
76			C Set SItrName(1) = 'grease' in namelist SEAICE_PARM03 in data.seaice
77			C then output SItr01 is SItrNameLong(1) = 'grease ice volume fraction',
78			C with SItrUnit(1) = '[0-1]', which needs to be multiplied by SIheff
79			C to yield grease ice volume. Additionally, the actual grease ice
80			C layer thickness (diagnostic SIgrsLT) can be saved.
81			#undef SEAICE_GREASE
82			C-- grease ice uses SItracer:
83			#ifdef SEAICE_GREASE
84			# define ALLOW_SITRACER
85			# define ALLOW_SITRACER_ADVCAP
86			#endif
87
88	dimitri	1.3	C-- By default the seaice model is discretized on a B-Grid (for
89	dimitri	1.1	C historical reasons). Define the following flag to use a new
90			C (not thoroughly) test version on a C-grid
91			#define SEAICE_CGRID
92
93	dimitri	1.3	C-- Only for the C-grid version it is possible to
94	dimitri	1.1	#ifdef SEAICE_CGRID
95	dimitri	1.5	C enable JFNK code by defining the following flag
96			# define SEAICE_ALLOW_JFNK
97			C enable LSR to use global (multi-tile) tri-diagonal solver
98			# undef SEAICE_GLOBAL_3DIAG_SOLVER
99	dimitri	1.3	C enable EVP code by defining the following flag
100	dimitri	1.5	# undef SEAICE_ALLOW_EVP
101	dimitri	1.3	# ifdef SEAICE_ALLOW_EVP
102	dimitri	1.5	C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
103			C from below and above in seaice_evp: not necessary, and not recommended
104	dimitri	1.3	# undef SEAICE_ALLOW_CLIPZETA
105			# endif /* SEAICE_ALLOW_EVP */
106	dimitri	1.5	C regularize zeta to zmax with a smooth tanh-function instead
107			C of a min(zeta,zmax). This improves convergence of iterative
108			C solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
109			# undef SEAICE_ZETA_SMOOTHREG
110	dimitri	1.3	C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
111			# undef SEAICE_ALLOW_TEM
112	dimitri	1.5	C Use LSR vector code; not useful on non-vector machines, because it
113			C slows down convergence considerably, but the extra iterations are
114			C more than made up by the much faster code on vector machines. For
115			C the only regularly test vector machine these flags a specified
116			C in the build options file SUPER-UX_SX-8_sxf90_awi, so that we comment
117			C them out here.
118			C# define SEAICE_VECTORIZE_LSR
119			C# ifdef SEAICE_VECTORIZE_LSR
120			C Use modified LSR vector code that splits vector loop into two with
121			C step size 2. This modification improves the convergence of the vector
122			C code dramatically, so that is may actually be useful in general, but
123			C that needs to be tested.
124			C# define SEAICE_VECTORIZE_LSR_ZEBRA
125			C# endif
126	dimitri	1.3	#else /* not SEAICE_CGRID, but old B-grid */
127			C-- By default for B-grid dynamics solver wind stress under sea-ice is
128			C set to the same value as it would be if there was no sea-ice.
129			C Define following CPP flag for B-grid ice-ocean stress coupling.
130			# define SEAICE_BICE_STRESS
131
132			C-- By default for B-grid dynamics solver surface tilt is obtained
133			C indirectly via geostrophic velocities. Define following CPP
134			C in order to use ETAN instead.
135			# define EXPLICIT_SSH_SLOPE
136	dimitri	1.5	C-- Defining this flag turns on FV-discretization of the B-grid LSOR solver.
137			C It is smoother and includes all metric terms, similar to C-grid solvers.
138			C It is here for completeness, but its usefulness is unclear.
139	dimitri	1.3	# undef SEAICE_LSRBNEW
140	dimitri	1.1	#endif /* SEAICE_CGRID */
141
142	dimitri	1.3	C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
143			#undef SEAICE_CAP_ICELOAD
144			C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
145	dimitri	1.5	C not recommended
146	dimitri	1.3	#undef SEAICE_ALLOW_CLIPVELS
147	dimitri	1.5	C-- When set cap the sublimation latent heat flux in solve4temp according
148			C to the available amount of ice+snow. Otherwise this term is treated
149			C like all of the others -- residuals heat and fw stocks are passed to
150			C the ocean at the end of seaice_growth in a conservative manner.
151			C SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
152	dimitri	1.4	#undef SEAICE_CAP_SUBLIM
153	dimitri	1.3
154	dimitri	1.5	C-- Enable free drift code
155	dimitri	1.3	#undef SEAICE_ALLOW_FREEDRIFT
156	dimitri	1.1
157	dimitri	1.5	C-- pkg/seaice cost functions compile flags
158			c >>> Sea-ice volume (requires pkg/cost)
159			#undef ALLOW_COST_ICE
160			c >>> Sea-ice misfit to obs (requires pkg/cost and ecco)
161			#undef ALLOW_SEAICE_COST_SMR_AREA
162
163	dimitri	1.3	#endif /* ALLOW_SEAICE */
164	dimitri	1.1	#endif /* SEAICE_OPTIONS_H */
165
166			CEH3 ;;; Local Variables: ***
167			CEH3 ;;; mode:fortran ***
168			CEH3 ;;; End: ***