1D_ocean_ice_column/code/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/verification/1D_ocean_ice_column/code/SEAICE_OPTIONS.h,v 1.12 2012/02/13 23:26:58 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.
#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--   Since the missing sublimation term is now included
C     this flag is needed for backward compatibility
#define SEAICE_DISABLE_SUBLIM

C--   Suspected missing term in coupled ocn-ice heat budget (to be further tested)
#define SEAICE_DISABLE_HEATCONSFIX

C--   The freezing point of water is a simple linear dependence to salinity.
C     The flag below is now obsolete, but kept to ease the transition
C     from the old constant freezing point default (see seaice_check.F).
#define SEAICE_VARIABLE_FREEZING_POINT

C--   The flags below are obsolete, but kept to ease the transition
C     from the old default to the new one (see seaice_check.F).
#define MCPHEE_OCEAN_ICE_HEAT_FLUX
#define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR

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 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--   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	C $Header: /u/gcmpack/MITgcm/verification/1D_ocean_ice_column/code/SEAICE_OPTIONS.h,v 1.12 2012/02/13 23:26:58 gforget Exp $
2	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	#undef 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-- 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	#undef SEAICE_SIMPLIFY_GROWTH_ADJ
47
48	C-- Since the missing sublimation term is now included
49	C this flag is needed for backward compatibility
50	#define SEAICE_DISABLE_SUBLIM
51
52	C-- Suspected missing term in coupled ocn-ice heat budget (to be further tested)
53	#define SEAICE_DISABLE_HEATCONSFIX
54
55	C-- The freezing point of water is a simple linear dependence to salinity.
56	C The flag below is now obsolete, but kept to ease the transition
57	C from the old constant freezing point default (see seaice_check.F).
58	#define SEAICE_VARIABLE_FREEZING_POINT
59
60	C-- The flags below are obsolete, but kept to ease the transition
61	C from the old default to the new one (see seaice_check.F).
62	#define MCPHEE_OCEAN_ICE_HEAT_FLUX
63	#define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR
64
65	C-- By default cdm wind stress under sea-ice is set to the
66	C same value as it would be if there was no sea-ice.
67	C This is a placeholder until a more physically-sensible
68	C stable solution is developed. Apparently ocean stress
69	C that is based on sea-ice velocity can cause trouble in
70	C Arctic Ocean configurations. This temporary solution
71	C also corresponds to that adopted by CCSM-2. For the
72	C adventurous user who requires ice-modified stress,
73	C following options are available.
74	#undef SEAICE_ORIGINAL_BAD_ICE_STRESS
75	#undef SEAICE_TEST_ICE_STRESS_1
76
77	C-- By default the seaice model is discretized on a B-Grid (for
78	C historical reasons). Define the following flag to use a new
79	C (not thoroughly) test version on a C-grid
80	#define SEAICE_CGRID
81
82	C-- Only for the C-grid version it is possible to enable EVP code by
83	C defining the following flag
84	#ifdef SEAICE_CGRID
85	#define SEAICE_ALLOW_EVP
86	#endif /* SEAICE_CGRID */
87
88	C-- By default sea ice is fresh. Set following flag for salty ice.
89	#define SEAICE_VARIABLE_SALINITY
90
91
92	#endif /* ALLOW_SEAICE */
93	#endif /* SEAICE_OPTIONS_H */
94
95	CEH3 ;;; Local Variables: ***
96	CEH3 ;;; mode:fortran ***
97	CEH3 ;;; End: ***