lab_sea/code/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.41 2010/10/28 23:11:02 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"

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

C--   options only available in the merged version (from Ian Fenty s code)
#ifndef SEAICE_GROWTH_LEGACY
C-    to switch on/off open-water freezing contribution to thickness tendency:
#define SEAICE_DO_OPEN_WATER_GROWTH
C-    to switch on/off ocean heat contribution to seaice cover reduction:
#define SEAICE_OCN_MELT_ACT_ON_AREA
#endif

C--   Use the Old version of seaice_solve4temp (formerly seaice_budget_ice)
C     otherwise, use Ian Fenty s version
#define SEAICE_SOLVE4TEMP_LEGACY

C--   By default the freezing point of water is set to the value of
C     the parameter SEAICE_freeze (=-1.96 by default). To use a
C     simple linear dependence of the freezing point on salinity,
C     set the following flag (pressure is assumed to have no effect,
C     which is a good assumption for the top 20 meters). With this
C     option defined the parameter SEAICE_freeze has no effect.
#define SEAICE_VARIABLE_FREEZING_POINT

C--   Allow SEAICEuseFlooding, which converts snow to ice if submerged.
#define ALLOW_SEAICE_FLOODING

C--   By default sea ice is fresh.  Set following flag for salty ice.
#define SEAICE_SALINITY

C--   Track sea ice age.
C     By default sea ice age is associated with ice area.
C     Define SEAICE_AGE_VOL to associate age with volume.
#define SEAICE_AGE
#ifdef SEAICE_AGE
# define SEAICE_AGE_VOL
#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
#  define 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
#endif /* SEAICE_CGRID */

C--   When set use MAX_HEFF to cap sea ice thickness in seaice_growth
#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
#define SEAICE_ALLOW_CLIPVELS

C     enable free drift code
#define SEAICE_ALLOW_FREEDRIFT

