global_oce_llc90/code/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm_contrib/gael/verification/global_oce_llc90/code/SEAICE_OPTIONS.h,v 1.1 2012/10/03 20:27:37 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--   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 will be completely removed soon (no longer in main code);
C     it is just used to set default number of categories, i.e., =1 if undef,
C     or =MULTDIM if defined (MULTDIM=7 in default SEAICE_SIZE.h).
C     Note: be aware of pickup_seaice.* compatibility issues when restarting
C     a simulation with a different number of categories.
c#define SEAICE_MULTICATEGORY

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 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 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
#define 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

C--   enforce cfl condition without cuting sensitivity flow
c#define ALLOW_CFL_FIX

C--   cut the adjoint dependency to hactual, etc.
c# undef SEAICE_SIMPLIFY_GROWTH_ADJ

C--   go through heff and open ocean
c#define SEAICE_MODIFY_GROWTH_ADJ

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

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