-
Notifications
You must be signed in to change notification settings - Fork 148
/
MOM_parameter_doc.short
284 lines (254 loc) · 19.2 KB
/
MOM_parameter_doc.short
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
! This file was written by the model and records the non-default parameters used at run-time.
! === module MOM ===
ENABLE_THERMODYNAMICS = False ! [Boolean] default = True
! If true, Temperature and salinity are used as state variables.
ADIABATIC = True ! [Boolean] default = False
! There are no diapycnal mass fluxes if ADIABATIC is true. This assumes that KD
! = 0.0 and that there is no buoyancy forcing, but makes the model faster by
! eliminating subroutine calls.
DT = 1200.0 ! [s]
! The (baroclinic) dynamics time step. The time-step that is actually used will
! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode
! or the coupling timestep in coupled mode.)
DT_THERM = 2400.0 ! [s] default = 1200.0
! The thermodynamic and tracer advection time step. Ideally DT_THERM should be
! an integer multiple of DT and less than the forcing or coupling time-step,
! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer
! multiple of the coupling timestep. By default DT_THERM is set to DT.
DTBT_RESET_PERIOD = -1.0 ! [s] default = 2400.0
! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD
! is negative, DTBT is set based only on information available at
! initialization. If 0, DTBT will be set every dynamics time step. The default
! is set by DT_THERM. This is only used if SPLIT is true.
! === module MOM_domains ===
REENTRANT_X = False ! [Boolean] default = True
! If true, the domain is zonally reentrant.
NIGLOBAL = 44 !
! The total number of thickness grid points in the x-direction in the physical
! domain. With STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
NJGLOBAL = 40 !
! The total number of thickness grid points in the y-direction in the physical
! domain. With STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
! === module MOM_fixed_initialization ===
INPUTDIR = "INPUT" ! default = "."
! The directory in which input files are found.
! === module MOM_grid_init ===
GRID_CONFIG = "spherical" !
! A character string that determines the method for defining the horizontal
! grid. Current options are:
! mosaic - read the grid from a mosaic (supergrid)
! file set by GRID_FILE.
! cartesian - use a (flat) Cartesian grid.
! spherical - use a simple spherical grid.
! mercator - use a Mercator spherical grid.
SOUTHLAT = 30.0 ! [degrees_N]
! The southern latitude of the domain.
LENLAT = 20.0 ! [degrees_N]
! The latitudinal length of the domain.
LENLON = 22.0 ! [degrees_E]
! The longitudinal length of the domain.
TOPO_CONFIG = "spoon" !
! This specifies how bathymetry is specified:
! file - read bathymetric information from the file
! specified by (TOPO_FILE).
! flat - flat bottom set to MAXIMUM_DEPTH.
! bowl - an analytically specified bowl-shaped basin
! ranging between MAXIMUM_DEPTH and MINIMUM_DEPTH.
! spoon - a similar shape to 'bowl', but with an vertical
! wall at the southern face.
! halfpipe - a zonally uniform channel with a half-sine
! profile in the meridional direction.
! bbuilder - build topography from list of functions.
! benchmark - use the benchmark test case topography.
! Neverworld - use the Neverworld test case topography.
! DOME - use a slope and channel configuration for the
! DOME sill-overflow test case.
! ISOMIP - use a slope and channel configuration for the
! ISOMIP test case.
! DOME2D - use a shelf and slope configuration for the
! DOME2D gravity current/overflow test case.
! Kelvin - flat but with rotated land mask.
! seamount - Gaussian bump for spontaneous motion test case.
! dumbbell - Sloshing channel with reservoirs on both ends.
! shelfwave - exponential slope for shelfwave test case.
! Phillips - ACC-like idealized topography used in the Phillips config.
! dense - Denmark Strait-like dense water formation and overflow.
! USER - call a user modified routine.
MINIMUM_DEPTH = 1.0 ! [m] default = 0.0
! The minimum depth of the ocean.
MAXIMUM_DEPTH = 2000.0 ! [m]
! The maximum depth of the ocean.
! === module MOM_verticalGrid ===
! Parameters providing information about the vertical grid.
NK = 2 ! [nondim]
! The number of model layers.
! === module MOM_tracer_flow_control ===
! === module MOM_coord_initialization ===
COORD_CONFIG = "gprime" ! default = "none"
! This specifies how layers are to be defined:
! ALE or none - used to avoid defining layers in ALE mode
! file - read coordinate information from the file
! specified by (COORD_FILE).
! BFB - Custom coords for buoyancy-forced basin case
! based on SST_S, T_BOT and DRHO_DT.
! linear - linear based on interfaces not layers
! layer_ref - linear based on layer densities
! ts_ref - use reference temperature and salinity
! ts_range - use range of temperature and salinity
! (T_REF and S_REF) to determine surface density
! and GINT calculate internal densities.
! gprime - use reference density (RHO_0) for surface
! density and GINT calculate internal densities.
! ts_profile - use temperature and salinity profiles
! (read from COORD_FILE) to set layer densities.
! USER - call a user modified routine.
GFS = 0.98 ! [m s-2] default = 9.8
! The reduced gravity at the free surface.
GINT = 0.0098 ! [m s-2]
! The reduced gravity across internal interfaces.
! === module MOM_state_initialization ===
! === module MOM_diag_mediator ===
! === module MOM_lateral_mixing_coeffs ===
! === module MOM_set_visc ===
LINEAR_DRAG = True ! [Boolean] default = False
! If LINEAR_DRAG and BOTTOMDRAGLAW are defined the drag law is
! cdrag*DRAG_BG_VEL*u.
HBBL = 10.0 ! [m]
! The thickness of a bottom boundary layer with a viscosity increased by
! KV_EXTRA_BBL if BOTTOMDRAGLAW is not defined, or the thickness over which
! near-bottom velocities are averaged for the drag law if BOTTOMDRAGLAW is
! defined but LINEAR_DRAG is not.
DRAG_BG_VEL = 0.1 ! [m s-1] default = 0.0
! DRAG_BG_VEL is either the assumed bottom velocity (with LINEAR_DRAG) or an
! unresolved velocity that is combined with the resolved velocity to estimate
! the velocity magnitude. DRAG_BG_VEL is only used when BOTTOMDRAGLAW is
! defined.
BBL_THICK_MIN = 0.1 ! [m] default = 0.0
! The minimum bottom boundary layer thickness that can be used with
! BOTTOMDRAGLAW. This might be Kv/(cdrag*drag_bg_vel) to give Kv as the minimum
! near-bottom viscosity.
KV = 1.0E-04 ! [m2 s-1]
! The background kinematic viscosity in the interior. The molecular value, ~1e-6
! m2 s-1, may be used.
! === module MOM_thickness_diffuse ===
! === module MOM_porous_barriers ===
! === module MOM_dynamics_split_RK2 ===
! === module MOM_continuity_PPM ===
ETA_TOLERANCE = 1.0E-12 ! [m] default = 1.0E-10
! The tolerance for the differences between the barotropic and baroclinic
! estimates of the sea surface height due to the fluxes through each face. The
! total tolerance for SSH is 4 times this value. The default is
! 0.5*NK*ANGSTROM, and this should not be set less than about
! 10^-15*MAXIMUM_DEPTH.
! === module MOM_CoriolisAdv ===
BOUND_CORIOLIS = True ! [Boolean] default = False
! If true, the Coriolis terms at u-points are bounded by the four estimates of
! (f+rv)v from the four neighboring v-points, and similarly at v-points. This
! option would have no effect on the SADOURNY Coriolis scheme if it were
! possible to use centered difference thickness fluxes.
! === module MOM_PressureForce ===
! === module MOM_PressureForce_FV ===
! === module MOM_Zanna_Bolton ===
! === module MOM_hor_visc ===
LAPLACIAN = True ! [Boolean] default = False
! If true, use a Laplacian horizontal viscosity.
KH = 1.0E+04 ! [m2 s-1] default = 0.0
! The background Laplacian horizontal viscosity.
KH_VEL_SCALE = 0.003 ! [m s-1] default = 0.0
! The velocity scale which is multiplied by the grid spacing to calculate the
! Laplacian viscosity. The final viscosity is the largest of this scaled
! viscosity, the Smagorinsky and Leith viscosities, and KH.
SMAGORINSKY_KH = True ! [Boolean] default = False
! If true, use a Smagorinsky nonlinear eddy viscosity.
SMAG_LAP_CONST = 0.15 ! [nondim] default = 0.0
! The nondimensional Laplacian Smagorinsky constant, often 0.15.
BIHARMONIC = False ! [Boolean] default = True
! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with
! LAPLACIAN.
! === module MOM_vert_friction ===
DIRECT_STRESS = True ! [Boolean] default = False
! If true, the wind stress is distributed over the topmost HMIX_STRESS of fluid
! (like in HYCOM), and an added mixed layer viscosity or a physically based
! boundary layer turbulence parameterization is not needed for stability.
HARMONIC_VISC = True ! [Boolean] default = False
! If true, use the harmonic mean thicknesses for calculating the vertical
! viscosity.
HMIX_FIXED = 20.0 ! [m]
! The prescribed depth over which the near-surface viscosity and diffusivity are
! elevated when the bulk mixed layer is not used.
KV_ML_INVZ2 = 0.01 ! [m2 s-1] default = 0.0
! An extra kinematic viscosity in a mixed layer of thickness HMIX_FIXED, with
! the actual viscosity scaling as 1/(z*HMIX_FIXED)^2, where z is the distance
! from the surface, to allow for finite wind stresses to be transmitted through
! infinitesimally thin surface layers. This is an older option for numerical
! convenience without a strong physical basis, and its use is now discouraged.
MAXVEL = 6.0 ! [m s-1] default = 3.0E+08
! The maximum velocity allowed before the velocity components are truncated.
! === module MOM_barotropic ===
BOUND_BT_CORRECTION = True ! [Boolean] default = False
! If true, the corrective pseudo mass-fluxes into the barotropic solver are
! limited to values that require less than maxCFL_BT_cont to be accommodated.
BT_PROJECT_VELOCITY = True ! [Boolean] default = False
! If true, step the barotropic velocity first and project out the velocity
! tendency by 1+BEBT when calculating the transport. The default (false) is to
! use a predictor continuity step to find the pressure field, and then to do a
! corrector continuity step using a weighted average of the old and new
! velocities, with weights of (1-BEBT) and BEBT.
BEBT = 0.2 ! [nondim] default = 0.1
! BEBT determines whether the barotropic time stepping uses the forward-backward
! time-stepping scheme or a backward Euler scheme. BEBT is valid in the range
! from 0 (for a forward-backward treatment of nonrotating gravity waves) to 1
! (for a backward Euler treatment). In practice, BEBT must be greater than about
! 0.05.
DTBT = -0.9 ! [s or nondim] default = -0.98
! The barotropic time step, in s. DTBT is only used with the split explicit time
! stepping. To set the time step automatically based the maximum stable value
! use 0, or a negative value gives the fraction of the stable value. Setting
! DTBT to 0 is the same as setting it to -0.98. The value of DTBT that will
! actually be used is an integer fraction of DT, rounding down.
! === module MOM_diagnostics ===
! === module MOM_diabatic_driver ===
! The following parameters are used for diabatic processes.
! === module MOM_tracer_advect ===
! === module MOM_tracer_hor_diff ===
! === module MOM_sum_output ===
DATE_STAMPED_STDOUT = False ! [Boolean] default = True
! If true, use dates (not times) in messages to stdout
READ_DEPTH_LIST = True ! [Boolean] default = False
! Read the depth list from a file if it exists or create that file otherwise.
DEPTH_LIST_MIN_INC = 1.0E-06 ! [m] default = 1.0E-10
! The minimum increment between the depths of the entries in the depth-list
! file.
REQUIRE_DEPTH_LIST_CHECKSUMS = False ! [Boolean] default = True
! Require that matching checksums be in Depth_list.nc when reading the file.
UPDATE_DEPTH_LIST_CHECKSUMS = True ! [Boolean] default = False
! Automatically update the Depth_list.nc file if the checksums are missing or do
! not match current values.
! === module ocean_stochastics_init ===
! === module MOM_surface_forcing ===
VARIABLE_WINDS = False ! [Boolean] default = True
! If true, the winds vary in time after the initialization.
VARIABLE_BUOYFORCE = False ! [Boolean] default = True
! If true, the buoyancy forcing varies in time after the initialization of the
! model.
WIND_CONFIG = "2gyre" ! default = "zero"
! The character string that indicates how wind forcing is specified. Valid
! options include (file), (data_override), (2gyre), (1gyre), (gyres), (zero),
! (const), (Neverworld), (scurves), (ideal_hurr), (SCM_ideal_hurr),
! (SCM_CVmix_tests) and (USER).
! === module MOM_main (MOM_driver) ===
DT_FORCING = 2400.0 ! [s] default = 1200.0
! The time step for changing forcing, coupling with other components, or
! potentially writing certain diagnostics. The default value is given by DT.
DAYMAX = 10.0 ! [days]
! The final time of the whole simulation, in units of TIMEUNIT seconds. This
! also sets the potential end time of the present run segment if the end time is
! not set via ocean_solo_nml in input.nml.
RESTART_CONTROL = 3 ! default = 1
! An integer whose bits encode which restart files are written. Add 2 (bit 1)
! for a time-stamped file, and odd (bit 0) for a non-time-stamped file. A
! non-time-stamped restart file is saved at the end of the run segment for any
! non-negative value.
RESTINT = 110.0 ! [days] default = 0.0
! The interval between saves of the restart file in units of TIMEUNIT. Use 0
! (the default) to not save incremental restart files at all.