#endif /* SEAICE_OPTIONS_H */

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	jmc	1.17	C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.41 2010/10/28 23:11:02 jmc Exp $
2	dimitri	1.8	C $Name: $
3	dimitri	1.2
4	jmc	1.17	C ==========================================================
5	dimitri	1.2	C \| SEAICE_OPTIONS.h \|
6			C \| o CPP options file for sea ice package. \|
7	jmc	1.17	C ==========================================================
8	dimitri	1.2	C \| Use this file for selecting options within the sea ice \|
9	dimitri	1.6	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			C-- Write "text-plots" of certain fields in STDOUT for debugging.
18			#undef SEAICE_DEBUG
19
20			C-- Allow sea-ice dynamic code.
21			C This option is provided to allow use of TAMC
22			C on the thermodynamics component of the code only.
23			C Sea-ice dynamics can also be turned off at runtime
24			C using variable SEAICEuseDYNAMICS.
25			#define SEAICE_ALLOW_DYNAMICS
26
27			C-- By default, the sea-ice package uses its own integrated bulk
28			C formulae to compute fluxes (fu, fv, EmPmR, Qnet, and Qsw) over
29			C open-ocean. When this flag is set, these variables are computed
30			C in a separate external package, for example, pkg/exf, and then
31			C modified for sea-ice effects by pkg/seaice.
32	dimitri	1.9	#define SEAICE_EXTERNAL_FLUXES
33	dimitri	1.2
34	dimitri	1.6	C-- By default, the sea-ice package uses 2-category thermodynamics.
35			C When this flag is set, an 8-category calculation of ice
36			C thermodynamics is carried out in groatb.F
37	dimitri	1.8	C Note the pickup_seaice.* generated by this option differ
38			C from those generated with the default 2-category model.
39			C Therefore it is not possible to switch between the two
40			C in the middle of an integration.
41			#undef SEAICE_MULTICATEGORY
42
43	jmc	1.17	C-- Use the Old version of seaice_growth (close to cvs version 1.70)
44			C otherwise, use the merged version (with some of Ian Fenty s code)
45			#define SEAICE_GROWTH_LEGACY
46
47			C-- options only available in the merged version (from Ian Fenty s code)
48			#ifndef SEAICE_GROWTH_LEGACY
49			C- to switch on/off open-water freezing contribution to thickness tendency:
50			#define SEAICE_DO_OPEN_WATER_GROWTH
51			C- to switch on/off ocean heat contribution to seaice cover reduction:
52			#define SEAICE_OCN_MELT_ACT_ON_AREA
53			#endif
54
55			C-- Use the Old version of seaice_solve4temp (formerly seaice_budget_ice)
56			C otherwise, use Ian Fenty s version
57			#define SEAICE_SOLVE4TEMP_LEGACY
58
59			C-- By default the freezing point of water is set to the value of
60	dimitri	1.8	C the parameter SEAICE_freeze (=-1.96 by default). To use a
61	jmc	1.17	C simple linear dependence of the freezing point on salinity,
62	dimitri	1.8	C set the following flag (pressure is assumed to have no effect,
63			C which is a good assumption for the top 20 meters). With this
64			C option defined the parameter SEAICE_freeze has no effect.
65	gforget	1.16	#define SEAICE_VARIABLE_FREEZING_POINT
66	dimitri	1.8
67			C-- Allow SEAICEuseFlooding, which converts snow to ice if submerged.
68	dimitri	1.9	#define ALLOW_SEAICE_FLOODING
69	dimitri	1.8
70			C-- By default sea ice is fresh. Set following flag for salty ice.
71			#define SEAICE_SALINITY
72
73	dimitri	1.11	C-- Track sea ice age.
74	dimitri	1.14	C By default sea ice age is associated with ice area.
75			C Define SEAICE_AGE_VOL to associate age with volume.
76	dimitri	1.11	#define SEAICE_AGE
77	dimitri	1.14	#ifdef SEAICE_AGE
78			# define SEAICE_AGE_VOL
79			#endif
80	dimitri	1.11
81	jmc	1.17	C-- By default the seaice model is discretized on a B-Grid (for
82	dimitri	1.8	C historical reasons). Define the following flag to use a new
83			C (not thoroughly) test version on a C-grid
84			#define SEAICE_CGRID
85
86	jmc	1.17	C-- Only for the C-grid version it is possible to
87	dimitri	1.8	#ifdef SEAICE_CGRID
88	dimitri	1.11	C enable EVP code by defining the following flag
89	dimitri	1.14	# define SEAICE_ALLOW_EVP
90			# ifdef SEAICE_ALLOW_EVP
91	mlosch	1.13	C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit
92			C-- viscosities from below and above in seaice_evp
93	gforget	1.16	C-- not necessary, and not recommended
94	dimitri	1.14	# define SEAICE_ALLOW_CLIPZETA
95			# endif /* SEAICE_ALLOW_EVP */
96	dimitri	1.11	C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
97	dimitri	1.14	# undef SEAICE_ALLOW_TEM
98			#else /* not SEAICE_CGRID, but old B-grid */
99			C-- By default for B-grid dynamics solver wind stress under sea-ice is
100			C set to the same value as it would be if there was no sea-ice.
101			C Define following CPP flag for B-grid ice-ocean stress coupling.
102			# define SEAICE_BICE_STRESS
103
104			C-- By default for B-grid dynamics solver surface tilt is obtained
105			C indirectly via geostrophic velocities. Define following CPP
106			C in order to use ETAN instead.
107			# define EXPLICIT_SSH_SLOPE
108	dimitri	1.8	#endif /* SEAICE_CGRID */
109
110			C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth
111			#undef SEAICE_CAP_HEFF
112	jmc	1.17	C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
113			#undef SEAICE_CAP_ICELOAD
114	mlosch	1.12	C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
115	gforget	1.16	C-- not recommended
116	mlosch	1.12	#define SEAICE_ALLOW_CLIPVELS
117	edhill	1.4
118	gforget	1.15	C enable free drift code
119			#define SEAICE_ALLOW_FREEDRIFT
120
121	edhill	1.4	#endif /* SEAICE_OPTIONS_H */
122	dimitri	1.8
123			CEH3 ;;; Local Variables: ***
124			CEH3 ;;; mode:fortran ***
125			CEH3 ;;; End: ***