/[MITgcm]/MITgcm/verification/lab_sea/code_ad/SEAICE_OPTIONS.h
ViewVC logotype

Contents of /MITgcm/verification/lab_sea/code_ad/SEAICE_OPTIONS.h

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


Revision 1.28 - (show annotations) (download)
Mon Jun 15 15:39:50 2015 UTC (8 years, 9 months ago) by mlosch
Branch: MAIN
CVS Tags: checkpoint66g, checkpoint66f, checkpoint66e, checkpoint66d, checkpoint66c, checkpoint66b, checkpoint66a, checkpoint66o, checkpoint66n, checkpoint66m, checkpoint66l, checkpoint66k, checkpoint66j, checkpoint66i, checkpoint66h, checkpoint65z, checkpoint65x, checkpoint65y, checkpoint65r, checkpoint65s, checkpoint65p, checkpoint65q, checkpoint65v, checkpoint65w, checkpoint65t, checkpoint65u, checkpoint65n, checkpoint65o, HEAD
Changes since 1.27: +9 -4 lines
File MIME type: text/plain
rename SEAICE_VECTORIZE_LSR_ZEBRA to SEAICE_LSR_ZEBRA and add more comments

1 C $Header: /u/gcmpack/MITgcm/verification/lab_sea/code_ad/SEAICE_OPTIONS.h,v 1.27 2014/10/01 16:06:24 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 #define 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 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 confirmed)
53 #define SEAICE_DISABLE_HEATCONSFIX
54
55 C-- Default is constant seaice salinity (SEAICE_salt0); Define the following
56 C flag to consider (space & time) variable salinity: advected and forming
57 C seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
58 C- Note: SItracer also offers an alternative way to handle variable salinity.
59 #define SEAICE_VARIABLE_SALINITY
60
61 C-- Tracers of ice and/or ice cover.
62 #undef ALLOW_SITRACER
63 #ifdef ALLOW_SITRACER
64 C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff.
65 # define ALLOW_SITRACER_ADVCAP
66 #endif
67
68 C-- By default the seaice model is discretized on a B-Grid (for
69 C historical reasons). Define the following flag to use a new
70 C (not thoroughly) test version on a C-grid
71 #define SEAICE_CGRID
72
73 C-- Only for the C-grid version it is possible to
74 #ifdef SEAICE_CGRID
75 C enable JFNK code by defining the following flag
76 # undef SEAICE_ALLOW_JFNK
77 C enable LSR to use global (multi-tile) tri-diagonal solver
78 # undef SEAICE_GLOBAL_3DIAG_SOLVER
79 C enable EVP code by defining the following flag
80 # define SEAICE_ALLOW_EVP
81 # ifdef SEAICE_ALLOW_EVP
82 C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
83 C from below and above in seaice_evp: not necessary, and not recommended
84 # undef SEAICE_ALLOW_CLIPZETA
85 # endif /* SEAICE_ALLOW_EVP */
86 C regularize zeta to zmax with a smooth tanh-function instead
87 C of a min(zeta,zmax). This improves convergence of iterative
88 C solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
89 # undef SEAICE_ZETA_SMOOTHREG
90 C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
91 # undef SEAICE_ALLOW_TEM
92 C Either SEAICE_VECTORIZE_LSR or SEAICE_LSR_ZEBRA
93 C need to be defined to have an actual adjoint of the
94 C seaice_lsr solver; not that this solution works, but at least TAF
95 C complains the least (and gives the best code)
96 # undef SEAICE_VECTORIZE_LSR
97 # define SEAICE_LSR_ZEBRA
98 C This flag is also required for an actual adjoint of seaice_lsr;
99 C increases memory requirements a lot.
100 # define SEAICE_LSR_ADJOINT_ITER
101 #else /* not SEAICE_CGRID, but old B-grid */
102 C-- By default for B-grid dynamics solver wind stress under sea-ice is
103 C set to the same value as it would be if there was no sea-ice.
104 C Define following CPP flag for B-grid ice-ocean stress coupling.
105 # define SEAICE_BICE_STRESS
106
107 C-- By default for B-grid dynamics solver surface tilt is obtained
108 C indirectly via geostrophic velocities. Define following CPP
109 C in order to use ETAN instead.
110 # define EXPLICIT_SSH_SLOPE
111 C-- Defining this flag turns on FV-discretization of the B-grid LSOR solver.
112 C It is smoother and includes all metric terms, similar to C-grid solvers.
113 C It is here for completeness, but its usefulness is unclear.
114 # undef SEAICE_LSRBNEW
115 #endif /* SEAICE_CGRID */
116
117 C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
118 #undef SEAICE_CAP_ICELOAD
119 C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
120 C not recommended
121 #undef SEAICE_ALLOW_CLIPVELS
122 C-- When set cap the sublimation latent heat flux in solve4temp according
123 C to the available amount of ice+snow. Otherwise this term is treated
124 C like all of the others -- residuals heat and fw stocks are passed to
125 C the ocean at the end of seaice_growth in a conservative manner.
126 C SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
127 #undef SEAICE_CAP_SUBLIM
128
129 C-- Enable free drift code
130 #define SEAICE_ALLOW_FREEDRIFT
131
132 C-- pkg/seaice cost functions compile flags
133 c >>> Sea-ice volume (requires pkg/cost)
134 #undef ALLOW_COST_ICE
135 c >>> Sea-ice misfit to obs (requires pkg/cost and ecco)
136 #define ALLOW_SEAICE_COST_SMR_AREA
137
138 #endif /* ALLOW_SEAICE */
139 #endif /* SEAICE_OPTIONS_H */
140
141 CEH3 ;;; Local Variables: ***
142 CEH3 ;;; mode:fortran ***
143 CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22