! This file was written by the model and records all non-layout or debugging parameters used at run-time. ! === module MOM === SPLIT = True ! [Boolean] default = True ! Use the split time stepping if true. CALC_RHO_FOR_SEA_LEVEL = False ! [Boolean] default = False ! If true, the in-situ density is used to calculate the ! effective sea level that is returned to the coupler. If false, ! the Boussinesq parameter RHO_0 is used. ENABLE_THERMODYNAMICS = True ! [Boolean] default = True ! If true, Temperature and salinity are used as state ! variables. USE_EOS = True ! [Boolean] default = True ! If true, density is calculated from temperature and ! salinity with an equation of state. If USE_EOS is ! true, ENABLE_THERMODYNAMICS must be true as well. DIABATIC_FIRST = True ! [Boolean] default = False ! If true, apply diabatic and thermodynamic processes, ! including buoyancy forcing and mass gain or loss, ! before stepping the dynamics forward. USE_CONTEMP_ABSSAL = False ! [Boolean] default = False ! If true, the prognostics T&S are the conservative temperature ! and absolute salinity. Care should be taken to convert them ! to potential temperature and practical salinity before ! exchanging them with the coupler and/or reporting T&S diagnostics. ADIABATIC = False ! [Boolean] default = False ! There are no diapycnal mass fluxes if ADIABATIC is ! true. This assumes that KD = KDML = 0.0 and that ! there is no buoyancy forcing, but makes the model ! faster by eliminating subroutine calls. USE_LEGACY_DIABATIC_DRIVER = True ! [Boolean] default = True ! If true, use the a legacy version of the diabatic subroutine. ! This is temporary and is needed avoid change in answers. OFFLINE_TRACER_MODE = False ! [Boolean] default = False ! If true, barotropic and baroclinic dynamics, thermodynamics ! are all bypassed with all the fields necessary to integrate ! the tracer advection and diffusion equation are read in from ! files stored from a previous integration of the prognostic model. ! NOTE: This option only used in the ocean_solo_driver. USE_REGRIDDING = True ! [Boolean] default = False ! If True, use the ALE algorithm (regridding/remapping). ! If False, use the layered isopycnal algorithm. BULKMIXEDLAYER = False ! [Boolean] default = False ! If true, use a Kraus-Turner-like bulk mixed layer ! with transitional buffer layers. Layers 1 through ! NKML+NKBL have variable densities. There must be at ! least NKML+NKBL+1 layers if BULKMIXEDLAYER is true. ! BULKMIXEDLAYER can not be used with USE_REGRIDDING. ! The default is influenced by ENABLE_THERMODYNAMICS. THICKNESSDIFFUSE = True ! [Boolean] default = False ! If true, interface heights are diffused with a ! coefficient of KHTH. THICKNESSDIFFUSE_FIRST = True ! [Boolean] default = False ! If true, do thickness diffusion before dynamics. ! This is only used if THICKNESSDIFFUSE is true. BATHYMETRY_AT_VEL = False ! [Boolean] default = False ! If true, there are separate values for the basin depths ! at velocity points. Otherwise the effects of topography ! are entirely determined from thickness points. DT = 3600.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 = 2.88E+04 ! [s] default = 3600.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. THERMO_SPANS_COUPLING = True ! [Boolean] default = False ! If true, the MOM will take thermodynamic and tracer ! timesteps that can be longer than the coupling timestep. ! The actual thermodynamic timestep that is used in this ! case is the largest integer multiple of the coupling ! timestep that is less than or equal to DT_THERM. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth ! over which to average to find surface properties like ! SST and SSS or density (but not surface velocities). HMIX_UV_SFC_PROP = 0.0 ! [m] default = 0.0 ! If BULKMIXEDLAYER is false, HMIX_UV_SFC_PROP is the depth ! over which to average to find surface flow properties, ! SSU, SSV. A non-positive value indicates no averaging. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth ! over which melt potential is computed will be min(HFREEZE, OBLD), ! where OBLD is the boundary layer depth. If HFREEZE <= 0 (default), ! melt potential will not be computed. MIN_Z_DIAG_INTERVAL = 2.16E+04 ! [s] default = 0.0 ! The minimum amount of time in seconds between ! calculations of depth-space diagnostics. Making this ! larger than DT_THERM reduces the performance penalty ! of regridding to depth online. INTERPOLATE_P_SURF = False ! [Boolean] default = False ! If true, linearly interpolate the surface pressure ! over the coupling time step, using the specified value ! at the end of the step. DTBT_RESET_PERIOD = 0.0 ! [s] default = 2.88E+04 ! 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. FRAZIL = True ! [Boolean] default = False ! If true, water freezes if it gets too cold, and the ! the accumulated heat deficit is returned in the ! surface state. FRAZIL is only used if ! ENABLE_THERMODYNAMICS is true. DO_GEOTHERMAL = True ! [Boolean] default = False ! If true, apply geothermal heating. BOUND_SALINITY = True ! [Boolean] default = False ! If true, limit salinity to being positive. (The sea-ice ! model may ask for more salt than is available and ! drive the salinity negative otherwise.) C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a ! constant. This is only used if ENABLE_THERMODYNAMICS is ! true. The default value is from the TEOS-10 definition ! of conservative temperature. P_REF = 2.0E+07 ! [Pa] default = 2.0E+07 ! The pressure that is used for calculating the coordinate ! density. (1 Pa = 1e4 dbar, so 2e7 is commonly used.) ! This is only used if USE_EOS and ENABLE_THERMODYNAMICS ! are true. FIRST_DIRECTION = 0 ! default = 0 ! An integer that indicates which direction goes first ! in parts of the code that use directionally split ! updates, with even numbers (or 0) used for x- first ! and odd numbers used for y-first. CHECK_BAD_SURFACE_VALS = True ! [Boolean] default = False ! If true, check the surface state for ridiculous values. BAD_VAL_SSH_MAX = 20.0 ! [m] default = 20.0 ! The value of SSH above which a bad value message is ! triggered, if CHECK_BAD_SURFACE_VALS is true. BAD_VAL_SSS_MAX = 45.0 ! [PPT] default = 45.0 ! The value of SSS above which a bad value message is ! triggered, if CHECK_BAD_SURFACE_VALS is true. BAD_VAL_SST_MAX = 45.0 ! [deg C] default = 45.0 ! The value of SST above which a bad value message is ! triggered, if CHECK_BAD_SURFACE_VALS is true. BAD_VAL_SST_MIN = -2.1 ! [deg C] default = -2.1 ! The value of SST below which a bad value message is ! triggered, if CHECK_BAD_SURFACE_VALS is true. BAD_VAL_COLUMN_THICKNESS = 0.0 ! [m] default = 0.0 ! The value of column thickness below which a bad value message is ! triggered, if CHECK_BAD_SURFACE_VALS is true. SAVE_INITIAL_CONDS = True ! [Boolean] default = False ! If true, write the initial conditions to a file given ! by IC_OUTPUT_FILE. IC_OUTPUT_FILE = "MOM_IC" ! default = "MOM_IC" ! The file into which to write the initial conditions. WRITE_GEOM = 1 ! default = 1 ! If =0, never write the geometry and vertical grid files. ! If =1, write the geometry and vertical grid files only for ! a new simulation. If =2, always write the geometry and ! vertical grid files. Other values are invalid. ENSEMBLE_OCEAN = False ! [Boolean] default = False ! If False, The model is being run in serial mode as a single realization. ! If True, The current model realization is part of a larger ensemble ! and at the end of step MOM, we will perform a gather of the ensemble ! members for statistical evaluation and/or data assimilation. ! === module MOM_domains === REENTRANT_X = True ! [Boolean] default = True ! If true, the domain is zonally reentrant. REENTRANT_Y = False ! [Boolean] default = False ! If true, the domain is meridionally reentrant. TRIPOLAR_N = True ! [Boolean] default = False ! Use tripolar connectivity at the northern edge of the ! domain. With TRIPOLAR_N, NIGLOBAL must be even. NIGLOBAL = 120 ! ! 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 = 84 ! ! 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_hor_index === ! Sets the horizontal array index types. ! === module MOM_verticalGrid === ! Parameters providing information about the vertical grid. G_EARTH = 9.8 ! [m s-2] default = 9.8 ! The gravitational acceleration of the Earth. RHO_0 = 1035.0 ! [kg m-3] default = 1035.0 ! The mean ocean density used with BOUSSINESQ true to ! calculate accelerations and the mass for conservation ! properties, or with BOUSSINSEQ false to convert some ! parameters from vertical units of m to kg m-2. BOUSSINESQ = True ! [Boolean] default = True ! If true, make the Boussinesq approximation. ANGSTROM = 1.0E-10 ! [m] default = 1.0E-10 ! The minumum layer thickness, usually one-Angstrom. H_TO_M = 1.0 ! [m H-1] default = 1.0 ! A constant that translates the model's internal ! units of thickness into m. NK = 28 ! [nondim] ! The number of model layers. ! === module MOM_fixed_initialization === INPUTDIR = "INPUT" ! default = "." ! The directory in which input files are found. ! === module MOM_grid_init === GRID_CONFIG = "mosaic" ! ! 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. GRID_FILE = "ocean_hgrid.nc" ! ! Name of the file from which to read horizontal grid data. USE_TRIPOLAR_GEOLONB_BUG = False ! [Boolean] default = True ! If true, use older code that incorrectly sets the longitude ! in some points along the tripolar fold to be off by 360 degrees. TOPO_CONFIG = "file" ! ! 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. ! benchmark - use the benchmark test case topography. ! Neverland - use the Neverland 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. TOPO_FILE = "topog.nc" ! default = "topog.nc" ! The file from which the bathymetry is read. TOPO_VARNAME = "depth" ! default = "depth" ! The name of the bathymetry variable in TOPO_FILE. TOPO_EDITS_FILE = "" ! default = "" ! The file from which to read a list of i,j,z topography overrides. MAXIMUM_DEPTH = 6000.0 ! [m] ! The maximum depth of the ocean. MINIMUM_DEPTH = 0.0 ! [m] default = 0.0 ! If MASKING_DEPTH is unspecified, then anything shallower than ! MINIMUM_DEPTH is assumed to be land and all fluxes are masked out. ! If MASKING_DEPTH is specified, then all depths shallower than ! MINIMUM_DEPTH but deeper than MASKING_DEPTH are rounded to MINIMUM_DEPTH. ! === module MOM_open_boundary === ! Controls where open boundaries are located, what kind of boundary condition to impose, and what data to apply, if any. OBC_NUMBER_OF_SEGMENTS = 0 ! default = 0 ! The number of open boundary segments. MASKING_DEPTH = -9999.0 ! [m] default = -9999.0 ! The depth below which to mask points as land points, for which all ! fluxes are zeroed out. MASKING_DEPTH is ignored if negative. CHANNEL_CONFIG = "list" ! default = "none" ! A parameter that determines which set of channels are ! restricted to specific widths. Options are: ! none - All channels have the grid width. ! global_1deg - Sets 16 specific channels appropriate ! for a 1-degree model, as used in CM2G. ! list - Read the channel locations and widths from a ! text file, like MOM_channel_list in the MOM_SIS ! test case. ! file - Read open face widths everywhere from a ! NetCDF file on the model grid. CHANNEL_LIST_FILE = "MOM_channel_list" ! default = "MOM_channel_list" ! The file from which the list of narrowed channels is read. CHANNEL_LIST_360_LON_CHECK = True ! [Boolean] default = True ! If true, the channel configuration list works for any ! longitudes in the range of -360 to 360. ROTATION = "2omegasinlat" ! default = "2omegasinlat" ! This specifies how the Coriolis parameter is specified: ! 2omegasinlat - Use twice the planetary rotation rate ! times the sine of latitude. ! betaplane - Use a beta-plane or f-plane. ! USER - call a user modified routine. OMEGA = 7.2921E-05 ! [s-1] default = 7.2921E-05 ! The rotation rate of the earth. GRID_ROTATION_ANGLE_BUGS = False ! [Boolean] default = True ! If true, use an older algorithm to calculate the sine and ! cosines needed rotate between grid-oriented directions and ! true north and east. Differences arise at the tripolar fold. ! === module MOM_tracer_registry === ! === module MOM_EOS === EQN_OF_STATE = "WRIGHT" ! default = "WRIGHT" ! EQN_OF_STATE determines which ocean equation of state ! should be used. Currently, the valid choices are ! "LINEAR", "UNESCO", "WRIGHT", "NEMO" and "TEOS10". ! This is only used if USE_EOS is true. EOS_QUADRATURE = False ! [Boolean] default = False ! If true, always use the generic (quadrature) code ! code for the integrals of density. TFREEZE_FORM = "LINEAR" ! default = "LINEAR" ! TFREEZE_FORM determines which expression should be ! used for the freezing point. Currently, the valid ! choices are "LINEAR", "MILLERO_78", "TEOS10" TFREEZE_S0_P0 = 0.0 ! [deg C] default = 0.0 ! When TFREEZE_FORM=LINEAR, ! this is the freezing potential temperature at ! S=0, P=0. DTFREEZE_DS = -0.054 ! [deg C PSU-1] default = -0.054 ! When TFREEZE_FORM=LINEAR, ! this is the derivative of the freezing potential ! temperature with salinity. DTFREEZE_DP = 0.0 ! [deg C Pa-1] default = 0.0 ! When TFREEZE_FORM=LINEAR, ! this is the derivative of the freezing potential ! temperature with pressure. ! === module MOM_restart === PARALLEL_RESTARTFILES = False ! [Boolean] default = False ! If true, each processor writes its own restart file, ! otherwise a single restart file is generated RESTARTFILE = "MOM.res" ! default = "MOM.res" ! The name-root of the restart file. LARGE_FILE_SUPPORT = True ! [Boolean] default = True ! If true, use the file-size limits with NetCDF large ! file support (4Gb), otherwise the limit is 2Gb. MAX_FIELDS = 100 ! default = 100 ! The maximum number of restart fields that can be used. RESTART_CHECKSUMS_REQUIRED = True ! [Boolean] default = True ! If true, require the restart checksums to match and error out otherwise. ! Users may want to avoid this comparison if for example the restarts are ! made from a run with a different mask_table than the current run, ! in which case the checksums will not match and cause crash. ! === module MOM_tracer_flow_control === USE_USER_TRACER_EXAMPLE = False ! [Boolean] default = False ! If true, use the USER_tracer_example tracer package. USE_DOME_TRACER = False ! [Boolean] default = False ! If true, use the DOME_tracer tracer package. USE_ISOMIP_TRACER = False ! [Boolean] default = False ! If true, use the ISOMIP_tracer tracer package. USE_IDEAL_AGE_TRACER = True ! [Boolean] default = False ! If true, use the ideal_age_example tracer package. USE_REGIONAL_DYES = False ! [Boolean] default = False ! If true, use the regional_dyes tracer package. USE_OIL_TRACER = False ! [Boolean] default = False ! If true, use the oil_tracer tracer package. USE_ADVECTION_TEST_TRACER = False ! [Boolean] default = False ! If true, use the advection_test_tracer tracer package. USE_OCMIP2_CFC = False ! [Boolean] default = False ! If true, use the MOM_OCMIP2_CFC tracer package. USE_generic_tracer = False ! [Boolean] default = False ! If true and _USE_GENERIC_TRACER is defined as a ! preprocessor macro, use the MOM_generic_tracer packages. USE_PSEUDO_SALT_TRACER = False ! [Boolean] default = False ! If true, use the pseudo salt tracer, typically run as a diagnostic. USE_BOUNDARY_IMPULSE_TRACER = False ! [Boolean] default = False ! If true, use the boundary impulse tracer. USE_DYED_OBC_TRACER = False ! [Boolean] default = False ! If true, use the dyed_obc_tracer tracer package. ! === module ideal_age_example === DO_IDEAL_AGE = True ! [Boolean] default = True ! If true, use an ideal age tracer that is set to 0 age ! in the mixed layer and ages at unit rate in the interior. DO_IDEAL_VINTAGE = False ! [Boolean] default = False ! If true, use an ideal vintage tracer that is set to an ! exponentially increasing value in the mixed layer and ! is conserved thereafter. DO_IDEAL_AGE_DATED = False ! [Boolean] default = False ! If true, use an ideal age tracer that is everywhere 0 ! before IDEAL_AGE_DATED_START_YEAR, but the behaves like ! the standard ideal age tracer - i.e. is set to 0 age in ! the mixed layer and ages at unit rate in the interior. AGE_IC_FILE = "" ! default = "" ! The file in which the age-tracer initial values can be ! found, or an empty string for internal initialization. AGE_IC_FILE_IS_Z = False ! [Boolean] default = False ! If true, AGE_IC_FILE is in depth space, not layer space TRACERS_MAY_REINIT = False ! [Boolean] default = False ! If true, tracers may go through the initialization code ! if they are not found in the restart files. Otherwise ! it is a fatal error if the tracers are not found in the ! restart files of a restarted run. ! === module MOM_coord_initialization === COORD_CONFIG = "file" ! ! 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 = 9.8 ! [m s-2] default = 9.8 ! The reduced gravity at the free surface. COORD_FILE = "Layer_coord28.nc" ! ! The file from which the coordinate densities are read. COORD_VAR = "Layer" ! default = "Layer" ! The variable in COORD_FILE that is to be used for the ! coordinate densities. REMAP_UV_USING_OLD_ALG = True ! [Boolean] default = True ! If true, uses the old remapping-via-a-delta-z method for ! remapping u and v. If false, uses the new method that remaps ! between grids described by an old and new thickness. REGRIDDING_COORDINATE_MODE = "HYCOM1" ! default = "LAYER" ! Coordinate mode for vertical regridding. ! Choose among the following possibilities: ! LAYER - Isopycnal or stacked shallow water layers ! ZSTAR, Z* - stetched geopotential z* ! SIGMA_SHELF_ZSTAR - stetched geopotential z* ignoring shelf ! SIGMA - terrain following coordinates ! RHO - continuous isopycnal ! HYCOM1 - HyCOM-like hybrid coordinate ! SLIGHT - stretched coordinates above continuous isopycnal ! ADAPTIVE - optimize for smooth neutral density surfaces REGRIDDING_COORDINATE_UNITS = "m" ! default = "m" ! Units of the regridding coordinuate. INTERPOLATION_SCHEME = "P1M_H2" ! default = "P1M_H2" ! This sets the interpolation scheme to use to ! determine the new grid. These parameters are ! only relevant when REGRIDDING_COORDINATE_MODE is ! set to a function of state. Otherwise, it is not ! used. It can be one of the following schemes: ! P1M_H2 (2nd-order accurate) ! P1M_H4 (2nd-order accurate) ! P1M_IH4 (2nd-order accurate) ! PLM (2nd-order accurate) ! PPM_H4 (3rd-order accurate) ! PPM_IH4 (3rd-order accurate) ! P3M_IH4IH3 (4th-order accurate) ! P3M_IH6IH5 (4th-order accurate) ! PQM_IH4IH3 (4th-order accurate) ! PQM_IH6IH5 (5th-order accurate) BOUNDARY_EXTRAPOLATION = False ! [Boolean] default = False ! When defined, a proper high-order reconstruction ! scheme is used within boundary cells rather ! than PCM. E.g., if PPM is used for remapping, a ! PPM reconstruction will also be used within ! boundary cells. ALE_COORDINATE_CONFIG = "HYBRID:HYCOM_28layer.nc,sigma2,dz" ! default = "UNIFORM" ! Determines how to specify the coordinate ! resolution. Valid options are: ! PARAM - use the vector-parameter ALE_RESOLUTION ! UNIFORM[:N] - uniformly distributed ! FILE:string - read from a file. The string specifies ! the filename and variable name, separated ! by a comma or space, e.g. FILE:lev.nc,dz ! or FILE:lev.nc,interfaces=zw ! WOA09[:N] - the WOA09 vertical grid (approximately) ! FNC1:string - FNC1:dz_min,H_total,power,precision ! HYBRID:string - read from a file. The string specifies ! the filename and two variable names, separated ! by a comma or space, for sigma-2 and dz. e.g. ! HYBRID:vgrid.nc,sigma2,dz !ALE_RESOLUTION = 8*10.0, 11.390121459960938, 21.074295043945312, 33.29133605957031, 53.313201904296875, 75.147705078125, 103.85211181640625, 133.24017333984375, 168.200439453125, 202.406982421875, 240.640625, 276.502197265625, 314.73583984375, 348.9423828125, 383.90234375, 413.29052734375, 441.9951171875, 463.82958984375, 483.85205078125, 496.068359375, 505.7529296875 ! [m] ! The distribution of vertical resolution for the target ! grid used for Eulerian-like coordinates. For example, ! in z-coordinate mode, the parameter is a list of level ! thicknesses (in m). In sigma-coordinate mode, the list ! is of non-dimensional fractions of the water column. !TARGET_DENSITIES = 999.5, 1028.0, 1029.14, 1029.7544, 1030.3432, 1030.9064, 1031.444, 1031.956, 1032.4424, 1032.9032, 1033.3384, 1033.748, 1034.132, 1034.4904, 1034.8232, 1035.1304, 1035.412, 1035.668, 1035.8984, 1036.1032, 1036.2824, 1036.436, 1036.564, 1036.689, 1036.814, 1036.939, 1037.064, 1037.189, 1038.0 ! [m] ! HYBRID target densities for itnerfaces REGRID_COMPRESSIBILITY_FRACTION = 0.0 ! [not defined] default = 0.0 ! When interpolating potential density profiles we can add ! some artificial compressibility solely to make homogenous ! regions appear stratified. MIN_THICKNESS = 0.001 ! [m] default = 0.001 ! When regridding, this is the minimum layer ! thickness allowed. MAXIMUM_INT_DEPTH_CONFIG = "NONE" ! default = "NONE" ! Determines how to specify the maximum interface depths. ! Valid options are: ! NONE - there are no maximum interface depths ! PARAM - use the vector-parameter MAXIMUM_INTERFACE_DEPTHS ! FILE:string - read from a file. The string specifies ! the filename and variable name, separated ! by a comma or space, e.g. FILE:lev.nc,Z ! FNC1:string - FNC1:dz_min,H_total,power,precision MAX_LAYER_THICKNESS_CONFIG = "NONE" ! default = "NONE" ! Determines how to specify the maximum layer thicknesses. ! Valid options are: ! NONE - there are no maximum layer thicknesses ! PARAM - use the vector-parameter MAX_LAYER_THICKNESS ! FILE:string - read from a file. The string specifies ! the filename and variable name, separated ! by a comma or space, e.g. FILE:lev.nc,Z ! FNC1:string - FNC1:dz_min,H_total,power,precision REMAPPING_SCHEME = "PPM_H4" ! default = "PLM" ! This sets the reconstruction scheme used ! for vertical remapping for all variables. ! It can be one of the following schemes: ! PCM (1st-order accurate) ! PLM (2nd-order accurate) ! PPM_H4 (3rd-order accurate) ! PPM_IH4 (3rd-order accurate) ! PQM_IH4IH3 (4th-order accurate) ! PQM_IH6IH5 (5th-order accurate) FATAL_CHECK_RECONSTRUCTIONS = False ! [Boolean] default = False ! If true, cell-by-cell reconstructions are checked for ! consistency and if non-monotonicty or an inconsistency is ! detected then a FATAL error is issued. FATAL_CHECK_REMAPPING = False ! [Boolean] default = False ! If true, the results of remapping are checked for ! conservation and new extrema and if an inconsistency is ! detected then a FATAL error is issued. REMAP_BOUND_INTERMEDIATE_VALUES = False ! [Boolean] default = False ! If true, the values on the intermediate grid used for remapping ! are forced to be bounded, which might not be the case due to ! round off. REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are ! extrapolated instead of piecewise constant REMAP_AFTER_INITIALIZATION = True ! [Boolean] default = True ! If true, applies regridding and remapping immediately after ! initialization so that the state is ALE consistent. This is a ! legacy step and should not be needed if the initialization is ! consistent with the coordinate mode. REGRID_TIME_SCALE = 0.0 ! [s] default = 0.0 ! The time-scale used in blending between the current (old) grid ! and the target (new) grid. A short time-scale favors the target ! grid (0. or anything less than DT_THERM) has no memory of the old ! grid. A very long time-scale makes the model more Lagrangian. REGRID_FILTER_SHALLOW_DEPTH = 0.0 ! [m] default = 0.0 ! The depth above which no time-filtering is applied. Above this depth ! final grid exactly matches the target (new) grid. REGRID_FILTER_DEEP_DEPTH = 0.0 ! [m] default = 0.0 ! The depth below which full time-filtering is applied with time-scale ! REGRID_TIME_SCALE. Between depths REGRID_FILTER_SHALLOW_DEPTH and ! REGRID_FILTER_SHALLOW_DEPTH the filter wieghts adopt a cubic profile. ! === module MOM_grid === ! Parameters providing information about the lateral grid. ! === module MOM_state_initialization === SPONGE = False ! [Boolean] default = False ! If true, sponges may be applied anywhere in the domain. ! The exact location and properties of those sponges are ! specified via SPONGE_CONFIG. ! === module MOM_diag_mediator === NUM_DIAG_COORDS = 2 ! default = 1 ! The number of diagnostic vertical coordinates to use. ! For each coordinate, an entry in DIAG_COORDS must be provided. DIAG_COORDS = "z Z ZSTAR", "rho RHO RHO" ! ! A list of string tuples associating diag_table modules to ! a coordinate definition used for diagnostics. Each string ! is of the form "MODULE_SUFFIX,PARAMETER_SUFFIX,COORDINATE_NAME". DIAG_MISVAL = 1.0E+20 ! [not defined] default = 1.0E+20 ! Set the default missing value to use for diagnostics. DIAG_AS_CHKSUM = False ! [Boolean] default = False ! Instead of writing diagnostics to the diag manager, write ! a textfile containing the checksum (bitcount) of the array. AVAILABLE_DIAGS_FILE = "available_diags.000000" ! default = "available_diags.000000" ! A file into which to write a list of all available ! ocean diagnostics that can be included in a diag_table. DIAG_COORD_DEF_Z = "FILE:vgrid_28.nc,dz" ! default = "WOA09" ! Determines how to specify the coordinate ! resolution. Valid options are: ! PARAM - use the vector-parameter DIAG_COORD_RES_Z ! UNIFORM[:N] - uniformly distributed ! FILE:string - read from a file. The string specifies ! the filename and variable name, separated ! by a comma or space, e.g. FILE:lev.nc,dz ! or FILE:lev.nc,interfaces=zw ! WOA09[:N] - the WOA09 vertical grid (approximately) ! FNC1:string - FNC1:dz_min,H_total,power,precision ! HYBRID:string - read from a file. The string specifies ! the filename and two variable names, separated ! by a comma or space, for sigma-2 and dz. e.g. ! HYBRID:vgrid.nc,sigma2,dz DIAG_COORD_DEF_RHO = "RFNC1:28,999.5,1028,1028.5,8.,1038.,0.0078125" ! default = "WOA09" ! Determines how to specify the coordinate ! resolution. Valid options are: ! PARAM - use the vector-parameter DIAG_COORD_RES_RHO ! UNIFORM[:N] - uniformly distributed ! FILE:string - read from a file. The string specifies ! the filename and variable name, separated ! by a comma or space, e.g. FILE:lev.nc,dz ! or FILE:lev.nc,interfaces=zw ! WOA09[:N] - the WOA09 vertical grid (approximately) ! FNC1:string - FNC1:dz_min,H_total,power,precision ! HYBRID:string - read from a file. The string specifies ! the filename and two variable names, separated ! by a comma or space, for sigma-2 and dz. e.g. ! HYBRID:vgrid.nc,sigma2,dz ! === module MOM_MEKE === USE_MEKE = True ! [Boolean] default = False ! If true, turns on the MEKE scheme which calculates ! a sub-grid mesoscale eddy kinetic energy budget. MEKE_DAMPING = 0.0 ! [s-1] default = 0.0 ! The local depth-indepented MEKE dissipation rate. MEKE_CD_SCALE = 0.0 ! [nondim] default = 0.0 ! The ratio of the bottom eddy velocity to the column mean ! eddy velocity, i.e. sqrt(2*MEKE). This should be less than 1 ! to account for the surface intensification of MEKE. MEKE_CB = 25.0 ! [nondim] default = 25.0 ! A coefficient in the expression for the ratio of bottom projected ! eddy energy and mean column energy (see Jansen et al. 2015). MEKE_MIN_GAMMA2 = 1.0E-04 ! [nondim] default = 1.0E-04 ! The minimum allowed value of gamma_b^2. MEKE_CT = 50.0 ! [nondim] default = 50.0 ! A coefficient in the expression for the ratio of barotropic ! eddy energy and mean column energy (see Jansen et al. 2015). MEKE_GMCOEFF = 1.0 ! [nondim] default = -1.0 ! The efficiency of the conversion of potential energy ! into MEKE by the thickness mixing parameterization. ! If MEKE_GMCOEFF is negative, this conversion is not ! used or calculated. MEKE_FRCOEFF = -1.0 ! [nondim] default = -1.0 ! The efficiency of the conversion of mean energy into ! MEKE. If MEKE_FRCOEFF is negative, this conversion ! is not used or calculated. MEKE_BGSRC = 0.0 ! [W kg-1] default = 0.0 ! A background energy source for MEKE. MEKE_KH = -1.0 ! [m2 s-1] default = -1.0 ! A background lateral diffusivity of MEKE. ! Use a negative value to not apply lateral diffusion to MEKE. MEKE_K4 = -1.0 ! [m4 s-1] default = -1.0 ! A lateral bi-harmonic diffusivity of MEKE. ! Use a negative value to not apply bi-harmonic diffusion to MEKE. MEKE_DTSCALE = 1.0 ! [nondim] default = 1.0 ! A scaling factor to accelerate the time evolution of MEKE. MEKE_KHCOEFF = 1.0 ! [nondim] default = 1.0 ! A scaling factor in the expression for eddy diffusivity ! which is otherwise proportional to the MEKE velocity- ! scale times an eddy mixing-length. This factor ! must be >0 for MEKE to contribute to the thickness/ ! and tracer diffusivity in the rest of the model. MEKE_USCALE = 0.0 ! [m s-1] default = 0.0 ! The background velocity that is combined with MEKE to ! calculate the bottom drag. MEKE_VISC_DRAG = True ! [Boolean] default = True ! If true, use the vertvisc_type to calculate the bottom ! drag acting on MEKE. MEKE_KHTH_FAC = 1.0 ! [nondim] default = 0.0 ! A factor that maps MEKE%Kh to KhTh. MEKE_KHTR_FAC = 1.0 ! [nondim] default = 0.0 ! A factor that maps MEKE%Kh to KhTr. MEKE_KHMEKE_FAC = 0.0 ! [nondim] default = 0.0 ! A factor that maps MEKE%Kh to Kh for MEKE itself. MEKE_OLD_LSCALE = False ! [Boolean] default = False ! If true, use the old formula for length scale which is ! a function of grid spacing and deformation radius. MEKE_RD_MAX_SCALE = False ! [nondim] default = False ! If true, the length scale used by MEKE is the minimum of ! the deformation radius or grid-spacing. Only used if ! MEKE_OLD_LSCALE=True MEKE_VISCOSITY_COEFF = 0.0 ! [nondim] default = 0.0 ! If non-zero, is the scaling coefficient in the expression for ! viscosity used to parameterize lateral momentum mixing by ! unresolved eddies represented by MEKE. Can be negative to ! represent backscatter from the unresolved eddies. MEKE_FIXED_MIXING_LENGTH = 0.0 ! [m] default = 0.0 ! If positive, is a fixed length contribution to the expression ! for mixing length used in MEKE-derived diffusiviity. MEKE_ALPHA_DEFORM = 0.0 ! [nondim] default = 0.0 ! If positive, is a coefficient weighting the deformation scale ! in the expression for mixing length used in MEKE-derived diffusiviity. MEKE_ALPHA_RHINES = 0.05 ! [nondim] default = 0.05 ! If positive, is a coefficient weighting the Rhines scale ! in the expression for mixing length used in MEKE-derived diffusiviity. MEKE_ALPHA_EADY = 0.05 ! [nondim] default = 0.05 ! If positive, is a coefficient weighting the Eady length scale ! in the expression for mixing length used in MEKE-derived diffusiviity. MEKE_ALPHA_FRICT = 0.0 ! [nondim] default = 0.0 ! If positive, is a coefficient weighting the frictional arrest scale ! in the expression for mixing length used in MEKE-derived diffusiviity. MEKE_ALPHA_GRID = 0.0 ! [nondim] default = 0.0 ! If positive, is a coefficient weighting the grid-spacing as a scale ! in the expression for mixing length used in MEKE-derived diffusiviity. MEKE_COLD_START = False ! [Boolean] default = False ! If true, initialize EKE to zero. Otherwise a local equilibrium solution ! is used as an initial condition for EKE. MEKE_BACKSCAT_RO_C = 0.0 ! [nondim] default = 0.0 ! The coefficient in the Rossby number function for scaling the buharmonic ! frictional energy source. Setting to non-zero enables the Rossby number function. MEKE_BACKSCAT_RO_POW = 0.0 ! [nondim] default = 0.0 ! The power in the Rossby number function for scaling the biharmomnic ! frictional energy source. MEKE_ADVECTION_FACTOR = 0.0 ! [nondim] default = 0.0 ! A scale factor in front of advection of eddy energy. Zero turns advection off. ! Using unity would be normal but other values could accomodate a mismatch ! between the advecting barotropic flow and the vertical structure of MEKE. CDRAG = 0.003 ! [nondim] default = 0.003 ! CDRAG is the drag coefficient relating the magnitude of ! the velocity field to the bottom stress. ! === module MOM_lateral_mixing_coeffs === USE_VARIABLE_MIXING = True ! [Boolean] default = False ! If true, the variable mixing code will be called. This ! allows diagnostics to be created even if the scheme is ! not used. If KHTR_SLOPE_CFF>0 or KhTh_Slope_Cff>0, ! this is set to true regardless of what is in the ! parameter file. RESOLN_SCALED_KH = False ! [Boolean] default = False ! If true, the Laplacian lateral viscosity is scaled away ! when the first baroclinic deformation radius is well ! resolved. RESOLN_SCALED_KHTH = False ! [Boolean] default = False ! If true, the interface depth diffusivity is scaled away ! when the first baroclinic deformation radius is well ! resolved. RESOLN_SCALED_KHTR = False ! [Boolean] default = False ! If true, the epipycnal tracer diffusivity is scaled ! away when the first baroclinic deformation radius is ! well resolved. RESOLN_USE_EBT = False ! [Boolean] default = False ! If true, uses the equivalent barotropic wave speed instead ! of first baroclinic wave for calculating the resolution fn. KHTH_USE_EBT_STRUCT = False ! [Boolean] default = False ! If true, uses the equivalent barotropic structure ! as the vertical structure of thickness diffusivity. KHTH_SLOPE_CFF = 0.01 ! [nondim] default = 0.0 ! The nondimensional coefficient in the Visbeck formula ! for the interface depth diffusivity KHTR_SLOPE_CFF = 0.25 ! [nondim] default = 0.0 ! The nondimensional coefficient in the Visbeck formula ! for the epipycnal tracer diffusivity USE_STORED_SLOPES = True ! [Boolean] default = False ! If true, the isopycnal slopes are calculated once and ! stored for re-use. This uses more memory but avoids calling ! the equation of state more times than should be necessary. VISBECK_MAX_SLOPE = 0.0 ! [nondim] default = 0.0 ! If non-zero, is an upper bound on slopes used in the ! Visbeck formula for diffusivity. This does not affect the ! isopycnal slope calculation used within thickness diffusion. KD_SMOOTH = 1.0E-06 ! [not defined] default = 1.0E-06 ! A diapycnal diffusivity that is used to interpolate ! more sensible values of T & S into thin layers. VARMIX_KTOP = 2 ! [nondim] default = 2 ! The layer number at which to start vertical integration ! of S*N for purposes of finding the Eady growth rate. VISBECK_L_SCALE = 3.0E+04 ! [m] default = 0.0 ! The fixed length scale in the Visbeck formula. ! === module MOM_set_visc === BOTTOMDRAGLAW = True ! [Boolean] default = True ! If true, the bottom stress is calculated with a drag ! law of the form c_drag*|u|*u. The velocity magnitude ! may be an assumed value or it may be based on the ! actual velocity in the bottommost HBBL, depending on ! LINEAR_DRAG. CHANNEL_DRAG = True ! [Boolean] default = False ! If true, the bottom drag is exerted directly on each ! layer proportional to the fraction of the bottom it ! overlies. LINEAR_DRAG = False ! [Boolean] default = False ! If LINEAR_DRAG and BOTTOMDRAGLAW are defined the drag ! law is cdrag*DRAG_BG_VEL*u. DOUBLE_DIFFUSION = False ! [Boolean] default = False ! If true, increase diffusivitives for temperature or salt ! based on double-diffusive paramaterization from MOM4/KPP. PRANDTL_TURB = 1.0 ! [nondim] default = 1.0 ! The turbulent Prandtl number applied to shear ! instability. DYNAMIC_VISCOUS_ML = True ! [Boolean] default = False ! If true, use a bulk Richardson number criterion to ! determine the mixed layer thickness for viscosity. BULK_RI_ML_VISC = 0.05 ! [nondim] default = 0.05 ! The efficiency with which mean kinetic energy released ! by mechanically forced entrainment of the mixed layer ! is converted to turbulent kinetic energy. By default, ! BULK_RI_ML_VISC = BULK_RI_ML or 0. TKE_DECAY_VISC = 10.0 ! [nondim] default = 10.0 ! TKE_DECAY_VISC relates the vertical rate of decay of ! the TKE available for mechanical entrainment to the ! natural Ekman depth for use in calculating the dynamic ! mixed layer viscosity. By default, ! TKE_DECAY_VISC = TKE_DECAY or 0. ML_OMEGA_FRAC = 1.0 ! [nondim] default = 0.0 ! When setting the decay scale for turbulence, use this ! fraction of the absolute rotation rate blended with the ! local value of f, as sqrt((1-of)*f^2 + of*4*omega^2). HBBL = 10.0 ! [m] ! The thickness of a bottom boundary layer with a ! viscosity of KVBBL 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_USE_EOS = True ! [Boolean] default = False ! If true, use the equation of state in determining the ! properties of the bottom boundary layer. Otherwise use ! the layer target potential densities. 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. HTBL_SHELF_MIN = 0.1 ! [m] default = 0.1 ! The minimum top boundary layer thickness that can be ! used with BOTTOMDRAGLAW. This might be ! Kv / (cdrag * drag_bg_vel) to give Kv as the minimum ! near-top viscosity. HTBL_SHELF = 10.0 ! [m] default = 10.0 ! The thickness over which near-surface velocities are ! averaged for the drag law under an ice shelf. By ! default this is the same as HBBL KV = 1.0E-05 ! [m2 s-1] ! The background kinematic viscosity in the interior. ! The molecular value, ~1e-6 m2 s-1, may be used. ADD_KV_SLOW = False ! [Boolean] default = False ! If true, the background vertical viscosity in the interior ! (i.e., tidal + background + shear + convenction) is addded ! when computing the coupling coefficient. The purpose of this ! flag is to be able to recover previous answers and it will likely ! be removed in the future since this option should always be true. KV_BBL_MIN = 1.0E-05 ! [m2 s-1] default = 1.0E-05 ! The minimum viscosities in the bottom boundary layer. KV_TBL_MIN = 1.0E-05 ! [m2 s-1] default = 1.0E-05 ! The minimum viscosities in the top boundary layer. SMAG_CONST_CHANNEL = 0.15 ! [nondim] default = 0.15 ! The nondimensional Laplacian Smagorinsky constant used ! in calculating the channel drag if it is enabled. The ! default is to use the same value as SMAG_LAP_CONST if ! it is defined, or 0.15 if it is not. The value used is ! also 0.15 if the specified value is negative. TIDES = False ! [Boolean] default = False ! If true, apply tidal momentum forcing. BE = 0.6 ! [nondim] default = 0.6 ! If SPLIT is true, BE determines the relative weighting ! of a 2nd-order Runga-Kutta baroclinic time stepping ! scheme (0.5) and a backward Euler scheme (1) that is ! used for the Coriolis and inertial terms. BE may be ! from 0.5 to 1, but instability may occur near 0.5. ! BE is also applicable if SPLIT is false and USE_RK2 ! is true. BEGW = 0.0 ! [nondim] default = 0.0 ! If SPLIT is true, BEGW is a number from 0 to 1 that ! controls the extent to which the treatment of gravity ! waves is forward-backward (0) or simulated backward ! Euler (1). 0 is almost always used. ! If SPLIT is false and USE_RK2 is true, BEGW can be ! between 0 and 0.5 to damp gravity waves. SPLIT_BOTTOM_STRESS = False ! [Boolean] default = False ! If true, provide the bottom stress calculated by the ! vertical viscosity to the barotropic solver. BT_USE_LAYER_FLUXES = True ! [Boolean] default = True ! If true, use the summed layered fluxes plus an ! adjustment due to the change in the barotropic velocity ! in the barotropic continuity equation. ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" ! CONTINUITY_SCHEME selects the discretization for the ! continuity solver. The only valid value currently is: ! PPM - use a positive-definite (or monotonic) ! piecewise parabolic reconstruction solver. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False ! If true, CONTINUITY_PPM uses the Colella and Woodward ! monotonic limiter. The default (false) is to use a ! simple positive definite limiter. SIMPLE_2ND_PPM_CONTINUITY = False ! [Boolean] default = False ! If true, CONTINUITY_PPM uses a simple 2nd order ! (arithmetic mean) interpolation of the edge values. ! This may give better PV conservation propterties. While ! it formally reduces the accuracy of the continuity ! solver itself in the strongly advective limit, it does ! not reduce the overall order of accuracy of the dynamic ! core. UPWIND_1ST_CONTINUITY = False ! [Boolean] default = False ! If true, CONTINUITY_PPM becomes a 1st-order upwind ! continuity solver. This scheme is highly diffusive ! but may be useful for debugging or in single-column ! mode where its minimal stencil is useful. ETA_TOLERANCE = 1.0E-06 ! [m] default = 1.4E-09 ! 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 x ! than about 10^-15*MAXIMUM_DEPTH. ETA_TOLERANCE_AUX = 1.0E-06 ! [m] default = 1.0E-06 ! The tolerance for free-surface height discrepancies ! between the barotropic solution and the sum of the ! layer thicknesses when calculating the auxiliary ! corrected velocities. By default, this is the same as ! ETA_TOLERANCE, but can be made larger for efficiency. VELOCITY_TOLERANCE = 1.0E-04 ! [m s-1] default = 3.0E+08 ! The tolerance for barotropic velocity discrepancies ! between the barotropic solution and the sum of the ! layer thicknesses. CONT_PPM_AGGRESS_ADJUST = False ! [Boolean] default = False ! If true, allow the adjusted velocities to have a ! relative CFL change up to 0.5. CONT_PPM_VOLUME_BASED_CFL = False ! [Boolean] default = False ! If true, use the ratio of the open face lengths to the ! tracer cell areas when estimating CFL numbers. The ! default is set by CONT_PPM_AGGRESS_ADJUST. CONTINUITY_CFL_LIMIT = 0.5 ! [nondim] default = 0.5 ! The maximum CFL of the adjusted velocities. CONT_PPM_BETTER_ITER = True ! [Boolean] default = True ! If true, stop corrective iterations using a velocity ! based criterion and only stop if the iteration is ! better than all predecessors. CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True ! If true, use more appropriate limiting bounds for ! corrections in strongly viscous columns. CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity ! solver for use as the weights in the barotropic solver. ! Otherwise use the transport averaged areas. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False ! If true, no slip boundary conditions are used; otherwise ! free slip boundary conditions are assumed. The ! implementation of the free slip BCs on a C-grid is much ! cleaner than the no slip BCs. The use of free slip BCs ! is strongly encouraged, and no slip BCs are not used with ! the biharmonic viscosity. CORIOLIS_EN_DIS = False ! [Boolean] default = False ! If true, two estimates of the thickness fluxes are used ! to estimate the Coriolis term, and the one that ! dissipates energy relative to the other one is used. CORIOLIS_SCHEME = "SADOURNY75_ENERGY" ! default = "SADOURNY75_ENERGY" ! CORIOLIS_SCHEME selects the discretization for the ! Coriolis terms. Valid values are: ! SADOURNY75_ENERGY - Sadourny, 1975; energy cons. ! ARAKAWA_HSU90 - Arakawa & Hsu, 1990 ! SADOURNY75_ENSTRO - Sadourny, 1975; enstrophy cons. ! ARAKAWA_LAMB81 - Arakawa & Lamb, 1981; En. + Enst. ! ARAKAWA_LAMB_BLEND - A blend of Arakawa & Lamb with ! Arakawa & Hsu and Sadourny energy 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. KE_SCHEME = "KE_ARAKAWA" ! default = "KE_ARAKAWA" ! KE_SCHEME selects the discretization for acceleration ! due to the kinetic energy gradient. Valid values are: ! KE_ARAKAWA, KE_SIMPLE_GUDONOV, KE_GUDONOV PV_ADV_SCHEME = "PV_ADV_CENTERED" ! default = "PV_ADV_CENTERED" ! PV_ADV_SCHEME selects the discretization for PV ! advection. Valid values are: ! PV_ADV_CENTERED - centered (aka Sadourny, 75) ! PV_ADV_UPWIND1 - upwind, first order ! === module MOM_PressureForce === ANALYTIC_FV_PGF = True ! [Boolean] default = True ! If true the pressure gradient forces are calculated ! with a finite volume form that analytically integrates ! the equations of state in pressure to avoid any ! possibility of numerical thermobaric instability, as ! described in Adcroft et al., O. Mod. (2008). ! === module MOM_PressureForce_AFV === MASS_WEIGHT_IN_PRESSURE_GRADIENT = True ! [Boolean] default = False ! If true, use mass weighting when interpolating T/S for ! integrals near the bathymetry in AFV pressure gradient ! calculations. RECONSTRUCT_FOR_PRESSURE = True ! [Boolean] default = True ! If True, use vertical reconstruction of T & S within ! the integrals of the FV pressure gradient calculation. ! If False, use the constant-by-layer algorithm. ! The default is set by USE_REGRIDDING. PRESSURE_RECONSTRUCTION_SCHEME = 1 ! default = 1 ! Order of vertical reconstruction of T/S to use in the ! integrals within the FV pressure gradient calculation. 0: PCM or no reconstruction. ! 1: PLM reconstruction. ! 2: PPM reconstruction. BOUNDARY_EXTRAPOLATION_PRESSURE = True ! [Boolean] default = True ! If true, the reconstruction of T & S for pressure in ! boundary cells is extrapolated, rather than using PCM ! in these cells. If true, the same order polynomial is ! used as is used for the interior cells. ! === module MOM_hor_visc === LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 2.0E+04 ! [m2 s-1] default = 0.0 ! The background Laplacian horizontal viscosity. KH_BG_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum value allowed for Laplacian horizontal viscosity, KH. KH_VEL_SCALE = 0.05 ! [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. KH_SIN_LAT = 0.0 ! [m2 s-1] default = 0.0 ! The amplitude of a latidutinally-dependent background ! viscosity of the form KH_SIN_LAT*(SIN(LAT)**KH_PWR_OF_SINE). SMAGORINSKY_KH = False ! [Boolean] default = False ! If true, use a Smagorinsky nonlinear eddy viscosity. LEITH_KH = False ! [Boolean] default = False ! If true, use a Leith nonlinear eddy viscosity. MODIFIED_LEITH = False ! [Boolean] default = False ! If true, add a term to Leith viscosity which is ! proportional to the gradient of divergence. BOUND_KH = True ! [Boolean] default = True ! If true, the Laplacian coefficient is locally limited ! to be stable. BETTER_BOUND_KH = True ! [Boolean] default = True ! If true, the Laplacian coefficient is locally limited ! to be stable with a better bounding than just BOUND_KH. ANISOTROPIC_VISCOSITY = False ! [Boolean] default = False ! If true, allow anistropic viscosity in the Laplacian ! horizontal viscosity. BIHARMONIC = True ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. ! BIHARMONIC may be used with LAPLACIAN. AH = 0.0 ! [m4 s-1] default = 0.0 ! The background biharmonic horizontal viscosity. AH_VEL_SCALE = 0.05 ! [m s-1] default = 0.0 ! The velocity scale which is multiplied by the cube of ! the grid spacing to calculate the biharmonic viscosity. ! The final viscosity is the largest of this scaled ! viscosity, the Smagorinsky and Leith viscosities, and AH. SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy ! viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy ! viscosity. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited ! to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited ! to be stable with a better bounding than just BOUND_AH. SMAG_BI_CONST = 0.06 ! [nondim] default = 0.0 ! The nondimensional biharmonic Smagorinsky constant, ! typically 0.015 - 0.06. BOUND_CORIOLIS_BIHARM = True ! [Boolean] default = True ! If true use a viscosity that increases with the square ! of the velocity shears, so that the resulting viscous ! drag is of comparable magnitude to the Coriolis terms ! when the velocity differences between adjacent grid ! points is 0.5*BOUND_CORIOLIS_VEL. The default is the ! value of BOUND_CORIOLIS (or false). BOUND_CORIOLIS_VEL = 6.0 ! [m s-1] default = 6.0 ! The velocity scale at which BOUND_CORIOLIS_BIHARM causes ! the biharmonic drag to have comparable magnitude to the ! Coriolis acceleration. The default is set by MAXVEL. USE_LAND_MASK_FOR_HVISC = False ! [Boolean] default = False ! If true, use Use the land mask for the computation of thicknesses ! at velocity locations. This eliminates the dependence on arbitrary ! values over land or outside of the domain. Default is False in order to ! maintain answers with legacy experiments but should be changed to True ! for new experiments. HORVISC_BOUND_COEF = 0.8 ! [nondim] default = 0.8 ! The nondimensional coefficient of the ratio of the ! viscosity bounds to the theoretical maximum for ! stability without considering other terms. USE_KH_BG_2D = False ! [Boolean] default = False ! If true, read a file containing 2-d background harmonic ! viscosities. The final viscosity is the maximum of the other terms and this background value. ! === module MOM_vert_friction === DIRECT_STRESS = False ! [Boolean] default = False ! If true, the wind stress is distributed over the ! topmost HMIX_STRESS of fluid (like in HYCOM), and KVML ! may be set to a very small value. HARMONIC_VISC = False ! [Boolean] default = False ! If true, use the harmonic mean thicknesses for ! calculating the vertical viscosity. HARMONIC_BL_SCALE = 0.0 ! [nondim] default = 0.0 ! A scale to determine when water is in the boundary ! layers based solely on harmonic mean thicknesses for ! the purpose of determining the extent to which the ! thicknesses used in the viscosities are upwinded. HMIX_FIXED = 0.5 ! [m] ! The prescribed depth over which the near-surface ! viscosity and diffusivity are elevated when the bulk ! mixed layer is not used. KVML = 1.0E-05 ! [m2 s-1] default = 1.0E-05 ! The kinematic viscosity in the mixed layer. A typical ! value is ~1e-2 m2 s-1. KVML is not used if ! BULKMIXEDLAYER is true. The default is set by KV. MAXVEL = 6.0 ! [m s-1] default = 3.0E+08 ! The maximum velocity allowed before the velocity ! components are truncated. CFL_BASED_TRUNCATIONS = True ! [Boolean] default = True ! If true, base truncations on the CFL number, and not an ! absolute speed. CFL_TRUNCATE = 0.5 ! [nondim] default = 0.5 ! The value of the CFL number that will cause velocity ! components to be truncated; instability can occur past 0.5. CFL_REPORT = 0.5 ! [nondim] default = 0.5 ! The value of the CFL number that causes accelerations ! to be reported; the default is CFL_TRUNCATE. CFL_TRUNCATE_RAMP_TIME = 7200.0 ! [s] default = 0.0 ! The time over which the CFL trunction value is ramped ! up at the beginning of the run. CFL_TRUNCATE_START = 0.0 ! [nondim] default = 0.0 ! The start value of the truncation CFL number used when ! ramping up CFL_TRUNC. STOKES_MIXING_COMBINED = False ! [Boolean] default = False ! Flag to use Stokes drift Mixing via the Lagrangian ! current (Eulerian plus Stokes drift). ! Still needs work and testing, so not recommended for use. VEL_UNDERFLOW = 0.0 ! [m s-1] default = 0.0 ! A negligibly small velocity magnitude below which velocity ! components are set to 0. A reasonable value might be ! 1e-30 m/s, which is less than an Angstrom divided by ! the age of the universe. ! === module MOM_PointAccel === ! === 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_CONT_CORR_BOUNDS = True ! [Boolean] default = True ! If true, and BOUND_BT_CORRECTION is true, use the ! BT_cont_type variables to set limits determined by ! MAXCFL_BT_CONT on the CFL number of the velocites ! that are likely to be driven by the corrective mass fluxes. ADJUST_BT_CONT = False ! [Boolean] default = False ! If true, adjust the curve fit to the BT_cont type ! that is used by the barotropic solver to match the ! transport about which the flow is being linearized. GRADUAL_BT_ICS = False ! [Boolean] default = False ! If true, adjust the initial conditions for the ! barotropic solver to the values from the layered ! solution over a whole timestep instead of instantly. ! This is a decent approximation to the inclusion of ! sum(u dh_dt) while also correcting for truncation errors. BT_USE_VISC_REM_U_UH0 = False ! [Boolean] default = False ! If true, use the viscous remnants when estimating the ! barotropic velocities that were used to calculate uh0 ! and vh0. False is probably the better choice. USE_BT_CONT_TYPE = True ! [Boolean] default = True ! If true, use a structure with elements that describe ! effective face areas from the summed continuity solver ! as a function the barotropic flow in coupling between ! the barotropic and baroclinic flow. This is only used ! if SPLIT is true. NONLINEAR_BT_CONTINUITY = False ! [Boolean] default = False ! If true, use nonlinear transports in the barotropic ! continuity equation. This does not apply if ! USE_BT_CONT_TYPE is true. BT_PROJECT_VELOCITY = True ! [Boolean] default = False ! If true, step the barotropic velocity first and project ! out the velocity tendancy 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. DYNAMIC_SURFACE_PRESSURE = False ! [Boolean] default = False ! If true, add a dynamic pressure due to a viscous ice ! shelf, for instance. SADOURNY = True ! [Boolean] default = True ! If true, the Coriolis terms are discretized with the ! Sadourny (1975) energy conserving scheme, otherwise ! the Arakawa & Hsu scheme is used. If the internal ! deformation radius is not resolved, the Sadourny scheme ! should probably be used. BT_THICK_SCHEME = "FROM_BT_CONT" ! default = "FROM_BT_CONT" ! A string describing the scheme that is used to set the ! open face areas used for barotropic transport and the ! relative weights of the accelerations. Valid values are: ! ARITHMETIC - arithmetic mean layer thicknesses ! HARMONIC - harmonic mean layer thicknesses ! HYBRID (the default) - use arithmetic means for ! layers above the shallowest bottom, the harmonic ! mean for layers below, and a weighted average for ! layers that straddle that depth ! FROM_BT_CONT - use the average thicknesses kept ! in the h_u and h_v fields of the BT_cont_type BT_STRONG_DRAG = False ! [Boolean] default = False ! If true, use a stronger estimate of the retarding ! effects of strong bottom drag, by making it implicit ! with the barotropic time-step instead of implicit with ! the baroclinic time-step and dividing by the number of ! barotropic steps. BT_LINEAR_WAVE_DRAG = False ! [Boolean] default = False ! If true, apply a linear drag to the barotropic velocities, ! using rates set by lin_drag_u & _vdivided by the depth of ! the ocean. This was introduced to facilitate tide modeling. CLIP_BT_VELOCITY = False ! [Boolean] default = False ! If true, limit any velocity components that exceed ! CFL_TRUNCATE. This should only be used as a desperate ! debugging measure. MAXCFL_BT_CONT = 0.25 ! [nondim] default = 0.25 ! The maximum permitted CFL number associated with the ! barotropic accelerations from the summed velocities ! times the time-derivatives of thicknesses. DT_BT_FILTER = -0.25 ! [sec or nondim] default = -0.25 ! A time-scale over which the barotropic mode solutions ! are filtered, in seconds if positive, or as a fraction ! of DT if negative. When used this can never be taken to ! be longer than 2*dt. Set this to 0 to apply no filtering. G_BT_EXTRA = 0.0 ! [nondim] default = 0.0 ! A nondimensional factor by which gtot is enhanced. SSH_EXTRA = 10.0 ! [m] default = 10.0 ! An estimate of how much higher SSH might get, for use ! in calculating the safe external wave speed. The ! default is the minimum of 10 m or 5% of MAXIMUM_DEPTH. 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.0 ! [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. BT_USE_OLD_CORIOLIS_BRACKET_BUG = False ! [Boolean] default = False ! If True, use an order of operations that is not bitwise ! rotationally symmetric in the meridional Coriolis term of ! the barotropic solver. ! === module MOM_thickness_diffuse === KHTH = 0.0 ! [m2 s-1] default = 0.0 ! The background horizontal thickness diffusivity. KHTH_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum horizontal thickness diffusivity. KHTH_MAX = 800.0 ! [m2 s-1] default = 0.0 ! The maximum horizontal thickness diffusivity. KHTH_MAX_CFL = 0.8 ! [nondimensional] default = 0.8 ! The maximum value of the local diffusive CFL ratio that ! is permitted for the thickness diffusivity. 1.0 is the ! marginally unstable value in a pure layered model, but ! much smaller numbers (e.g. 0.1) seem to work better for ! ALE-based models. DETANGLE_INTERFACES = False ! [Boolean] default = False ! If defined add 3-d structured enhanced interface height ! diffusivities to horizonally smooth jagged layers. KHTH_SLOPE_MAX = 0.01 ! [nondim] default = 0.01 ! A slope beyond which the calculated isopycnal slope is ! not reliable and is scaled away. KHTH_USE_FGNV_STREAMFUNCTION = True ! [Boolean] default = False ! If true, use the streamfunction formulation of ! Ferrari et al., 2010, which effectively emphasizes ! graver vertical modes by smoothing in the vertical. FGNV_FILTER_SCALE = 1.0 ! [not defined] default = 1.0 ! A coefficient scaling the vertical smoothing term in the ! Ferrari et al., 2010, streamfunction formulation. FGNV_C_MIN = 0.0 ! [m s-1] default = 0.0 ! A minium wave speed used in the Ferrari et al., 2010, ! streamfunction formulation. FGNV_STRAT_FLOOR = 1.0E-15 ! [nondim] default = 1.0E-15 ! A floor for Brunt-Vasaila frequency in the Ferrari et al., 2010, ! streamfunction formulation, expressed as a fraction of planetary ! rotation, OMEGA. This should be tiny but non-zero to avoid degeneracy. ! === module MOM_mixed_layer_restrat === MIXEDLAYER_RESTRAT = True ! [Boolean] default = False ! If true, a density-gradient dependent re-stratifying ! flow is imposed in the mixed layer. Can be used in ALE mode ! without restriction but in layer mode can only be used if ! BULKMIXEDLAYER is true. FOX_KEMPER_ML_RESTRAT_COEF = 20.0 ! [nondim] default = 0.0 ! A nondimensional coefficient that is proportional to ! the ratio of the deformation radius to the dominant ! lengthscale of the submesoscale mixed layer ! instabilities, times the minimum of the ratio of the ! mesoscale eddy kinetic energy to the large-scale ! geostrophic kinetic energy or 1 plus the square of the ! grid spacing over the deformation radius, as detailed ! by Fox-Kemper et al. (2010) FOX_KEMPER_ML_RESTRAT_COEF2 = 0.0 ! [nondim] default = 0.0 ! As for FOX_KEMPER_ML_RESTRAT_COEF but used in a second application ! of the MLE restratification parameterization. MLE_FRONT_LENGTH = 0.0 ! [m] default = 0.0 ! If non-zero, is the frontal-length scale used to calculate the ! upscaling of buoyancy gradients that is otherwise represented ! by the parameter FOX_KEMPER_ML_RESTRAT_COEF. If MLE_FRONT_LENGTH is ! non-zero, it is recommended to set FOX_KEMPER_ML_RESTRAT_COEF=1.0. MLE_USE_PBL_MLD = False ! [Boolean] default = False ! If true, the MLE parameterization will use the mixed-layer ! depth provided by the active PBL parameterization. If false, ! MLE will estimate a MLD based on a density difference with the ! surface using the parameter MLE_DENSITY_DIFF. MLE_MLD_DECAY_TIME = 0.0 ! [s] default = 0.0 ! The time-scale for a running-mean filter applied to the mixed-layer ! depth used in the MLE restratification parameterization. When ! the MLD deepens below the current running-mean the running-mean ! is instantaneously set to the current MLD. MLE_MLD_DECAY_TIME2 = 0.0 ! [s] default = 0.0 ! The time-scale for a running-mean filter applied to the filtered ! mixed-layer depth used in a second MLE restratification parameterization. ! When the MLD deepens below the current running-mean the running-mean ! is instantaneously set to the current MLD. MLE_DENSITY_DIFF = 0.03 ! [kg/m3] default = 0.03 ! Density difference used to detect the mixed-layer ! depth used for the mixed-layer eddy parameterization ! by Fox-Kemper et al. (2010) MLE_TAIL_DH = 0.0 ! [nondim] default = 0.0 ! Fraction by which to extend the mixed-layer restratification ! depth used for a smoother stream function at the base of ! the mixed-layer. MLE_MLD_STRETCH = 1.0 ! [nondim] default = 1.0 ! A scaling coefficient for stretching/shrinking the MLD ! used in the MLE scheme. This simply multiplies MLD wherever used. MLE_USE_MLD_AVE_BUG = False ! [Boolean] default = False ! If true, do not account for MLD mismatch to interface positions. DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 ! The lower fraction of water column over which N2 is limited as monotonic ! for the purposes of calculating the equivalent barotropic wave speed. DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the ! purposes of calculating the equivalent barotropic wave speed. ! === module MOM_diag_to_Z === Z_OUTPUT_GRID_FILE = "analysis_vgrid_lev35.v1.nc" ! default = "" ! The file that specifies the vertical grid for ! depth-space diagnostics, or blank to disable ! depth-space output. !NK_ZSPACE (from file) = 35 ! [nondim] ! The number of depth-space levels. This is determined ! from the size of the variable zw in the output grid file. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! If true, use an implied energetics planetary boundary ! layer scheme to determine the diffusivity and viscosity ! in the surface boundary layer. EPBL_IS_ADDITIVE = True ! [Boolean] default = True ! If true, the diffusivity from ePBL is added to all ! other diffusivities. Otherwise, the larger of kappa- ! shear and ePBL diffusivities are used. INTERNAL_TIDES = False ! [Boolean] default = False ! If true, use the code that advances a separate set of ! equations for the internal tide energy density. MASSLESS_MATCH_TARGETS = True ! [Boolean] default = True ! If true, the temperature and salinity of massless layers ! are kept consistent with their target densities. ! Otherwise the properties of massless layers evolve ! diffusively to match massive neighboring layers. AGGREGATE_FW_FORCING = True ! [Boolean] default = True ! If true, the net incoming and outgoing fresh water fluxes are combined ! and applied as either incoming or outgoing depending on the sign of the net. ! If false, the net incoming fresh water flux is added to the model and ! thereafter the net outgoing is removed from the updated state.into the first non-vanished layer for which the column remains stable MIX_BOUNDARY_TRACERS = True ! [Boolean] default = True ! If true, mix the passive tracers in massless layers at ! the bottom into the interior as though a diffusivity of ! KD_MIN_TR were operating. KD_MIN_TR = 2.0E-06 ! [m2 s-1] default = 1.0E-06 ! A minimal diffusivity that should always be applied to ! tracers, especially in massless layers near the bottom. ! The default is 0.1*KD. KD_BBL_TR = 0.0 ! [m2 s-1] default = 0.0 ! A bottom boundary layer tracer diffusivity that will ! allow for explicitly specified bottom fluxes. The ! entrainment at the bottom is at least sqrt(Kd_BBL_tr*dt) ! over the same distance. TRACER_TRIDIAG = False ! [Boolean] default = False ! If true, use the passive tracer tridiagonal solver for T and S MINIMUM_FORCING_DEPTH = 0.001 ! [m] default = 0.001 ! The smallest depth over which forcing can be applied. This ! only takes effect when near-surface layers become thin ! relative to this scale, in which case the forcing tendencies ! scaled down by distributing the forcing over this depth scale. EVAP_CFL_LIMIT = 0.8 ! [nondim] default = 0.8 ! The largest fraction of a layer than can be lost to forcing ! (e.g. evaporation, sea-ice formation) in one time-step. The unused ! mass loss is passed down through the column. DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! The density difference used to determine a diagnostic mixed ! layer depth, MLD_user, following the definition of Levitus 1982. ! The MLD is the depth at which the density is larger than the ! surface density by the specified amount. ! === module MOM_CVMix_KPP === ! This is the MOM wrapper to CVMix:KPP ! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable ! === module MOM_tidal_mixing === ! Vertical Tidal Mixing Parameterization USE_CVMix_TIDAL = False ! [Boolean] default = False ! If true, turns on tidal mixing via CVMix INT_TIDE_DISSIPATION = True ! [Boolean] default = False ! If true, use an internal tidal dissipation scheme to ! drive diapycnal mixing, along the lines of St. Laurent ! et al. (2002) and Simmons et al. (2004). INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" ! INT_TIDE_PROFILE selects the vertical profile of energy ! dissipation with INT_TIDE_DISSIPATION. Valid values are: ! STLAURENT_02 - Use the St. Laurent et al exponential ! decay profile. ! POLZIN_09 - Use the Polzin WKB-streched algebraic ! decay profile. LEE_WAVE_DISSIPATION = False ! [Boolean] default = False ! If true, use an lee wave driven dissipation scheme to ! drive diapycnal mixing, along the lines of Nikurashin ! (2010) and using the St. Laurent et al. (2002) ! and Simmons et al. (2004) vertical profile INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False ! If true, consider mixing due to breaking low modes that ! have been remotely generated; as with itidal drag on the ! barotropic tide, use an internal tidal dissipation scheme to ! drive diapycnal mixing, along the lines of St. Laurent ! et al. (2002) and Simmons et al. (2004). INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 ! The decay scale away from the bottom for tidal TKE with ! the new coding when INT_TIDE_DISSIPATION is used. MU_ITIDES = 0.2 ! [nondim] default = 0.2 ! A dimensionless turbulent mixing efficiency used with ! INT_TIDE_DISSIPATION, often 0.2. GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 ! The fraction of the internal tidal energy that is ! dissipated locally with INT_TIDE_DISSIPATION. ! THIS NAME COULD BE BETTER. MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 ! Turn off internal tidal dissipation when the total ! ocean depth is less than this value. KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 ! A topographic wavenumber used with INT_TIDE_DISSIPATION. ! The default is 2pi/10 km, as in St.Laurent et al. 2002. UTIDE = 0.0 ! [m s-1] default = 0.0 ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 ! The maximum internal tide energy source availble to mix ! above the bottom boundary layer with INT_TIDE_DISSIPATION. READ_TIDEAMP = True ! [Boolean] default = False ! If true, read a file (given by TIDEAMP_FILE) containing ! the tidal amplitude with INT_TIDE_DISSIPATION. TIDEAMP_FILE = "tideamp_MOM6_newgrid.nc" ! default = "tideamp.nc" ! The path to the file containing the spatially varying ! tidal amplitudes with INT_TIDE_DISSIPATION. H2_FILE = "sgs_h2_MOM6.nc" ! ! The path to the file containing the sub-grid-scale ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_CVMix_conv === ! Parameterization of enhanced mixing due to convection via CVMix USE_CVMix_CONVECTION = False ! [Boolean] default = False ! If true, turns on the enhanced mixing due to convection ! via CVMix. This scheme increases diapycnal diffs./viscs. ! at statically unstable interfaces. Relevant parameters are ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True ! If true, and USE_EOS is true, the layer densities are ! restored toward their target values by the diapycnal ! mixing, as described in Hallberg (MWR, 2000). MAX_ENT_IT = 20 ! default = 5 ! The maximum number of iterations that may be used to ! calculate the interior diapycnal entrainment. TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.897366596101028E-05 ! The tolerance with which to solve for entrainment values. ! === module MOM_geothermal === GEOTHERMAL_SCALE = 0.001 ! [W m-2 or various] default = 0.0 ! The constant geothermal heat flux, a rescaling ! factor for the heat flux read from GEOTHERMAL_FILE, or ! 0 to disable the geothermal heating. GEOTHERMAL_FILE = "geo_hflux_newgrid.nc" ! default = "" ! The file from which the geothermal heating is to be ! read, or blank to use a constant heating rate. GEOTHERMAL_THICKNESS = 0.1 ! [m] default = 0.1 ! The thickness over which to apply geothermal heating. GEOTHERMAL_DRHO_DT_INPLACE = -0.01 ! [kg m-3 K-1] default = -0.01 ! The value of drho_dT above which geothermal heating ! simply heats water in place instead of moving it between ! isopycnal layers. This must be negative. GEOTHERMAL_VARNAME = "geo_heat" ! default = "geo_heat" ! The name of the geothermal heating variable in ! GEOTHERMAL_FILE. ! === module MOM_set_diffusivity === FLUX_RI_MAX = 0.2 ! [not defined] default = 0.2 ! The flux Richardson number where the stratification is ! large enough that N2 > omega2. The full expression for ! the Flux Richardson number is usually ! FLUX_RI_MAX*N2/(N2+OMEGA2). ML_RADIATION = True ! [Boolean] default = False ! If true, allow a fraction of TKE available from wind ! work to penetrate below the base of the mixed layer ! with a vertical decay scale determined by the minimum ! of: (1) The depth of the mixed layer, (2) an Ekman ! length scale. ML_RAD_EFOLD_COEFF = 0.2 ! [nondim] default = 0.2 ! A coefficient that is used to scale the penetration ! depth for turbulence below the base of the mixed layer. ! This is only used if ML_RADIATION is true. ML_RAD_KD_MAX = 0.001 ! [m2 s-1] default = 0.001 ! The maximum diapycnal diffusivity due to turbulence ! radiated from the base of the mixed layer. ! This is only used if ML_RADIATION is true. ML_RAD_COEFF = 0.1 ! [nondim] default = 0.2 ! The coefficient which scales MSTAR*USTAR^3 to obtain ! the energy available for mixing below the base of the ! mixed layer. This is only used if ML_RADIATION is true. ML_RAD_APPLY_TKE_DECAY = True ! [Boolean] default = True ! If true, apply the same exponential decay to ML_rad as ! is applied to the other surface sources of TKE in the ! mixed layer code. This is only used if ML_RADIATION is true. MSTAR = 0.3 ! [units=nondim] default = 1.2 ! The ratio of the friction velocity cubed to the TKE ! input to the mixed layer. TKE_DECAY = 10.0 ! [nondim] default = 2.5 ! The ratio of the natural Ekman depth to the TKE decay scale. BBL_EFFIC = 0.2 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. BBL_MIXING_MAX_DECAY = 0.0 ! [m] default = 0.0 ! The maximum decay scale for the BBL diffusion, or 0 ! to allow the mixing to penetrate as far as ! stratification and rotation permit. The default is 0. ! This is only used if BOTTOMDRAGLAW is true. BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. USE_LOTW_BBL_DIFFUSIVITY = True ! [Boolean] default = False ! If true, uses a simple, imprecise but non-coordinate dependent, model ! of BBL mixing diffusivity based on Law of the Wall. Otherwise, uses ! the original BBL scheme. LOTW_BBL_USE_OMEGA = True ! [Boolean] default = True ! If true, use the maximum of Omega and N for the TKE to diffusion ! calculation. Otherwise, N is N. SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. ! === module MOM_bkgnd_mixing === ! Adding static vertical background mixing coefficients KD = 1.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-07 ! The minimum diapycnal diffusivity. KDML = 2.0E-05 ! [m2 s-1] default = 1.0E-05 ! If BULKMIXEDLAYER is false, KDML is the elevated ! diapycnal diffusivity in the topmost HMIX of fluid. ! KDML is only used if BULKMIXEDLAYER is false. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. ! This is done via CVMix. HORIZ_VARYING_BACKGROUND = True ! [Boolean] default = False ! If true, apply vertically uniform, latitude-dependent background ! diffusivity, as described in Danabasoglu et al., 2012 BCKGRND_VDC1 = 1.6E-05 ! [m2 s-1] default = 1.6E-05 ! Background diffusivity (Ledwell) when HORIZ_VARYING_BACKGROUND=True BCKGRND_VDC_EQ = 1.0E-06 ! [m2 s-1] default = 1.0E-06 ! Equatorial diffusivity (Gregg) when HORIZ_VARYING_BACKGROUND=True BCKGRND_VDC_PSIM = 1.3E-05 ! [m2 s-1] default = 1.3E-05 ! Max. PSI induced diffusivity (MacKinnon) when HORIZ_VARYING_BACKGROUND=True BCKGRND_VDC_BAN = 1.0E-04 ! [m2 s-1] default = 1.0E-04 ! Banda Sea diffusivity (Gordon) when HORIZ_VARYING_BACKGROUND=True PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 ! Turbulent Prandtl number used to convert vertical ! background diffusivities into viscosities. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 ! The minimum dissipation by which to determine a lower ! bound of Kd (a floor). DISSIPATION_N0 = 0.0 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine ! a lower bound of Kd (a floor): A in eps_min = A + B*N. DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 USE_JACKSON_PARAM = True ! [Boolean] default = False ! If true, use the Jackson-Hallberg-Legg (JPO 2008) ! shear mixing parameterization. VERTEX_SHEAR = False ! [Boolean] default = False ! If true, do the calculations of the shear-driven mixing ! at the cell vertices (i.e., the vorticity points). RINO_CRIT = 0.25 ! [nondim] default = 0.25 ! The critical Richardson number for shear mixing. SHEARMIX_RATE = 0.089 ! [nondim] default = 0.089 ! A nondimensional rate scale for shear-driven entrainment. ! Jackson et al find values in the range of 0.085-0.089. MAX_RINO_IT = 25 ! [nondim] default = 50 ! The maximum number of iterations that may be used to ! estimate the Richardson number driven mixing. KD_KAPPA_SHEAR_0 = 2.0E-05 ! [m2 s-1] default = 1.0E-05 ! The background diffusivity that is used to smooth the ! density and shear profiles before solving for the ! diffusivities. Defaults to value of KD. FRI_CURVATURE = -0.97 ! [nondim] default = -0.97 ! The nondimensional curvature of the function of the ! Richardson number in the kappa source term in the ! Jackson et al. scheme. TKE_N_DECAY_CONST = 0.24 ! [nondim] default = 0.24 ! The coefficient for the decay of TKE due to ! stratification (i.e. proportional to N*tke). ! The values found by Jackson et al. are 0.24-0.28. TKE_SHEAR_DECAY_CONST = 0.14 ! [nondim] default = 0.14 ! The coefficient for the decay of TKE due to shear (i.e. ! proportional to |S|*tke). The values found by Jackson ! et al. are 0.14-0.12. KAPPA_BUOY_SCALE_COEF = 0.82 ! [nondim] default = 0.82 ! The coefficient for the buoyancy length scale in the ! kappa equation. The values found by Jackson et al. are ! in the range of 0.81-0.86. KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0 ! The square of the ratio of the coefficients of the ! buoyancy and shear scales in the diffusivity equation, ! Set this to 0 (the default) to eliminate the shear scale. ! This is only used if USE_JACKSON_PARAM is true. KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1 ! The fractional error in kappa that is tolerated. ! Iteration stops when changes between subsequent ! iterations are smaller than this everywhere in a ! column. The peak diffusivities usually converge most ! rapidly, and have much smaller errors than this. TKE_BACKGROUND = 0.0 ! [m2 s-2] default = 0.0 ! A background level of TKE used in the first iteration ! of the kappa equation. TKE_BACKGROUND could be 0. KAPPA_SHEAR_ELIM_MASSLESS = True ! [Boolean] default = True ! If true, massless layers are merged with neighboring ! massive layers in this calculation. The default is ! true and I can think of no good reason why it should ! be false. This is only used if USE_JACKSON_PARAM is true. MAX_KAPPA_SHEAR_IT = 13 ! [nondim] default = 13 ! The maximum number of iterations that may be used to ! estimate the time-averaged diffusivity. ! === module MOM_CVMix_shear === ! Parameterization of shear-driven turbulence via CVMix (various options) USE_LMD94 = False ! [Boolean] default = False ! If true, use the Large-McWilliams-Doney (JGR 1994) ! shear mixing parameterization. USE_PP81 = False ! [Boolean] default = False ! If true, use the Pacanowski and Philander (JPO 1981) ! shear mixing parameterization. ! === module MOM_CVMix_ddiff === ! Parameterization of mixing due to double diffusion processes via CVMix USE_CVMIX_DDIFF = False ! [Boolean] default = False ! If true, turns on double diffusive processes via CVMix. ! Note that double diffusive processes on viscosity are ignored ! in CVMix, see http://cvmix.github.io/ for justification. ! === module MOM_diabatic_aux === ! The following parameters are used for auxiliary diabatic processes. RECLAIM_FRAZIL = True ! [Boolean] default = True ! If true, try to use any frazil heat deficit to cool any ! overlying layers down to the freezing point, thereby ! avoiding the creation of thin ice when the SST is above ! the freezing point. PRESSURE_DEPENDENT_FRAZIL = False ! [Boolean] default = False ! If true, use a pressure dependent freezing temperature ! when making frazil. The default is false, which will be ! faster but is inappropriate with ice-shelf cavities. IGNORE_FLUXES_OVER_LAND = False ! [Boolean] default = False ! If true, the model does not check if fluxes are being applied ! over land points. This is needed when the ocean is coupled ! with ice shelves and sea ice, since the sea ice mask needs to ! be different than the ocean mask to avoid sea ice formation ! under ice shelves. This flag only works when use_ePBL = True. DO_RIVERMIX = True ! [Boolean] default = False ! If true, apply additional mixing whereever there is ! runoff, so that it is mixed down to RIVERMIX_DEPTH ! if the ocean is that deep. RIVERMIX_DEPTH = 40.0 ! [m] default = 0.0 ! The depth to which rivers are mixed if DO_RIVERMIX is ! defined. USE_RIVER_HEAT_CONTENT = False ! [Boolean] default = False ! If true, use the fluxes%runoff_Hflx field to set the ! heat carried by runoff, instead of using SST*CP*liq_runoff. USE_CALVING_HEAT_CONTENT = False ! [Boolean] default = False ! If true, use the fluxes%calving_Hflx field to set the ! heat carried by runoff, instead of using SST*CP*froz_runoff. ! === module MOM_energetic_PBL === MSTAR_MODE = 0 ! [units=nondim] default = 0 ! An integer switch for how to compute MSTAR. ! 0 for constant MSTAR ! 1 for MSTAR w/ MLD in stabilizing limit ! 2 for MSTAR w/ L_E/L_O in stabilizing limit. MIX_LEN_EXPONENT = 2.0 ! [units=nondim] default = 2.0 ! The exponent applied to the ratio of the distance to the MLD ! and the MLD depth which determines the shape of the mixing length. MSTAR_CAP = -1.0 ! [units=nondim] default = -1.0 ! Maximum value of mstar allowed in model if non-negative ! (used if MSTAR_MODE>0). MSTAR_CONV_ADJ = 0.0 ! [units=nondim] default = 0.0 ! Factor used for reducing mstar during convection ! due to reduction of stable density gradient. MSTAR_SLOPE = 0.85 ! [units=nondim] default = 0.85 ! The slope of the linear relationship between mstar ! and the length scale ratio (used if MSTAR_MODE=1). MSTAR_XINT = -0.3 ! [units=nondim] default = -0.3 ! The value of the length scale ratio where the mstar ! is linear above (used if MSTAR_MODE=1). MSTAR_AT_XINT = 0.095 ! [units=nondim] default = 0.095 ! The value of mstar at MSTAR_XINT ! (used if MSTAR_MODE=1). MSTAR_FLATCAP = True ! [units=nondim] default = True ! Set false to use asymptotic cap, defaults to true. ! (used only if MSTAR_MODE=1) MSTAR2_COEF1 = 0.3 ! [units=nondim] default = 0.3 ! Coefficient in computing mstar when rotation and ! stabilizing effects are both important (used if MSTAR_MODE=2) MSTAR2_COEF2 = 0.085 ! [units=nondim] default = 0.085 ! Coefficient in computing mstar when only rotation limits ! the total mixing. (used only if MSTAR_MODE=2) NSTAR = 0.2 ! [nondim] default = 0.2 ! The portion of the buoyant potential energy imparted by ! surface fluxes that is available to drive entrainment ! at the base of mixed layer when that energy is positive. MKE_TO_TKE_EFFIC = 0.0 ! [nondim] default = 0.0 ! The efficiency with which mean kinetic energy released ! by mechanically forced entrainment of the mixed layer ! is converted to turbulent kinetic energy. WSTAR_USTAR_COEF = 1.0 ! [nondim] default = 1.0 ! A ratio relating the efficiency with which convectively ! released energy is converted to a turbulent velocity, ! relative to mechanically forced TKE. Making this larger ! increases the BL diffusivity VSTAR_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 ! An overall nondimensional scaling factor for v*. ! Making this larger decreases the PBL diffusivity. EKMAN_SCALE_COEF = 1.0 ! [nondim] default = 1.0 ! A nondimensional scaling factor controlling the inhibition ! of the diffusive length scale by rotation. Making this larger ! decreases the PBL diffusivity. USE_MLD_ITERATION = False ! [Boolean] default = False ! A logical that specifies whether or not to use the ! distance to the bottom of the actively turblent boundary ! layer to help set the EPBL length scale. ORIG_MLD_ITERATION = True ! [Boolean] default = True ! A logical that specifies whether or not to use the ! old method for determining MLD depth in iteration, which ! is limited to resolution. MLD_ITERATION_GUESS = False ! [Boolean] default = False ! A logical that specifies whether or not to use the ! previous timestep MLD as a first guess in the MLD iteration. ! The default is false to facilitate reproducibility. EPBL_MLD_TOLERANCE = 1.0 ! [meter] default = 1.0 ! The tolerance for the iteratively determined mixed ! layer depth. This is only used with USE_MLD_ITERATION. EPBL_MIN_MIX_LEN = 0.0 ! [meter] default = 0.0 ! The minimum mixing length scale that will be used ! by ePBL. The default (0) does not set a minimum. EPBL_ORIGINAL_PE_CALC = True ! [Boolean] default = True ! If true, the ePBL code uses the original form of the ! potential energy change code. Otherwise, the newer ! version that can work with successive increments to the ! diffusivity in upward or downward passes is used. EPBL_TRANSITION_SCALE = 0.1 ! [nondim] default = 0.1 ! A scale for the mixing length in the transition layer ! at the edge of the boundary layer as a fraction of the ! boundary layer thickness. The default is 0.1. N2_DISSIPATION_POS = 0.0 ! [nondim] default = 0.0 ! A scale for the dissipation of TKE due to stratification ! in the boundary layer, applied when local stratification ! is positive. The default is 0, but should probably be ~0.4. N2_DISSIPATION_NEG = 0.0 ! [nondim] default = 0.0 ! A scale for the dissipation of TKE due to stratification ! in the boundary layer, applied when local stratification ! is negative. The default is 0, but should probably be ~1. USE_LA_LI2016 = False ! [nondim] default = False ! A logical to use the Li et al. 2016 (submitted) formula to ! determine the Langmuir number. EPBL_LT = False ! [nondim] default = False ! A logical to use a LT parameterization. EPBL_USTAR_MIN = 1.45842E-18 ! [m s-1] ! The (tiny) minimum friction velocity used within the ! ePBL code, derived from OMEGA and ANGSTROM. ! === module MOM_regularize_layers === REGULARIZE_SURFACE_LAYERS = False ! [Boolean] default = False ! If defined, vertically restructure the near-surface ! layers when they have too much lateral variations to ! allow for sensible lateral barotropic transports. HMIX_MIN = 2.0 ! [m] default = 0.0 ! The minimum mixed layer depth if the mixed layer depth ! is determined dynamically. REG_SFC_DEFICIT_TOLERANCE = 0.5 ! [nondim] default = 0.5 ! The value of the relative thickness deficit at which ! to start modifying the layer structure when ! REGULARIZE_SURFACE_LAYERS is true. ALLOW_CLOCKS_IN_OMP_LOOPS = True ! [Boolean] default = True ! If true, clocks can be called from inside loops that can ! be threaded. To run with multiple threads, set to False. ! === module MOM_opacity === VAR_PEN_SW = False ! [Boolean] default = False ! If true, use one of the CHL_A schemes specified by ! OPACITY_SCHEME to determine the e-folding depth of ! incoming short wave radiation. EXP_OPACITY_SCHEME = "SINGLE_EXP" ! default = "SINGLE_EXP" ! This character string specifies which exponential ! opacity scheme to utilize. Currently ! valid options include: ! SINGLE_EXP - Single Exponent decay. ! DOUBLE_EXP - Double Exponent decay. PEN_SW_SCALE = 0.0 ! [m] default = 0.0 ! The vertical absorption e-folding depth of the ! penetrating shortwave radiation. PEN_SW_FRAC = 0.0 ! [nondim] default = 0.0 ! The fraction of the shortwave radiation that penetrates ! below the surface. PEN_SW_NBANDS = 1 ! default = 1 ! The number of bands of penetrating shortwave radiation. OPACITY_LAND_VALUE = 10.0 ! [m-1] default = 10.0 ! The value to use for opacity over land. The default is ! 10 m-1 - a value for muddy water. ! === module MOM_tracer_advect === TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! The horizontal transport scheme for tracers: ! PLM - Piecewise Linear Method ! PPM:H3 - Piecewise Parabolic Method (Huyhn 3rd order) ! PPM - Piecewise Parabolic Method (Colella-Woodward) ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 800.0 ! [m2 s-1] default = 0.0 ! The maximum along-isopycnal tracer diffusivity. KHTR_PASSIVITY_COEFF = 0.0 ! [nondim] default = 0.0 ! The coefficient that scales deformation radius over ! grid-spacing in passivity, where passiviity is the ratio ! between along isopycnal mxiing of tracers to thickness mixing. ! A non-zero value enables this parameterization. KHTR_PASSIVITY_MIN = 0.5 ! [nondim] default = 0.5 ! The minimum passivity which is the ratio between ! along isopycnal mxiing of tracers to thickness mixing. DIFFUSE_ML_TO_INTERIOR = False ! [Boolean] default = False ! If true, enable epipycnal mixing between the surface ! boundary layer and the interior. CHECK_DIFFUSIVE_CFL = True ! [Boolean] default = False ! If true, use enough iterations the diffusion to ensure ! that the diffusive equivalent of the CFL limit is not ! violated. If false, always use the greater of 1 or ! MAX_TR_DIFFUSION_CFL iteration. MAX_TR_DIFFUSION_CFL = 2.0 ! [nondim] default = -1.0 ! If positive, locally limit the along-isopycnal tracer ! diffusivity to keep the diffusive CFL locally at or ! below this value. The number of diffusive iterations ! is often this value or the next greater integer. ! === module MOM_neutral_diffusion === ! This module implements neutral diffusion of tracers USE_NEUTRAL_DIFFUSION = True ! [Boolean] default = False ! If true, enables the neutral diffusion module. NDIFF_CONTINUOUS = True ! [Boolean] default = True ! If true, uses a continuous reconstruction of T and S when ! finding neutral surfaces along which diffusion will happen. ! If false, a PPM discontinuous reconstruction of T and S ! is done which results in a higher order routine but exacts ! a higher computational cost. NDIFF_REF_PRES = -1.0 ! [not defined] default = -1.0 ! The reference pressure (Pa) used for the derivatives of ! the equation of state. If negative (default), local ! pressure is used. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table ! then cause a FATAL error rather than issue a WARNING. ! === module MOM_sum_output === CALCULATE_APE = True ! [Boolean] default = True ! If true, calculate the available potential energy of ! the interfaces. Setting this to false reduces the ! memory footprint of high-PE-count models dramatically. WRITE_STOCKS = True ! [Boolean] default = True ! If true, write the integrated tracer amounts to stdout ! when the energy files are written. MAXTRUNC = 5000 ! [truncations save_interval-1] default = 0 ! The run will be stopped, and the day set to a very ! large value if the velocity is truncated more than ! MAXTRUNC times between energy saves. Set MAXTRUNC to 0 ! to stop if there is any truncation of velocities. MAX_ENERGY = 0.0 ! [m2 s-2] default = 0.0 ! The maximum permitted average energy per unit mass; the ! model will be stopped if there is more energy than ! this. If zero or negative, this is set to 10*MAXVEL^2. ENERGYFILE = "ocean.stats" ! default = "ocean.stats" ! The file to use to write the energies and globally ! summed diagnostics. DATE_STAMPED_STDOUT = True ! [Boolean] default = True ! If true, use dates (not times) in messages to stdout TIMEUNIT = 8.64E+04 ! [s] default = 8.64E+04 ! The time unit in seconds a number of input fields READ_DEPTH_LIST = False ! [Boolean] default = False ! Read the depth list from a file if it exists or ! create that file otherwise. DEPTH_LIST_MIN_INC = 1.0E-10 ! [m] default = 1.0E-10 ! The minimum increment between the depths of the ! entries in the depth-list file. ENERGYSAVEDAYS = 30.0 ! [days] default = 1.0 ! The interval in units of TIMEUNIT between saves of the ! energies of the run and other globally summed diagnostics. ENERGYSAVEDAYS_GEOMETRIC = 0.0 ! [days] default = 0.0 ! The starting interval in units of TIMEUNIT for the first call ! to save the energies of the run and other globally summed diagnostics. ! The interval increases by a factor of 2. after each call to write_energy. ! === module ocean_model_init === SINGLE_STEPPING_CALL = True ! [Boolean] default = True ! If true, advance the state of MOM with a single step ! including both dynamics and thermodynamics. If false, ! the two phases are advanced with separate calls. RESTART_CONTROL = 1 ! 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 restart file ! will be saved at the end of the run segment for any ! non-negative value. OCEAN_SURFACE_STAGGER = "C" ! default = "C" ! A case-insensitive character string to indicate the ! staggering of the surface velocity field that is ! returned to the coupler. Valid values include ! 'A', 'B', or 'C'. ICE_SHELF = False ! [Boolean] default = False ! If true, enables the ice shelf model. ICEBERGS_APPLY_RIGID_BOUNDARY = False ! [Boolean] default = False ! If true, allows icebergs to change boundary condition felt by ocean ! === module MOM_surface_forcing === LATENT_HEAT_FUSION = 3.34E+05 ! [J/kg] default = 3.34E+05 ! The latent heat of fusion. LATENT_HEAT_VAPORIZATION = 2.5E+06 ! [J/kg] default = 2.5E+06 ! The latent heat of fusion. MAX_P_SURF = -1.0 ! [Pa] default = -1.0 ! The maximum surface pressure that can be exerted by the ! atmosphere and floating sea-ice or ice shelves. This is ! needed because the FMS coupling structure does not ! limit the water that can be frozen out of the ocean and ! the ice-ocean heat fluxes are treated explicitly. No ! limit is applied if a negative value is used. RESTORE_SALINITY = True ! [Boolean] default = False ! If true, the coupled driver will add a globally-balanced ! fresh-water flux that drives sea-surface salinity ! toward specified values. RESTORE_TEMPERATURE = False ! [Boolean] default = False ! If true, the coupled driver will add a ! heat flux that drives sea-surface temperauture ! toward specified values. ADJUST_NET_SRESTORE_TO_ZERO = True ! [Boolean] default = True ! If true, adjusts the salinity restoring seen to zero ! whether restoring is via a salt flux or virtual precip. ADJUST_NET_SRESTORE_BY_SCALING = False ! [Boolean] default = False ! If true, adjustments to salt restoring to achieve zero net are ! made by scaling values without moving the zero contour. ADJUST_NET_FRESH_WATER_TO_ZERO = True ! [Boolean] default = False ! If true, adjusts the net fresh-water forcing seen ! by the ocean (including restoring) to zero. USE_NET_FW_ADJUSTMENT_SIGN_BUG = False ! [Boolean] default = True ! If true, use the wrong sign for the adjustment to ! the net fresh-water. ADJUST_NET_FRESH_WATER_BY_SCALING = False ! [Boolean] default = False ! If true, adjustments to net fresh water to achieve zero net are ! made by scaling values without moving the zero contour. ICE_SALT_CONCENTRATION = 0.005 ! [kg/kg] default = 0.005 ! The assumed sea-ice salinity needed to reverse engineer the ! melt flux (or ice-ocean fresh-water flux). USE_LIMITED_PATM_SSH = True ! [Boolean] default = True ! If true, return the sea surface height with the ! correction for the atmospheric (and sea-ice) pressure ! limited by max_p_surf instead of the full atmospheric ! pressure. APPROX_NET_MASS_SRC = False ! [Boolean] default = False ! If true, use the net mass sources from the ice-ocean ! boundary type without any further adjustments to drive ! the ocean dynamics. The actual net mass source may differ ! due to internal corrections. WIND_STAGGER = "C" ! default = "C" ! A case-insensitive character string to indicate the ! staggering of the input wind stress field. Valid ! values are 'A', 'B', or 'C'. WIND_STRESS_MULTIPLIER = 1.0 ! [not defined] default = 1.0 ! A factor multiplying the wind-stress given to the ocean by the ! coupler. This is used for testing and should be =1.0 for any ! production runs. FLUXCONST = 0.5 ! [m day-1] ! The constant that relates the restoring surface fluxes ! to the relative surface anomalies (akin to a piston ! velocity). Note the non-MKS units. SALT_RESTORE_FILE = "salt_restore_newgrid.nc" ! default = "salt_restore.nc" ! A file in which to find the surface salinity to use for restoring. SALT_RESTORE_VARIABLE = "SSS_INTERP" ! default = "salt" ! The name of the surface salinity variable to read from SALT_RESTORE_FILE for restoring salinity. SRESTORE_AS_SFLUX = True ! [Boolean] default = False ! If true, the restoring of salinity is applied as a salt ! flux instead of as a freshwater flux. MAX_DELTA_SRESTORE = 5.0 ! [PSU or g kg-1] default = 999.0 ! The maximum salinity difference used in restoring terms. MASK_SRESTORE_UNDER_ICE = False ! [Boolean] default = False ! If true, disables SSS restoring under sea-ice based on a frazil ! criteria (SST<=Tf). Only used when RESTORE_SALINITY is True. MASK_SRESTORE_MARGINAL_SEAS = False ! [Boolean] default = False ! If true, disable SSS restoring in marginal seas. Only used when ! RESTORE_SALINITY is True. BASIN_FILE = "basin.nc" ! default = "basin.nc" ! A file in which to find the basin masks, in variable 'basin'. MASK_SRESTORE = False ! [Boolean] default = False ! If true, read a file (salt_restore_mask) containing ! a mask for SSS restoring. CD_TIDES = 0.0025 ! [nondim] default = 1.0E-04 ! The drag coefficient that applies to the tides. READ_GUST_2D = False ! [Boolean] default = False ! If true, use a 2-dimensional gustiness supplied from ! an input file GUST_CONST = 0.02 ! [Pa] default = 0.02 ! The background gustiness in the winds. USE_RIGID_SEA_ICE = False ! [Boolean] default = False ! If true, sea-ice is rigid enough to exert a ! nonhydrostatic pressure that resist vertical motion. ALLOW_ICEBERG_FLUX_DIAGNOSTICS = False ! [Boolean] default = False ! If true, makes available diagnostics of fluxes from icebergs ! as seen by MOM6. ALLOW_FLUX_ADJUSTMENTS = False ! [Boolean] default = False ! If true, allows flux adjustments to specified via the ! data_table using the component name 'OCN'. ! === module MOM_restart === USE_WAVES = False ! [Boolean] default = False ! If true, enables surface wave modules. LA_DEPTH_RATIO = 0.04 ! [nondim] default = 0.04 ! The depth (normalized by BLD) to average Stokes drift over in ! Lanmguir number calculation, where La = sqrt(ust/Stokes). ! === module MOM_file_parser === SEND_LOG_TO_STDOUT = False ! [Boolean] default = False ! If true, all log messages are also sent to stdout. DOCUMENT_FILE = "MOM_parameter_doc" ! default = "MOM_parameter_doc" ! The basename for files where run-time parameters, their ! settings, units and defaults are documented. Blank will ! disable all parameter documentation. COMPLETE_DOCUMENTATION = True ! [Boolean] default = True ! If true, all run-time parameters are ! documented in MOM_parameter_doc.all . MINIMAL_DOCUMENTATION = True ! [Boolean] default = True ! If true, non-default run-time parameters are ! documented in MOM_parameter_doc.short .