pkg/seaice/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.72 2012/12/27 23:05:47 gforget 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--   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.
#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 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
# 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     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

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

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	mlosch	1.73	C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.72 2012/12/27 23:05:47 gforget 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.71	C-- This CPP flag has been retired. The number of ice categories
38			C used to solve for seaice flux is now specified by run-time
39			C parameter SEAICE_multDim.
40			C Note: be aware of pickup_seaice.* compatibility issues when
41			C restarting a simulation with a different number of categories.
42	jmc	1.64	c#define SEAICE_MULTICATEGORY
43	dimitri	1.5
44	jmc	1.68	C-- run with sea Ice Thickness Distribution (ITD);
45			C set number of categories (nITD) in SEAICE_SIZE.h
46			#undef SEAICE_ITD
47
48	gforget	1.60	C-- Since the missing sublimation term is now included
49			C this flag is needed for backward compatibility
50			#undef SEAICE_DISABLE_SUBLIM
51
52	jmc	1.64	C-- Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
53			#undef SEAICE_DISABLE_HEATCONSFIX
54	gforget	1.61
55	jmc	1.64	C-- Default is constant seaice salinity (SEAICE_salt0); Define the following
56			C flag to consider (space & time) variable salinity: advected and forming
57			C seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
58			C- Note: SItracer also offers an alternative way to handle variable salinity.
59	ifenty	1.49	#undef SEAICE_VARIABLE_SALINITY
60	dimitri	1.27
61	gforget	1.51	C-- Tracers of ice and/or ice cover.
62			#undef ALLOW_SITRACER
63			#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.41	C-- By default the seaice model is discretized on a B-Grid (for
69	mlosch	1.14	C historical reasons). Define the following flag to use a new
70			C (not thoroughly) test version on a C-grid
71	jmc	1.17	#define SEAICE_CGRID
72	mlosch	1.14
73	jmc	1.41	C-- Only for the C-grid version it is possible to
74	mlosch	1.15	#ifdef SEAICE_CGRID
75	mlosch	1.65	C enable JFNK code by defining the following flag
76			# define SEAICE_ALLOW_JFNK
77	jmc	1.69	C enable LSR to use global (multi-tile) tri-diagonal solver
78			# undef SEAICE_GLOBAL_3DIAG_SOLVER
79	mlosch	1.31	C enable EVP code by defining the following flag
80	dimitri	1.38	# define SEAICE_ALLOW_EVP
81			# ifdef SEAICE_ALLOW_EVP
82	jmc	1.64	C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
83			C from below and above in seaice_evp: not necessary, and not recommended
84	dimitri	1.38	# undef SEAICE_ALLOW_CLIPZETA
85	mlosch	1.67	# endif /* SEAICE_ALLOW_EVP */
86	jmc	1.68	C regularize zeta to zmax with a smooth tanh-function instead
87	mlosch	1.65	C of a min(zeta,zmax). This improves convergence of iterative
88			C solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
89	mlosch	1.67	# undef SEAICE_ZETA_SMOOTHREG
90	mlosch	1.31	C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
91	dimitri	1.38	# undef SEAICE_ALLOW_TEM
92	mlosch	1.73	C Use LSR vector code; not useful on non-vector machines, because it
93			C slows down convergence considerably, but the extra iterations are
94			C more than made up by the much faster code on vector machines. For
95			C the only regularly test vector machine these flags a specified
96			C in the build options file SUPER-UX_SX-8_sxf90_awi, so that we comment
97			C them out here.
98			C# define SEAICE_VECTORIZE_LSR
99			C# ifdef SEAICE_VECTORIZE_LSR
100			C Use modified LSR vector code that splits vector loop into two with
101			C step size 2. This modification improves the convergence of the vector
102			C code dramatically, so that is may actually be useful in general, but
103			C that needs to be tested.
104			C# define SEAICE_VECTORIZE_LSR_ZEBRA
105			C# endif
106	mlosch	1.33	#else /* not SEAICE_CGRID, but old B-grid */
107			C-- By default for B-grid dynamics solver wind stress under sea-ice is
108			C set to the same value as it would be if there was no sea-ice.
109			C Define following CPP flag for B-grid ice-ocean stress coupling.
110	dimitri	1.38	# define SEAICE_BICE_STRESS
111	mlosch	1.33
112			C-- By default for B-grid dynamics solver surface tilt is obtained
113			C indirectly via geostrophic velocities. Define following CPP
114			C in order to use ETAN instead.
115	dimitri	1.38	# define EXPLICIT_SSH_SLOPE
116	jmc	1.64	C-- Defining this flag turns on FV-discretization of the B-grid LSOR solver.
117			C It is smoother and includes all metric terms, similar to C-grid solvers.
118			C It is here for completeness, but its usefulness is unclear.
119	mlosch	1.54	# undef SEAICE_LSRBNEW
120	jmc	1.16	#endif /* SEAICE_CGRID */
121	mlosch	1.15
122	jmc	1.41	C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
123			#undef SEAICE_CAP_ICELOAD
124	mlosch	1.36	C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
125	jmc	1.64	C not recommended
126	mlosch	1.36	#undef SEAICE_ALLOW_CLIPVELS
127	jmc	1.64	C-- When set cap the sublimation latent heat flux in solve4temp according
128			C to the available amount of ice+snow. Otherwise this term is treated
129			C like all of the others -- residuals heat and fw stocks are passed to
130			C the ocean at the end of seaice_growth in a conservative manner.
131			C SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
132	gforget	1.60	#undef SEAICE_CAP_SUBLIM
133	dimitri	1.24
134	jmc	1.64	C-- Enable free drift code
135	gforget	1.40	#undef SEAICE_ALLOW_FREEDRIFT
136
137	jmc	1.52	#endif /* ALLOW_SEAICE */
138	edhill	1.7	#endif /* SEAICE_OPTIONS_H */
139	edhill	1.12
140			CEH3 ;;; Local Variables: ***
141			CEH3 ;;; mode:fortran ***
142			CEH3 ;;; End: ***