/[MITgcm]/MITgcm/verification/1D_ocean_ice_column/code_ad/SEAICE_OPTIONS.h
ViewVC logotype

Contents of /MITgcm/verification/1D_ocean_ice_column/code_ad/SEAICE_OPTIONS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.14 - (show annotations) (download)
Thu Dec 27 23:00:49 2012 UTC (11 years, 2 months ago) by gforget
Branch: MAIN
CVS Tags: checkpoint64y, checkpoint64x, checkpoint64z, checkpoint64q, checkpoint64p, checkpoint64s, checkpoint64r, checkpoint64u, checkpoint64t, checkpoint64w, checkpoint64v, checkpoint64i, checkpoint64h, checkpoint64k, checkpoint64j, checkpoint64m, checkpoint64l, checkpoint64o, checkpoint64n, checkpoint64c, checkpoint64e, checkpoint64d, checkpoint64g, checkpoint64f, checkpoint65, checkpoint65b, checkpoint65c, checkpoint65a, checkpoint65d, checkpoint65e
Changes since 1.13: +1 -7 lines
File MIME type: text/plain
- remove documentation for retired CPP flags (SEAICE_GROWTH_LEGACY, SEAICE_CAP_HEFF).

1 C $Header: /u/gcmpack/MITgcm/verification/1D_ocean_ice_column/code_ad/SEAICE_OPTIONS.h,v 1.13 2012/12/22 00:52:05 dimitri 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-- This CPP flag has been retired. The number of ice categories
38 C used to solve for seaice flux is now specified by run-time
39 C parameter SEAICE_multDim.
40 C Note: be aware of pickup_seaice.* compatibility issues when
41 C restarting a simulation with a different number of categories.
42 c#define SEAICE_MULTICATEGORY
43
44 C-- run with sea Ice Thickness Distribution (ITD);
45 C set number of categories (nITD) in SEAICE_SIZE.h
46 #undef SEAICE_ITD
47
48 #undef SEAICE_MODIFY_GROWTH_ADJ
49
50 C-- Since the missing sublimation term is now included
51 C this flag is needed for backward compatibility
52 #define SEAICE_DISABLE_SUBLIM
53
54 C-- Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
55 #define SEAICE_DISABLE_HEATCONSFIX
56
57 C-- Default is constant seaice salinity (SEAICE_salt0); Define the following
58 C flag to consider (space & time) variable salinity: advected and forming
59 C seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
60 C- Note: SItracer also offers an alternative way to handle variable salinity.
61 #define SEAICE_VARIABLE_SALINITY
62
63 C-- Tracers of ice and/or ice cover.
64 #undef ALLOW_SITRACER
65 #ifdef ALLOW_SITRACER
66 C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff.
67 # define ALLOW_SITRACER_ADVCAP
68 #endif
69
70 C-- By default the seaice model is discretized on a B-Grid (for
71 C historical reasons). Define the following flag to use a new
72 C (not thoroughly) test version on a C-grid
73 #define SEAICE_CGRID
74
75 C-- Only for the C-grid version it is possible to
76 #ifdef SEAICE_CGRID
77 C enable JFNK code by defining the following flag
78 # undef SEAICE_ALLOW_JFNK
79 C enable LSR to use global (multi-tile) tri-diagonal solver
80 # undef SEAICE_GLOBAL_3DIAG_SOLVER
81 C enable EVP code by defining the following flag
82 # define SEAICE_ALLOW_EVP
83 # ifdef SEAICE_ALLOW_EVP
84 C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
85 C from below and above in seaice_evp: not necessary, and not recommended
86 # undef SEAICE_ALLOW_CLIPZETA
87 # endif /* SEAICE_ALLOW_EVP */
88 C regularize zeta to zmax with a smooth tanh-function instead
89 C of a min(zeta,zmax). This improves convergence of iterative
90 C solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
91 # undef SEAICE_ZETA_SMOOTHREG
92 C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
93 # undef SEAICE_ALLOW_TEM
94 #else /* not SEAICE_CGRID, but old B-grid */
95 C-- By default for B-grid dynamics solver wind stress under sea-ice is
96 C set to the same value as it would be if there was no sea-ice.
97 C Define following CPP flag for B-grid ice-ocean stress coupling.
98 # define SEAICE_BICE_STRESS
99
100 C-- By default for B-grid dynamics solver surface tilt is obtained
101 C indirectly via geostrophic velocities. Define following CPP
102 C in order to use ETAN instead.
103 # define EXPLICIT_SSH_SLOPE
104 C-- Defining this flag turns on FV-discretization of the B-grid LSOR solver.
105 C It is smoother and includes all metric terms, similar to C-grid solvers.
106 C It is here for completeness, but its usefulness is unclear.
107 # undef SEAICE_LSRBNEW
108 #endif /* SEAICE_CGRID */
109
110 C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
111 #undef SEAICE_CAP_ICELOAD
112 C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
113 C not recommended
114 #undef SEAICE_ALLOW_CLIPVELS
115 C-- When set cap the sublimation latent heat flux in solve4temp according
116 C to the available amount of ice+snow. Otherwise this term is treated
117 C like all of the others -- residuals heat and fw stocks are passed to
118 C the ocean at the end of seaice_growth in a conservative manner.
119 C SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
120 #undef SEAICE_CAP_SUBLIM
121
122 C-- Enable free drift code
123 #undef SEAICE_ALLOW_FREEDRIFT
124
125 #endif /* ALLOW_SEAICE */
126 #endif /* SEAICE_OPTIONS_H */
127
128 CEH3 ;;; Local Variables: ***
129 CEH3 ;;; mode:fortran ***
130 CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22