1D_ocean_ice_column/code/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/verification/1D_ocean_ice_column/code/SEAICE_OPTIONS.h,v 1.6 2012/02/06 23:00:26 ifenty 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.
#undef 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
#undef SEAICE_MODIFY_GROWTH_ADJ
#undef SEAICE_SIMPLIFY_GROWTH_ADJ

c     Use the McPhee Ocean-Ice heat flux
#define MCPHEE_OCEAN_ICE_HEAT_FLUX
#define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR

#define SEAICE_DO_OPEN_WATER_GROWTH
#define SEAICE_DO_OPEN_WATER_MELT

#define FENTY_AREA_EXPANSION_CONTRACTION

#undef SEAICE_ADD_SUBLIMATION_TO_FWBUDGET

C--   By default cdm wind stress under sea-ice is set to the
C     same value as it would be if there was no sea-ice.
C     This is a placeholder until a more physically-sensible
C     stable solution is developed.  Apparently ocean stress
C     that is based on sea-ice velocity can cause trouble in
C     Arctic Ocean configurations.  This temporary solution
C     also corresponds to that adopted by CCSM-2.  For the
C     adventurous user who requires ice-modified stress,
C     following options are available.
#undef SEAICE_ORIGINAL_BAD_ICE_STRESS
#undef SEAICE_TEST_ICE_STRESS_1

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--   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 enable EVP code by
C     defining the following flag
#ifdef SEAICE_CGRID
#define SEAICE_ALLOW_EVP
#endif /* SEAICE_CGRID */

C--   Seaice flooding
#define ALLOW_SEAICE_FLOODING

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


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

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	ifenty	1.7	C $Header: /u/gcmpack/MITgcm/verification/1D_ocean_ice_column/code/SEAICE_OPTIONS.h,v 1.6 2012/02/06 23:00:26 ifenty Exp $
2	ifenty	1.1	C $Name: $
3
4	jmc	1.5	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	ifenty	1.1
12			#ifndef SEAICE_OPTIONS_H
13			#define SEAICE_OPTIONS_H
14			#include "PACKAGES_CONFIG.h"
15			#include "CPP_OPTIONS.h"
16
17	jmc	1.5	#ifdef ALLOW_SEAICE
18			C Package-specific Options & Macros go here
19
20	ifenty	1.1	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	ifenty	1.4	#undef SEAICE_ALLOW_DYNAMICS
29	ifenty	1.1
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-- By default, the sea-ice package uses 2-category thermodynamics.
38			C When this flag is set, an 8-category calculation of ice
39			C thermodynamics is carried out in groatb.F
40			C Note the pickup_seaice.* generated by this option differ
41			C from those generated with the default 2-category model.
42			C Therefore it is not possible to switch between the two
43			C in the middle of an integration.
44			#undef SEAICE_MULTICATEGORY
45			#undef SEAICE_MODIFY_GROWTH_ADJ
46	jmc	1.5	#undef SEAICE_SIMPLIFY_GROWTH_ADJ
47	ifenty	1.1
48			c Use the McPhee Ocean-Ice heat flux
49			#define MCPHEE_OCEAN_ICE_HEAT_FLUX
50			#define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR
51
52	gforget	1.3	#define SEAICE_DO_OPEN_WATER_GROWTH
53			#define SEAICE_DO_OPEN_WATER_MELT
54	ifenty	1.1
55			#define FENTY_AREA_EXPANSION_CONTRACTION
56
57			#undef SEAICE_ADD_SUBLIMATION_TO_FWBUDGET
58
59			C-- By default cdm wind stress under sea-ice is set to the
60			C same value as it would be if there was no sea-ice.
61			C This is a placeholder until a more physically-sensible
62			C stable solution is developed. Apparently ocean stress
63			C that is based on sea-ice velocity can cause trouble in
64			C Arctic Ocean configurations. This temporary solution
65			C also corresponds to that adopted by CCSM-2. For the
66			C adventurous user who requires ice-modified stress,
67			C following options are available.
68			#undef SEAICE_ORIGINAL_BAD_ICE_STRESS
69			#undef SEAICE_TEST_ICE_STRESS_1
70
71			C-- By default the freezing point of water is set to the value of
72			C the parameter SEAICE_freeze (=-1.96 by default). To use a
73			C simple linear dependence of the freezing point on salinity,
74			C set the following flag (pressure is assumed to have no effect,
75			C which is a good assumption for the top 20 meters). With this
76			C option defined the parameter SEAICE_freeze has no effect.
77			#undef SEAICE_VARIABLE_FREEZING_POINT
78
79			C-- By default the seaice model is discretized on a B-Grid (for
80			C historical reasons). Define the following flag to use a new
81			C (not thoroughly) test version on a C-grid
82			#define SEAICE_CGRID
83
84			C-- Only for the C-grid version it is possible to enable EVP code by
85			C defining the following flag
86			#ifdef SEAICE_CGRID
87			#define SEAICE_ALLOW_EVP
88			#endif /* SEAICE_CGRID */
89
90			C-- Seaice flooding
91			#define ALLOW_SEAICE_FLOODING
92
93			C-- By default sea ice is fresh. Set following flag for salty ice.
94	jmc	1.8	#define SEAICE_VARIABLE_SALINITY
95	ifenty	1.1
96
97	jmc	1.5	#endif /* ALLOW_SEAICE */
98	ifenty	1.1	#endif /* SEAICE_OPTIONS_H */
99
100			CEH3 ;;; Local Variables: ***
101			CEH3 ;;; mode:fortran ***
102			CEH3 ;;; End: ***