pkg/seaice/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.34 2009/06/04 17:27:17 dimitri 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--   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.
#undef SEAICE_AGE

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

#endif /* SEAICE_OPTIONS_H */

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	dimitri	1.35	C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.34 2009/06/04 17:27:17 dimitri Exp $
2	jmc	1.17	C $Name: $
3	heimbach	1.2
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	edhill	1.7	C \| package. \|
10	heimbach	1.2	C \==========================================================/
11
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	mlosch	1.13	C-- By default the freezing point of water is set to the value of
44			C the parameter SEAICE_freeze (=-1.96 by default). To use a
45			C simple linear dependence of the freezing point on salinity,
46			C set the following flag (pressure is assumed to have no effect,
47			C which is a good assumption for the top 20 meters). With this
48			C option defined the parameter SEAICE_freeze has no effect.
49			#undef SEAICE_VARIABLE_FREEZING_POINT
50
51	dimitri	1.19	C-- Allow SEAICEuseFlooding, which converts snow to ice if submerged.
52	mlosch	1.33	#define ALLOW_SEAICE_FLOODING
53	dimitri	1.19
54	dimitri	1.27	C-- By default sea ice is fresh. Set following flag for salty ice.
55			#undef SEAICE_SALINITY
56
57	dimitri	1.32	C-- Track sea ice age.
58			#undef SEAICE_AGE
59
60	mlosch	1.14	C-- By default the seaice model is discretized on a B-Grid (for
61			C historical reasons). Define the following flag to use a new
62			C (not thoroughly) test version on a C-grid
63	jmc	1.17	#define SEAICE_CGRID
64	mlosch	1.14
65	mlosch	1.31	C-- Only for the C-grid version it is possible to
66	mlosch	1.15	#ifdef SEAICE_CGRID
67	mlosch	1.31	C enable EVP code by defining the following flag
68	jmc	1.17	#define SEAICE_ALLOW_EVP
69	mlosch	1.31	C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
70			#undef SEAICE_ALLOW_TEM
71	mlosch	1.33	#else /* not SEAICE_CGRID, but old B-grid */
72			C-- By default for B-grid dynamics solver wind stress under sea-ice is
73			C set to the same value as it would be if there was no sea-ice.
74			C Define following CPP flag for B-grid ice-ocean stress coupling.
75			#define SEAICE_BICE_STRESS
76
77			C-- By default for B-grid dynamics solver surface tilt is obtained
78			C indirectly via geostrophic velocities. Define following CPP
79			C in order to use ETAN instead.
80			#define EXPLICIT_SSH_SLOPE
81
82	jmc	1.16	#endif /* SEAICE_CGRID */
83	mlosch	1.15
84	dimitri	1.24	C-- When set use MAX_HEFF to cap sea ice thickness in seaice_growth
85			#undef SEAICE_CAP_HEFF
86
87	edhill	1.7	#endif /* SEAICE_OPTIONS_H */
88	edhill	1.12
89			CEH3 ;;; Local Variables: ***
90			CEH3 ;;; mode:fortran ***
91			CEH3 ;;; End: ***