pkg/seaice/SEAICE_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.17 2006/12/19 00:14:47 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, pkg/seaice defines forcing variable internally, in
C     SEAICE_FFIELDS.h, and reads them in from files.  When CPP option
C     SEAICE_EXTERNAL_FORCING is defined, the above forcing variables
C     are defined and provided by an external package.  At present this
C     option is hardwired for pkg/exf and the variables are passed using
C     include file exf_fields.h.
#define SEAICE_EXTERNAL_FORCING
#ifdef SEAICE_EXTERNAL_FORCING
#include "EXF_OPTIONS.h"
#endif /* SEAICE_EXTERNAL_FORCING */

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

#endif /* SEAICE_OPTIONS_H */

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	mlosch	1.18	C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.17 2006/12/19 00:14:47 jmc 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, pkg/seaice defines forcing variable internally, in
28			C SEAICE_FFIELDS.h, and reads them in from files. When CPP option
29			C SEAICE_EXTERNAL_FORCING is defined, the above forcing variables
30			C are defined and provided by an external package. At present this
31			C option is hardwired for pkg/exf and the variables are passed using
32			C include file exf_fields.h.
33	dimitri	1.9	#define SEAICE_EXTERNAL_FORCING
34	dimitri	1.8	#ifdef SEAICE_EXTERNAL_FORCING
35			#include "EXF_OPTIONS.h"
36			#endif /* SEAICE_EXTERNAL_FORCING */
37	dimitri	1.3
38			C-- By default, the sea-ice package uses its own integrated bulk
39			C formulae to compute fluxes (fu, fv, EmPmR, Qnet, and Qsw) over
40			C open-ocean. When this flag is set, these variables are computed
41			C in a separate external package, for example, pkg/exf, and then
42			C modified for sea-ice effects by pkg/seaice.
43	dimitri	1.9	#define SEAICE_EXTERNAL_FLUXES
44	heimbach	1.2
45	dimitri	1.5	C-- By default, the sea-ice package uses 2-category thermodynamics.
46			C When this flag is set, an 8-category calculation of ice
47			C thermodynamics is carried out in groatb.F
48	dimitri	1.10	C Note the pickup_seaice.* generated by this option differ
49			C from those generated with the default 2-category model.
50			C Therefore it is not possible to switch between the two
51			C in the middle of an integration.
52	mlosch	1.18	#undef SEAICE_MULTICATEGORY
53	dimitri	1.5
54	dimitri	1.10	C-- By default cdm wind stress under sea-ice is set to the
55			C same value as it would be if there was no sea-ice.
56			C This is a placeholder until a more physically-sensible
57			C stable solution is developed. Apparently ocean stress
58			C that is based on sea-ice velocity can cause trouble in
59			C Arctic Ocean configurations. This temporary solution
60			C also corresponds to that adopted by CCSM-2. For the
61			C adventurous user who requires ice-modified stress,
62			C following options are available.
63			#undef SEAICE_ORIGINAL_BAD_ICE_STRESS
64			#undef SEAICE_TEST_ICE_STRESS_1
65
66	mlosch	1.13	C-- By default the freezing point of water is set to the value of
67			C the parameter SEAICE_freeze (=-1.96 by default). To use a
68			C simple linear dependence of the freezing point on salinity,
69			C set the following flag (pressure is assumed to have no effect,
70			C which is a good assumption for the top 20 meters). With this
71			C option defined the parameter SEAICE_freeze has no effect.
72			#undef SEAICE_VARIABLE_FREEZING_POINT
73
74	mlosch	1.14	C-- By default the seaice model is discretized on a B-Grid (for
75			C historical reasons). Define the following flag to use a new
76			C (not thoroughly) test version on a C-grid
77	jmc	1.17	#define SEAICE_CGRID
78	mlosch	1.14
79	mlosch	1.15	C-- Only for the C-grid version it is possible to enable EVP code by
80			C defining the following flag
81			#ifdef SEAICE_CGRID
82	jmc	1.17	#define SEAICE_ALLOW_EVP
83	jmc	1.16	#endif /* SEAICE_CGRID */
84	mlosch	1.15
85	edhill	1.7	#endif /* SEAICE_OPTIONS_H */
86	edhill	1.12
87			CEH3 ;;; Local Variables: ***
88			CEH3 ;;; mode:fortran ***
89			CEH3 ;;; End: ***