pkg/seaice/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.44 2011/02/10 12:01:18 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"

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-    ifdef SEAICE_DO_OPEN_WATER_GROWTH then define SEAICE_DO_OPEN_WATER_MELT
C     to also allow open-water air-sea heat fluxes melt ice
#undef SEAICE_DO_OPEN_WATER_MELT
#endif

C-    to use the MCPhee formula in computing ocean/ice fluxes
#undef MCPHEE_OCEAN_ICE_HEAT_FLUX

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.
#undef 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.
#undef 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.
#undef SEAICE_AGE
#ifdef SEAICE_AGE
# undef 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
#  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
#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
#undef SEAICE_ALLOW_CLIPVELS

C     enable free drift code
#undef SEAICE_ALLOW_FREEDRIFT

#endif /* SEAICE_OPTIONS_H */

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	gforget	1.45	C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.44 2011/02/10 12:01:18 gforget Exp $
2	jmc	1.17	C $Name: $
3	heimbach	1.2
4	jmc	1.41	C ==========================================================
5	heimbach	1.2	C \| SEAICE_OPTIONS.h \|
6			C \| o CPP options file for sea ice package. \|
7	jmc	1.41	C ==========================================================
8	heimbach	1.2	C \| Use this file for selecting options within the sea ice \|
9	edhill	1.7	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
17	dimitri	1.3	C-- Write "text-plots" of certain fields in STDOUT for debugging.
18	heimbach	1.2	#undef SEAICE_DEBUG
19
20	dimitri	1.3	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	heimbach	1.2	#define SEAICE_ALLOW_DYNAMICS
26	dimitri	1.3
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.28	#define SEAICE_EXTERNAL_FLUXES
33	heimbach	1.2
34	dimitri	1.5	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.10	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	mlosch	1.18	#undef SEAICE_MULTICATEGORY
42	dimitri	1.5
43	jmc	1.41	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	jmc	1.42	#define SEAICE_GROWTH_LEGACY
46	jmc	1.41
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	gforget	1.44	C- ifdef SEAICE_DO_OPEN_WATER_GROWTH then define SEAICE_DO_OPEN_WATER_MELT
52			C to also allow open-water air-sea heat fluxes melt ice
53			#undef SEAICE_DO_OPEN_WATER_MELT
54	jmc	1.41	#endif
55
56	gforget	1.43	C- to use the MCPhee formula in computing ocean/ice fluxes
57			#undef MCPHEE_OCEAN_ICE_HEAT_FLUX
58
59	jmc	1.41	C-- Use the Old version of seaice_solve4temp (formerly seaice_budget_ice)
60			C otherwise, use Ian Fenty s version
61			#define SEAICE_SOLVE4TEMP_LEGACY
62
63			C-- By default the freezing point of water is set to the value of
64	mlosch	1.13	C the parameter SEAICE_freeze (=-1.96 by default). To use a
65	jmc	1.41	C simple linear dependence of the freezing point on salinity,
66	mlosch	1.13	C set the following flag (pressure is assumed to have no effect,
67			C which is a good assumption for the top 20 meters). With this
68			C option defined the parameter SEAICE_freeze has no effect.
69			#undef SEAICE_VARIABLE_FREEZING_POINT
70
71	dimitri	1.19	C-- Allow SEAICEuseFlooding, which converts snow to ice if submerged.
72	mlosch	1.33	#define ALLOW_SEAICE_FLOODING
73	dimitri	1.19
74	dimitri	1.27	C-- By default sea ice is fresh. Set following flag for salty ice.
75			#undef SEAICE_SALINITY
76
77	dimitri	1.32	C-- Track sea ice age.
78	dimitri	1.39	C By default sea ice age is associated with ice area.
79			C Define SEAICE_AGE_VOL to associate age with volume.
80	dimitri	1.32	#undef SEAICE_AGE
81	dimitri	1.39	#ifdef SEAICE_AGE
82			# undef SEAICE_AGE_VOL
83			#endif
84	dimitri	1.32
85	jmc	1.41	C-- By default the seaice model is discretized on a B-Grid (for
86	mlosch	1.14	C historical reasons). Define the following flag to use a new
87			C (not thoroughly) test version on a C-grid
88	jmc	1.17	#define SEAICE_CGRID
89	mlosch	1.14
90	jmc	1.41	C-- Only for the C-grid version it is possible to
91	mlosch	1.15	#ifdef SEAICE_CGRID
92	mlosch	1.31	C enable EVP code by defining the following flag
93	dimitri	1.38	# define SEAICE_ALLOW_EVP
94			# ifdef SEAICE_ALLOW_EVP
95	mlosch	1.37	C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit
96			C-- viscosities from below and above in seaice_evp
97			C-- not necessary, and not recommended
98	dimitri	1.38	# undef SEAICE_ALLOW_CLIPZETA
99			# endif /* SEAICE_ALLOW_EVP */
100	mlosch	1.31	C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
101	dimitri	1.38	# undef SEAICE_ALLOW_TEM
102	mlosch	1.33	#else /* not SEAICE_CGRID, but old B-grid */
103			C-- By default for B-grid dynamics solver wind stress under sea-ice is
104			C set to the same value as it would be if there was no sea-ice.
105			C Define following CPP flag for B-grid ice-ocean stress coupling.
106	dimitri	1.38	# define SEAICE_BICE_STRESS
107	mlosch	1.33
108			C-- By default for B-grid dynamics solver surface tilt is obtained
109			C indirectly via geostrophic velocities. Define following CPP
110			C in order to use ETAN instead.
111	dimitri	1.38	# define EXPLICIT_SSH_SLOPE
112	jmc	1.16	#endif /* SEAICE_CGRID */
113	mlosch	1.15
114	dimitri	1.24	C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth
115			#undef SEAICE_CAP_HEFF
116	jmc	1.41	C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
117			#undef SEAICE_CAP_ICELOAD
118	mlosch	1.36	C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
119			C-- not recommended
120			#undef SEAICE_ALLOW_CLIPVELS
121	dimitri	1.24
122	gforget	1.40	C enable free drift code
123			#undef SEAICE_ALLOW_FREEDRIFT
124
125	edhill	1.7	#endif /* SEAICE_OPTIONS_H */
126	edhill	1.12
127			CEH3 ;;; Local Variables: ***
128			CEH3 ;;; mode:fortran ***
129			CEH3 ;;; End: ***