MOM_input.yaml

# This file includes CESM defaults for MOM6 parameters. During compile time,
# this file is read to generate MOM_input file depending on the case settings.

### Warning: ###
# This file is intended to be edited by MOM6+CESM developers.
# For customizing cases, users should add their "parameter=value" pairs
# to user_nl_mom or add their complete versions of input files (e.g.
# MOM_input, diag_table, etc.) to SourceMods/src.mom directory.

### Syntax ###
# Module_name:
#     Param_name:
#         description: "..."
#         datatype: ...
#         value: ...

### Notes to developers ###
#   * To maintain the precision of double-precision floating-poing numbers,
#     make sure to specify the values (not datatypes) as strings, e.g,:
#       value: "300.3003003003003"
#   * Use $ sign followed by enclosing curly brackets to designate keywords
#     to be replaced by case-specific values, e.g., ${DIN_LOC_ROOT}.
#   * Expandable string variables are added quotation marks if they are NOT
#     specified with curly brackets. i.e.,
#       ${VAR}  -> str_val
#       $VAR    -> "str_val"

# =============================================================================

---

Global:
    INPUTDIR:
        description: |
            "The directory in which input files are found."
        datatype: string
        value: ${DIN_LOC_ROOT}/ocn/mom/${OCN_GRID}
    TRIPOLAR_N:
        description: |
            "[Boolean] default = False
            Use tripolar connectivity at the northern edge of the
            domain.  With TRIPOLAR_N, NIGLOBAL must be even."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
            else: False
    NIHALO:
        description: |
            "default = 2
            The number of halo points on each side in the
            x-direction.  With STATIC_MEMORY_ this is set as NIHALO_
            in MOM_memory.h at compile time; without STATIC_MEMORY_
            the default is NIHALO_ in MOM_memory.h (if defined) or 2."
        datatype: integer
        value: 4
    NJHALO:
        description: |
            "default = 2
            The number of halo points on each side in the
            y-direction.  With STATIC_MEMORY_ this is set as NJHALO_
            in MOM_memory.h at compile time; without STATIC_MEMORY_
            the default is NJHALO_ in MOM_memory.h (if defined) or 2."
        datatype: integer
        value: 4
    NIGLOBAL:
        description: |
            "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."
        datatype: integer
        value:
            $OCN_GRID == "tx2_3v2": 540
            $OCN_GRID == "tx0.25v1": 1440
            $OCN_GRID == "MISOMIP": 402
    NJGLOBAL:
        description: |
            "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.
            The number of processors in the x-direction. With
            STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
            The number of processors in the x-direction. With
            STATIC_MEMORY_ this is set in MOM_memory.h at compile time.
            The processor layout that was acutally used."
        datatype: integer
        value:
            $OCN_GRID == "tx2_3v2": 480
            $OCN_GRID == "tx0.25v1": 1080
            $OCN_GRID == "MISOMIP": 40
    NK:
        description: |
            "[nondim]
            The number of model layers."
        datatype: integer
        units: nondim
        value:
            $MOM6_VERTICAL_GRID == "zstar_65L": 65
            $MOM6_VERTICAL_GRID in ["hycom1", "zstar_75L"]: 75
            $MOM6_VERTICAL_GRID == "sigma_shelf_zstar": 36
    USE_LEGACY_DIABATIC_DRIVER:
        description: |
            "[Boolean] default = True
            If true, use the a legacy version of the diabatic subroutine.
            This is temporary and is needed avoid change in answers."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
    HREF_FOR_MLD:
        description: |
            "[m] default = 0.0
            Reference depth used to calculate the potential density used to find the mixed
            layer depth based on a delta rho = 0.03 kg/m3."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx2_3v2": 10.0
    USE_REGRIDDING:
        description: |
            "[Boolean] default = False
            If True, use the ALE algorithm (regridding/remapping).
            If False, use the layered isopycnal algorithm."
        datatype: logical
        units: Boolean
        value: True
    THICKNESSDIFFUSE:
        description: |
            "[Boolean] default = False
            If true, interfaces or isopycnal surfaces are diffused,
            depending on the value of FULL_THICKNESSDIFFUSE."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    THICKNESSDIFFUSE_FIRST:
        description: |
            "[Boolean] default = False
            If true, do thickness diffusion before dynamics.
            This is only used if THICKNESSDIFFUSE is true."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    DT:
        description: |
            "[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.)"
        datatype: real
        units: s
        value:
            $OCN_GRID == "tx0.25v1": 900.0
            $OCN_GRID == "tx2_3v2": 1800
            $OCN_GRID == "MISOMIP": 600.0
    DT_THERM:
        description: |
            "[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.
            By default DT_THERM is set to DT.
            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."
        datatype: real
        units: s
        value:
            $OCN_GRID == "MISOMIP": 1800.0
            else: >
                = ( ( $NCPL_BASE_PERIOD =="decade") * 86400.0 * 3650 +
                    ( $NCPL_BASE_PERIOD =="year") * 86400.0 * 365 +
                    ( $NCPL_BASE_PERIOD =="day") * 86400.0 +
                    ( $NCPL_BASE_PERIOD =="hour") * 3600 ) / $OCN_NCPL
    HFREEZE:
        description: |
            "[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."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx2_3v2": 10.0
            $OCN_GRID == "tx0.25v1": 20.0
    DTBT_RESET_PERIOD:
        description: |
            "[s] default = 7200.0
            The period between recalculations of DTBT (if DTBT <= 0).
            If DTBT_RESET_PERIOD is negative, DTBT is set based
            only on information available at initialization.  If 0,
            DTBT will be set every dynamics time step. The default
            is set by DT_THERM.  This is only used if SPLIT is true."
        datatype: real
        units: s
        value:
            $OCN_GRID == "tx2_3v2": 7200.0
            $OCN_GRID == "tx0.25v1": 3600.0
            else: 0.0
    FRAZIL:
        description: |
            "[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.
            If true, apply geothermal heating."
        datatype: logical
        units: Boolean
        value: True
    MIN_SALINITY:
        description: |
            "[PPT] default = 0.01
             The minimum value of salinity when BOUND_SALINITY=True. The default is 0.01
             for backward compatibility but ideally should be 0."
        datatype: real
        units: PPT
        value:
            $COMP_ATM == "cam": 1.0e-6
            else: 0.0
    BOUND_SALINITY:
        description: |
            "[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.)"
        datatype: logical
        units: Boolean
        value: True
    C_P:
        description: |
            "[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."
        datatype: real
        units: J kg-1 K-1
        value:
            $OCN_GRID == "tx2_3v2": 3992.0
            $OCN_GRID == "tx0.25v1": 3992.0
            $OCN_GRID == "MISOMIP": 3974.0
    USE_PSURF_IN_EOS:
        description: |
            "[Boolean] default = True
            If true, always include the surface pressure contributions in equation of
            state calculations."
        datatype: logical
        units: Boolean
        value: True
    CHECK_BAD_SURFACE_VALS:
        description: |
            "[Boolean] default = False
            If true, check the surface state for ridiculous values."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    SAVE_INITIAL_CONDS:
        description: |
            "[Boolean] default = False
            If true, write the initial conditions to a file given
            by IC_OUTPUT_FILE."
        datatype: logical
        units: Boolean
        value: = $CONTINUE_RUN == False
    GRID_ROTATION_ANGLE_BUGS:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
            $OCN_GRID == "tx0.25v1": False
    EQN_OF_STATE:
        description: |
            "default = WRIGHT_FULL
            EQN_OF_STATE determines which ocean equation of state should be used."
        datatype: string
        value: 
            $OCN_GRID == "MISOMIP": "LINEAR"
            else: "WRIGHT_FULL"
    DTFREEZE_DP:
        description: |
            "[deg C Pa-1] default = 0.0
            When TFREEZE_FORM=LINEAR,
            this is the derivative of the freezing potential
            temperature with pressure."
        datatype: real
        units: deg C Pa-1
        value:
            $OCN_GRID == "tx2_3v2": -7.75E-08
            $OCN_GRID == "tx0.25v1": -7.75E-08
            $OCN_GRID == "MISOMIP": -7.53E-08
    USE_IDEAL_AGE_TRACER:
        description: |
            "[Boolean] default = False
            If true, use the ideal_age_example tracer package."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    USE_CFC_CAP:
        description: |
            "[Boolean] default = False
            If true, use the MOM_CFC_cap tracer package."
        datatype: logical
        units: Boolean
        value: False
    CFC_BC_FILE:
        description: |
            "The file in which the CFC-11 and CFC-12 atm concentrations can be found (units
            must be parts per trillion)."
        datatype: string
        value: "${DIN_LOC_ROOT}/ocn/mom/grid_indpt/cfc_atm_20230310.nc"
    USE_MARBL_TRACERS:
        description: |
            "[Boolean] default = False
            If true, use the MARBL tracer package."
        datatype: logical
        units: Boolean
        value:
            '"ABIO_DIC_ON=TRUE" in $MARBL_TRACER_OPTS or "BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS': True
            else: False
    MARBL_TRACERS_IC_FILE:
        description: |
            "Name of file containing initial conditions
            for the MARBL tracer package."
        datatype: string
        value:
            $MARBL_CONFIG == "latest": ecosys_jan_IC_omip_latlon_1x1_180W_c250613.nc
            $MARBL_CONFIG == "latest+4p2z": ecosys_jan_IC_omip_latlon_1x1_180W_c250613.nc
    MARBL_FESEDFLUX_FILE:
        description: |
            "Name of file containing iron sediment flux
             forcing field for the MARBL tracer package."
        datatype: string
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $OCN_GRID == "tx2_3v2"': fesedflux_2024algo_tx2_3v2.c251229.nc
    MARBL_FESEDFLUXRED_FILE:
        description: |
            "Name of file containing iron reducing sediment flux
             forcing field for the MARBL tracer package."
        datatype: string
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $OCN_GRID == "tx2_3v2"': fesedfluxRed_2024algo_tx2_3v2.c251229.nc
    MARBL_FEVENTFLUX_FILE:
        description: |
            "Name of file containing iron sediment flux
             forcing field for the MARBL tracer package."
        datatype: string
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $OCN_GRID == "tx2_3v2"': feventflux_5gmol_tx2_3v2.c231205.nc
    READ_RIV_FLUXES:
        description: |
            "Use river fluxes provided by RIV_FLUX_FILE."
        datatype: logical
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS': True
    RIV_FLUX_FILE:
        description: |
            "Name of file containing river fluxes
             (added to surface tracer flux in tracer_vertdiff for MARBL tracers)."
        datatype: string
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $OCN_GRID == "tx2_3v2" and $ROF_GRID == "JRA025"': riv_nut.gnews_gnm.rJRA025_to_tx2_3v2_nnsm_e333r100_230415.20240202.nc
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $OCN_GRID == "tx2_3v2" and $ROF_GRID == "r05"': riv_nut.gnews_gnm.r05_to_tx2_3v2_nnsm_e250r250_230914.20240202.nc
    MARBL_D14C_FILE_1:
        description: |
            "Name of file containing D14C forcing from 30 N to 90 N."
        datatype: string
        value:
            '"ABIO_DIC_ON=TRUE" in $MARBL_TRACER_OPTS': |
                ${DIN_LOC_ROOT}/ocn/mom/grid_indpt/atm_delta_C14_CMIP6_sector1_global_1850-2015_yearly_v2.0_c240202.nc
    MARBL_D14C_FILE_2:
        description: |
            "Name of file containing D14C forcing from 30 S to 30 N."
        datatype: string
        value:
            '"ABIO_DIC_ON=TRUE" in $MARBL_TRACER_OPTS': |
                ${DIN_LOC_ROOT}/ocn/mom/grid_indpt/atm_delta_C14_CMIP6_sector2_global_1850-2015_yearly_v2.0_c240202.nc
    MARBL_D14C_FILE_3:
        description: |
            "Name of file containing D14C forcing from 90 S to 30 S."
        datatype: string
        value:
            '"ABIO_DIC_ON=TRUE" in $MARBL_TRACER_OPTS': |
                ${DIN_LOC_ROOT}/ocn/mom/grid_indpt/atm_delta_C14_CMIP6_sector3_global_1850-2015_yearly_v2.0_c240202.nc
    CHL_FROM_FILE:
        description: |
            "[Boolean] default = True
             If true, read chlorophyll from a file. Otherwise MARBL will provide it."
        datatype: logical
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS': False
    ATM_CO2_OPT:
        description: |
            "default comes from env_run.xml (OCN_CO2_TYPE)
             Source of atmospheric CO2 concentration for MARBL.
             valid values: constant, prognostic, diagnostic"
        datatype: string
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS': $OCN_CO2_TYPE
    ATM_CO2_CONST:
        description: |
            "default comes from env_run.xml (CCSM_CO2_PPMV)
             Atmospheric CO2 concentration for MARBL [ppm]."
        datatype: real
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS': $CCSM_CO2_PPMV
    ATM_ALT_CO2_OPT:
        description: |
            "default comes from env_run.xml (OCN_CO2_TYPE)
             Source of atmospheric CO2 concentration for MARBL.
             valid values: constant, prognostic, diagnostic"
        datatype: string
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS': $OCN_CO2_TYPE
    ATM_ALT_CO2_CONST:
        description: |
            "default comes from env_run.xml (CCSM_CO2_PPMV)
             Alternate atmospheric CO2 concentration for MARBL [ppm]."
        datatype: real
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS': $CCSM_CO2_PPMV
    DUST_RATIO_THRES:
        description: |
            "Coarse/fine dust ratio threshold."
        datatype: real
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $COMP_ATM == "cam"': 60.0
    DUST_RATIO_TO_FE_BIOAVAIL_FRAC:
        description: |
            "Ratio of dust to iron bioavailability fraction."
        datatype: real
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $COMP_ATM == "cam"': = 1.0 / 170.0
    FE_BIOAVAIL_FRAC_OFFSET:
        description: |
            "Offset for iron bioavailability fraction."
        datatype: real
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $COMP_ATM == "cam"': 0.01
    USE_ICE_CATEGORIES:
        description: |
            "[Boolean] default = False
            If true, send multiple ice categories from the coupler to MARBL."
        datatype: logical
        units: Boolean
        value:
             '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS and $ICE_NCAT > 0': True
    ICE_NCAT:
        description: |
            "[Integer] default = value of ICE_NCAT in env_build.xml
            If USE_ICE_CATEGORIES is true, this is the number of categories
            to send from the coupler to MARBL."
        datatype: integer
        value:
            '"BASE_BIO_ON=TRUE" in $MARBL_TRACER_OPTS': $ICE_NCAT
    COORD_CONFIG:
        description: |
            "This specifies how layers are to be defined:
            file - read coordinate information from the file
            specified by (COORD_FILE).
            linear - linear based on interfaces not layers.
            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.
            The file from which the coordinate densities are read."
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "file"
            $OCN_GRID == "MISOMIP": "linear"
    REMAP_UV_USING_OLD_ALG:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value: False
    COORD_FILE:
        description: |
            "The file from which the coordinate densities are read."
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "layer_coord.nc"
    BOUNDARY_EXTRAPOLATION:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $MOM6_VERTICAL_GRID == "hycom1": True
    GRID_CONFIG:
        description: |
            "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."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "cartesian"
            else: "mosaic"
    GRID_FILE:
        description: |
            "Name of the file from which to read horizontal grid data."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "ocean_hgrid_221123.nc"
            $OCN_GRID == "tx0.25v1": "ocean_hgrid.nc"
    USE_TRIPOLAR_GEOLONB_BUG:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
            $OCN_GRID == "tx0.25v1": False
    RAD_EARTH:
        description: |
            "[m] default = 6.378E+06
            The radius of the Earth."
        datatype: real
        units: m
        value: 6.37122E+06
    TOPO_CONFIG:
        description: |
            "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.
            DOME - use a slope and channel configuration for the
            DOME sill-overflow test case.
            DOME2D - use a shelf and slope configuration for the
            DOME2D gravity current/overflow test case.
            seamount - Gaussian bump for spontaneous motion test case.
            USER - call a user modified routine."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "ISOMIP"
            else: "file"
    TOPO_FILE:
        description: |
            "default = 'topog.nc'
            The file from which the bathymetry is read."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "ocean_topo_tx2_3v2_240501.nc"
            $OCN_GRID == "tx0.25v1": "ocean_topog.nc"
    TOPO_EDITS_FILE:
        description: |
            "default = ''
            The file from which to read a list of i,j,z topography overrides."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "topo_edits_tx2_3v2_250107.nc"
            $OCN_GRID == "tx0.25v1": "All_edits.nc"
    MAXIMUM_DEPTH:
        description: |
            "[m]
            The maximum depth of the ocean."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx2_3v2": 6000.0
            $OCN_GRID == "tx0.25v1": 6500.0
            $OCN_GRID == "MISOMIP": 720.0
    MINIMUM_DEPTH:
        description: |
            "[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 depper than MASKING_DEPTH are rounded to
            MINIMUM_DEPTH."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx2_3v2": 9.5
            $OCN_GRID == "tx0.25v1": 9.5
    MASKING_DEPTH:
        description: |
            "[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."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx2_3v2": 0.0
            $OCN_GRID == "tx0.25v1": 0.0
    REMAPPING_SCHEME:
        description: |
            "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)"
        datatype: string
        value: "PPM_CW"
    REMAP_VEL_CONSERVE_KE:
        description: |
            "[Boolean] default = False
            If true, a correction is applied to the baroclinic component of velocity after
            remapping so that total KE is conserved. KE may not be conserved when
            (CS%BBL_h_vel_mask > 0.0) .and. (CS%h_vel_mask > 0.0)"
        datatype: logical
        units: Boolean
        value:
             $OCN_GRID == "tx2_3v2": True
    REMAPPING_USE_OM4_SUBCELLS:
        description: |
            "[Boolean] default = True
            This selects the remapping algorithm used in OM4 that does not use the full
            reconstruction for the top- and lower-most sub-layers. Instead, it assumes
            they are always vanished (which is untrue) and uses only their edge values.
            It is recommended to set this option to false."
        datatype: bool
        units: none
        value:
            $OCN_GRID == "tx2_3v2": False
    INIT_LAYERS_FROM_Z_FILE:
        description: |
            "[Boolean] default = False
            If true, intialize the layer thicknesses, temperatures,
            and salnities from a Z-space file on a latitude-
            longitude grid."
        datatype: logical
        units: Boolean
        value:
            $RUN_TYPE != "hybrid" and $OCN_GRID in ["tx2_3v2", "tx0.25v1"]:
                True
            else:
                False
    TEMP_SALT_Z_INIT_FILE:
        description: |
            "default = 'temp_salt_z.nc'
            The name of the z-space input file used to initialize
            the layer thicknesses, temperatures and salinities."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "woa18_04_initial_conditions.nc"
            $OCN_GRID == "tx0.25v1": "MOM6_IC_TS.nc"
    Z_INIT_FILE_PTEMP_VAR:
        description: |
            "default = 'ptemp'
            The name of the potential temperature variable in
            TEMP_SALT_Z_INIT_FILE."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "theta0"
            $OCN_GRID == "tx0.25v1": "temp"
    Z_INIT_FILE_SALT_VAR:
        description: |
            "default = 'salt'
            The name of the salinity variable in
            TEMP_SALT_Z_INIT_FILE."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "s_an"
    Z_INIT_REMAP_OLD_ALG:
        description: |
            "[Boolean] default = True
            If false, uses the preferred remapping algorithm for initialization. If true,
            use an older, less robust algorithm for remapping."
        datatype: logical
        units: Boolean
        value: False
    Z_INIT_REMAP_GENERAL:
        description: |
            "[Boolean] default = False
            If false, only initializes to z* coordinates. If true, allows initialization
            directly to general coordinates."
        datatype: logical
        units: Boolean
        value:
            $MOM6_VERTICAL_GRID == "hycom1" and $OCN_GRID in ["tx2_3v2"]: True
    USE_VARIABLE_MIXING:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    RESOLN_SCALED_KH:
        description: |
            "[Boolean] default = False
            If true, the Laplacian lateral viscosity is scaled away
            when the first baroclinic deformation radius is well
            resolved."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    KHTH_SLOPE_CFF:
        description: |
            "[nondim] default = 0.0
            The nondimensional coefficient in the Visbeck formula for the interface depth
            diffusivity"
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.01
    DEPTH_SCALED_KHTH:
        description: |
            "[Boolean] default = False
             If true,  KHTH is scaled away when the depth is shallower
             than a reference depth: KHTH = MIN(1,H/H0)**N * KHTH,
             where H0 is a reference depth, controlled via
             DEPTH_SCALED_KHTH_H0, and theexponent (N) is
             controlled via DEPTH_SCALED_KHTH_EXP."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": False
    DEPTH_SCALED_KHTH_H0:
        description: |
            "[m] default = 1000.0
            The depth above which KHTH is scaled away."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 500.0
    KHTR_SLOPE_CFF:
        description: |
            "[nondim] default = 0.0
            The nondimensional coefficient in the Visbeck formula
            for the epipycnal tracer diffusivity"
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.25
    KHTH_USE_EBT_STRUCT:
        description: |
            "[Boolean] default = False
            If true, uses the equivalent barotropic structure
            as the vertical structure of thickness diffusivity."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    RESOLN_SCALED_KHTH:
        description: |
            "[Boolean] default = False
            If true, the interface depth diffusivity is scaled away
            when the first baroclinic deformation radius is well
            resolved."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    RESOLN_SCALED_KHTR:
        description: |
            "[Boolean] default = False
            If true, the epipycnal tracer diffusivity is scaled away when the first
            baroclinic deformation radius is well resolved."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    USE_GM_WORK_BUG:
        description: |
            "[Boolean] default = True
            If true, compute the top-layer work tendency on the u-grid with the incorrect
            sign, for legacy reproducibility."
        datatype: logical
        units: Boolean
        value: False
    USE_STORED_SLOPES:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    USE_STANLEY_ISO:
        description: |
            "[Boolean] default = False
            If true, turn on Stanley SGS T variance parameterization in isopycnal slope code."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
    ETA_TOLERANCE:
        description: |
            "[m] default = 3.15E-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."
        datatype: real
        units: m
        value:
            $OCN_GRID == "MISOMIP": 1.0E-12
            else: 1.0E-06
    ETA_TOLERANCE_AUX:
        description: |
            "[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."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx0.25v1": 0.001
    USE_NEUTRAL_DIFFUSION:
        description: |
            "[Boolean] default = False
            If true, enables the neutral diffusion module."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    NDIFF_INTERIOR_ONLY:
        description: |
            "[Boolean] default = False
            If true, only applies neutral diffusion in the ocean interior. That is, the
            algorithm will exclude the surface and bottomboundary layers."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    NDIFF_TAPERING:
        description: |
            "[Boolean] default = False
            If true, neutral diffusion linearly decays to zero within a transition
            zone defined using boundary layer depths.  Only applicable when
            NDIFF_INTERIOR_ONLY = True."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    USE_HORIZONTAL_BOUNDARY_DIFFUSION:
        description: |
            "[Boolean] default = False
            If true, enables the horizontal boundary tracer's diffusion module."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    HBD_LINEAR_TRANSITION:
        description: |
            "[Boolean] default = False
            If True, apply a linear transition at the base/top of the boundary.
            The flux will be fully applied at k=k_min and zero at k=k_max."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    SIMPLE_TKE_TO_KD:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    REGRIDDING_COORDINATE_MODE:
        description: |
            "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"
        datatype: string
        value:
            $MOM6_VERTICAL_GRID in ["zstar_65L", "zstar_75L"]: "Z*"
            $MOM6_VERTICAL_GRID == "hycom1": "HYCOM1"
            $MOM6_VERTICAL_GRID == "sigma_shelf_zstar": "SIGMA_SHELF_ZSTAR"
    ALE_COORDINATE_CONFIG:
        description: |
            "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"
        datatype: string
        value:
            $MOM6_VERTICAL_GRID == "zstar_75L": '"FILE:zstar_75layer_2.5m_248.4m-2024-03-29.nc,dz"'
            $MOM6_VERTICAL_GRID == "zstar_65L": '"FILE:vgrid_65L_20200626.nc,dz"'
            $MOM6_VERTICAL_GRID == "hycom1" and $OCN_GRID != "tx0.25v1": '"HYBRID:hybrid_75layer_zstar_2.50m-2025-09-12.nc,sigma2,dz"'
            $MOM6_VERTICAL_GRID == "hycom1" and $OCN_GRID == "tx0.25v1": '"HYBRID:hycom1_75_800m.nc,sigma2,FNC1:2,4000,4.5,.01"'
    REGRID_COMPRESSIBILITY_FRACTION:
        description: |
            "[not defined] default = 0.0
            When interpolating potential density profiles we can add
            some artificial compressibility solely to make homogenous
            regions appear stratified."
        datatype: real
        units: not defined
        value:
            $MOM6_VERTICAL_GRID == "hycom1": 0.0
    MAXIMUM_INT_DEPTH_CONFIG:
        description: |
            "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
            The list of maximum depths for each interface."
        datatype: string
        value:
            $MOM6_VERTICAL_GRID == "hycom1" and $OCN_GRID in ["tx2_3v2"]: |
                  '"FILE:${DIN_LOC_ROOT}/ocn/mom/tx2_3v2/lev-2025-09-12.nc,Z"'
            $MOM6_VERTICAL_GRID == "hycom1" and $OCN_GRID == "tx0.25v1": '"FNC1:5,8000.0,1.0,.01"'
    MAX_LAYER_THICKNESS_CONFIG:
        description: |
            "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
            The list of maximum thickness for each layer."
        datatype: string
        value:
            $MOM6_VERTICAL_GRID == "hycom1" and $OCN_GRID in ["tx2_3v2"]: |
                  '"FILE:${DIN_LOC_ROOT}/ocn/mom/tx2_3v2/dz_max-2025-09-12.nc,dz"'
            else: '"FNC1:400,31000.0,0.1,.01"'
    BOUND_CORIOLIS:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value: True
    RHO_PGF_REF_BUG:
        description: |
            "[Boolean] default = True
            If true, recover a bug that RHO_0 (the mean seawater density in Boussinesq
            mode) and RHO_PGF_REF (the subtracted reference density in finite volume
            pressure gradient forces) are incorrectly interchanged in several instances in
            Boussinesq mode."
        datatype: logical
        units: Boolean
        value: False
    MASS_WEIGHT_IN_PRESSURE_GRADIENT:
        description: |
            "[Boolean] default = False
            If true, use mass weighting when interpolation T/S for
            top/bottom integrals in AFV pressure gradient calculation."
        datatype: logical
        units: Boolean
        value: True
    USE_STANLEY_PGF:
        description: |
            "[Boolean] default = False
            If true, turn on Stanley SGS T variance parameterization in PGF code."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    LAPLACIAN:
        description: |
            "[Boolean] default = False
            If true, use a Laplacian horizontal viscosity."
        datatype: logical
        units: Boolean
        value: True
    SMAGORINSKY_KH:
        description: |
            "[Boolean] default = False
            If true, use a Smagorinsky nonlinear eddy viscosity."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    SMAG_LAP_CONST:
        description: |
            "[nondim] default = 0.0
            The nondimensional Laplacian Smagorinsky constant, often 0.15."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.15
    KH:
        description: |
            "[m2 s-1] default = 0.0
            The background Laplacian horizontal viscosity."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "MISOMIP": 6.0
    KH_VEL_SCALE:
        description: |
            "[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 viscosity and KH."
        datatype: real
        units: m s-1
        value:
            $OCN_GRID == "MISOMIP": 0.0
            $OCN_GRID == "tx0.25v1": 0.0
            $OCN_GRID == "tx2_3v2": 0.0
            else: 0.01
    KH_SIN_LAT:
        description: |
            "[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)."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2": 0.0
    BIHARMONIC:
        description: |
            "[Boolean] default = True
            If true, use a biharmonic horizontal viscosity.
            BIHARMONIC may be used with LAPLACIAN."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "MISOMIP": False
    AH:
        description: |
            "[m4 s-1] default = 0.0
            The background biharmonic horizontal viscosity."
        datatype: real
        units: m4 s-1
        value:
            $OCN_GRID == "tx2_3v2": 1.0E+12
    AH_VEL_SCALE:
        description: |
            "[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."
        datatype: real
        units: m s-1
        value:
            $OCN_GRID == "tx0.25v1": 0.01
            $OCN_GRID == "MISOMIP": 0.001
    USE_LEITHY:
        description: |
            "[Boolean] default = False
            If true, use a modified version of the biharmonic Leith nonlinear
            eddy viscosity. This implementation can include harmonic backscatter
            when LEITHY_CK > 0."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    LEITH_AH:
        description: |
            "[Boolean] default = False
            If true, use a biharmonic Leith nonlinear eddy viscosity."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
    LEITH_BI_CONST:
        description: |
            "[nondim] default = 0.0
            The nondimensional biharmonic Leith constant, typical values are thus far
            undetermined."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 75.0
    LEITHY_CK:
        description: |
            "[nondim] default = 1.0
            Fraction of biharmonic dissipation that gets backscattered, in Leith+E."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.0
    USE_LAND_MASK_FOR_HVISC:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value: True
    FRICTWORK_BUG:
        description: |
            "[Boolean] default = True
            If true, retain an answer-changing bug in calculating the FrictWork, which
            cancels the h in thickness flux and the h at velocity point. This is not
            recommended."
        datatype: logical
        units: Boolean
        value: False
    HMIX_FIXED:
        description: |
            "[m]
            The prescribed depth over which the near-surface
            viscosity and diffusivity are elevated when the bulk
            mixed layer is not used."
        datatype: real
        units: m
        value:
            $OCN_GRID == "MISOMIP": 20.0
            else: 0.5
    CHANNEL_DRAG:
        description: |
            "[Boolean] default = False
            If true, the bottom drag is exerted directly on each
            layer proportional to the fraction of the bottom it
            overlies."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": False
            else: True
    HBBL:
        description: |
            "[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."
        datatype: real
        units: m
        value: 10.0
    PRANDTL_TURB:
        description: |
            "[nondim] default = 0.0
            The turbulent Prandtl number applied to shear
            instability."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1.0
            $OCN_GRID == "tx0.25v1": 1.25
    U_TRUNC_FILE:
        description: |
            "default = ''
            The absolute path to a file into which the accelerations
            leading to zonal velocity truncations are written.
            Undefine this for efficiency if this diagnostic is not
            needed."
        datatype: string
        value: "U_velocity_truncations"
    V_TRUNC_FILE:
        description: |
            "default = ''
            The absolute path to a file into which the accelerations
            leading to meridional velocity truncations are written.
            Undefine this for efficiency if this diagnostic is not
            needed."
        datatype: string
        value: "V_velocity_truncations"
    MAXVEL:
        description: |
            "[m s-1] default = 3.0E+08
            The maximum velocity allowed before the velocity
            components are truncated."
        datatype: real
        units: m s-1
        value:
            $OCN_GRID == "MISOMIP": 10.0
            else: 6.0
    CFL_TRUNCATE_RAMP_TIME:
        description: |
            "[s] default = 0.0
            The time over which the CFL trunction value is ramped
            up at the beginning of the run."
        datatype: real
        units: s
        value:
            $OCN_GRID == "tx2_3v2": 7200.0
    Z_INIT_ALE_REMAPPING:
        description: |
            "[Boolean] default = False
            If True, then remap straight to model coordinate from file."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    NUM_DIAG_COORDS:
        description: |
            " The number of diagnostic vertical coordinates to use.
            For each coordinate, an entry in DIAG_COORDS must be provided."
        datatype: integer
        value:
            $OCN_GRID == "tx2_3v2": 2
            $OCN_GRID == "tx0.25v1": 1
    DIAG_COORDS:
        description: |
            "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."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": '"z Z ZSTAR", "rho2 RHO2 RHO"'
            $OCN_GRID == "tx0.25v1": '"z Z ZSTAR"'
    DIAG_COORD_DEF_RHO2:
        description: |
            " default = 'WOA09'
            Determines how to specify the coordinate resolution. Valid options are:
            PARAM       - use the vector-parameter DIAG_COORD_RES_RHO2
            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"
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": '"FILE:ocean_rho2_190917.nc,interfaces=rho2"'
    DIAG_MISVAL:
        description: |
            "TODO"
        datatype: real
        value:
            $OCN_GRID == "tx0.25v1": -1e34
    INTERPOLATE_RES_FN:
        description: |
            "[Boolean] default = True
            If true, interpolate the resolution function to the
            velocity points from the thickness points; otherwise
            interpolate the wave speed and calculate the resolution
            function independently at each point."
        datatype: logical
        units: Boolean
        value: False
    GILL_EQUATORIAL_LD:
        description: |
            "[Boolean] default = False
            If true, uses Gill's definition of the baroclinic
            equatorial deformation radius, otherwise, if false, use
            Pedlosky's definition. These definitions differ by a factor
            of 2 infront of the beta term in the denominator. Gill'sis the more appropriate definition."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    DRAG_BG_VEL:
        description: |
            "[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."
        datatype: real
        units: m s-1
        value:
            $OCN_GRID == "tx2_3v2": 0.1
            $OCN_GRID == "tx0.25v1": 0.1
    BBL_USE_EOS:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value: True
    BBL_THICK_MIN:
        description: |
            "[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."
        datatype: real
        units: m
        value:
            $OCN_GRID == "MISOMIP": 2.0
            else: 0.1
    BOUND_BT_CORRECTION:
        description: |
            "[Boolean] default = False
            If true, the corrective pseudo mass-fluxes into the
            barotropic solver are limited to values that require
            less than 0.1*MAXVEL to be accommodated.
            The barotropic x-halo size that is actually used.
            The barotropic y-halo size that is actually used."
        datatype: logical
        units: Boolean
        value: True
    BT_PROJECT_VELOCITY:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    BT_THICK_SCHEME:
        description: |
            "default = 'HYBRID'
            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"
        datatype: string
        value:
            $OCN_GRID != "tx0.25v1": "FROM_BT_CONT"
    BT_USE_OLD_CORIOLIS_BRACKET_BUG:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    BEBT:
        description: |
            "[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."
        datatype: real
        units: nondim
        value: 0.2
    DTBT:
        description: |
            "[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."
        datatype: real
        units: s or nondim
        value:
            $OCN_GRID == "tx0.25v1": -0.9
            $OCN_GRID == "MISOMIP": -0.9
            else: -0.95
    DEPTH_MIN_DYN_PSURF:
        description: |
            "[m] default = 1.0E-06
            The minimum depth to use in limiting the size of the
            dynamic surface pressure for stability, if
            DYNAMIC_SURFACE_PRESSURE is true."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx2_3v2": 1.0
    MAX_P_SURF:
        description: |
            "[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."
        datatype: real
        units: Pa
        value:
            $OCN_GRID == "tx0.25v1": 0.0
    KHTH:
        description: |
            "[m2 s-1] default = 0.0
            The background horizontal thickness diffusivity."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2": 0.0
            $OCN_GRID == "MISOMIP": 0.0
    KHTH_MIN:
        description: |
            "[m2 s-1] default = 0.0
            The minimum horizontal thickness diffusivity"
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2": 50.0
    FULL_DEPTH_KHTH_MIN:
        description: |
            "[Boolean] default = False
            KHTH_MIN is enforced throughout the whole water column. Otherwise,
            KHTH_MIN is only enforced at the surface. This parameter is only available
            when KHTH_USE_EBT_STRUCT=True and KHTH_MIN>0."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    KHTH_MAX_CFL:
        description: |
            "[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."
        datatype: real
        units: nondimensional
        value:
            $OCN_GRID == "tx0.25v1": 0.1
    STOCH_EOS:
        description:
            "[Boolean] default = False
            If true, stochastic perturbations are applied to the EOS in the PGF."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    STANLEY_COEFF:
        description:
            "[nondim] default = -1.0
            Coefficient correlating the temperature gradient and SGS T variance."
        datatype: real
        units: nondimensional
        value:
            $OCN_GRID == "tx2_3v2": 0.5
    USE_KH_IN_MEKE:
        description: |
            "[Boolean] default = False
            If true, uses the thickness diffusivity calculated here to diffuse MEKE."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    KHTH_USE_FGNV_STREAMFUNCTION:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    FGNV_C_MIN:
        description: |
            "[m s-1] default = 0.0
            A minium wave speed used in the Ferrari et al., 2010,
            streamfunction formulation."
        datatype: real
        units: m s-1
        value:
            $OCN_GRID == "tx2_3v2": 0.01
    USE_STANLEY_GM:
        description: |
            "[Boolean] default = False
            If true, turn on Stanley SGS T variance parameterization in GM code."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
    MIXEDLAYER_RESTRAT:
        description: |
            "[Boolean] default = False
            If true, a density-gradient dependent re-stratifying
            flow is imposed in the mixed layer.
            This is only used if BULKMIXEDLAYER is true."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": False
            else: True
    BODNER_DETECT_MLD:
        description: |
            "[Boolean] default = False
            If true, the Bodner parameterization will use the mixed-layer depth detected
            via the density difference criterion defined by MLE_DENSITY_DIFF."
        datatype: bool
        units: none
        value:
            $OCN_GRID == "tx2_3v2": True
    MLE_DENSITY_DIFF:
        description: |
            "[kg/m3] default = 0.03
            Density difference used to detect the mixed-layer depth for the
            mixed-layer eddy parameterization by Fox-Kemper et al. (2010)."
        datatype: real
        units: kg/m3
        value:
            $OCN_GRID == "tx2_3v2": 0.02
    FOX_KEMPER_ML_RESTRAT_COEF:
        description: |
            "[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)
            The file that specifies the vertical grid for
            depth-space diagnostics, or blank to disable
            depth-space output.
            The number of depth-space levels.  This is determined
            from the size of the variable zw in the output grid file."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1.0
            $OCN_GRID == "tx0.25v1": 1.0
    MLE_FRONT_LENGTH:
        description: |
            "[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."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx2_3v2": 1000.0
            $OCN_GRID == "tx0.25v1": 500.0
    MLE_FRONT_LENGTH_FROM_FILE:
        description: |
            "[Boolean] default = False
            If true, the MLE front-length scale is read from a file."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
    MLE_MLD_DECAY_TIME:
        description: |
            "[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."
        datatype: real
        units: s
        value:
            $OCN_GRID == "tx2_3v2": 3.45600E+05
            $OCN_GRID == "tx0.25v1": 2.592E+06
    USE_STANLEY_ML:
        description: |
            "[Boolean] default = False
            If true, turn on Stanley SGS T variance parameterization in ML restrat code."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    USE_CVMix_CONVECTION:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    BBL_MIXING_AS_MAX:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
            $OCN_GRID == "tx0.25v1": False
    USE_LOTW_BBL_DIFFUSIVITY:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    KD_MAX:
        description: |
            "[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."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2": 0.1
            $OCN_GRID == "tx0.25v1": 0.1
    HORIZ_VARYING_BACKGROUND:
        description: |
            "[Boolean] default = False
             If true, apply vertically uniform, latitude-dependent background diffusivity,
             as described in Danabasoglu et al., 2012."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    KD:
        description: |
            "[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."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2": 1.0E-07
            $OCN_GRID == "tx0.25v1": 1.5E-05
            $OCN_GRID == "MISOMIP": 5.0E-05
            else: 2.0E-05
    KDML:
        description: |
            "[m2 s-1]
            If BULKMIXEDLAYER is false, KDML is the elevated diapycnal diffusivity in the
            topmost HMIX of fluid. KDML is only used if BULKMIXEDLAYER is false."
        datatype: real
        units: m2 s-1
        value: 0.0
    PRANDTL_BKGND:
        description: |
            "[nondim] default = 1.0
            Turbulent Prandtl number used to convert vertical background diffusivities
            into viscosities."
        datatype: real
        units: m2 s-1
        value: # KV/KD:
            $OCN_GRID == "tx0.25v1": = 1.0E-04 / 1.5E-05
            $OCN_GRID == "MISOMIP": = 1.0E-04 / 5.0E-05
            else: = 1.0E-06 / 1.0E-07
    KD_MIN:
        description: |
            "[m2 s-1] default = 2.0E-07
            The minimum diapycnal diffusivity.
            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)."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2":  1.0E-07
            else: 2.0E-06
    INT_TIDE_DECAY_SCALE:
        description: |
            "[m] default = 500.0
            The decay scale away from the bottom for tidal TKE with
            the new coding when INT_TIDE_DISSIPATION is used."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx0.25v1": "300.3003003003003"
    READ_TIDEAMP:
        description: |
            "[Boolean] default = False
            If true, read a file (given by TIDEAMP_FILE) containing
            the tidal amplitude with INT_TIDE_DISSIPATION."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    TIDEAMP_FILE:
        description: |
            "default = 'tideamp.nc'
            The path to the file containing the spatially varying
            tidal amplitudes with INT_TIDE_DISSIPATION."
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "tidal_amplitude.v20140616.nc"
    CD_TIDES:
        description: |
            "[nondim] default = 1.0E-04
            The drag coefficient that applies to the tides."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.0018
    USE_RIGID_SEA_ICE:
        description: |
            "[Boolean] default = False
            If true, sea-ice is rigid enough to exert a
            nonhydrostatic pressure that resist vertical motion."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    SEA_ICE_RIGID_MASS:
        description: |
            "[kg m-2] default = 1000.0
            The mass of sea-ice per unit area at which the sea-ice
            starts to exhibit rigidity"
        datatype: real
        units: kg m-2
        value:
            $OCN_GRID == "tx0.25v1": 100.0
    H2_FILE:
        description: |
            "The path to the file containing the sub-grid-scale
            topographic roughness amplitude with INT_TIDE_DISSIPATION."
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "ocean_topog.nc"
    USE_KPP:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    USE_CVMix_TIDAL:
        description: |
            "[Boolean] default = False
            If true, turns on tidal mixing via CVMix"
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    INT_TIDE_DISSIPATION:
        description: |
            "[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)."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    INT_TIDE_PROFILE:
        description: |
            "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."
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "POLZIN_09"
    TIDAL_ENERGY_FILE:
        description: |
            "The path to the file containing tidal energy
            dissipation. Used with CVMix tidal mixing schemes."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "energy_new_tx2_3_conserve_230415_cdf5.nc"
    TIDAL_ENERGY_TYPE:
        description: |
            "The type of input tidal energy flux dataset. Valid values are   Jayne
            ER03"
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "Jayne"
    USE_LMD94:
        description: |
            "[Boolean] default = False
            If true, use the Large-McWilliams-Doney (JGR 1994)
            shear mixing parameterization."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    NU_ZERO:
        description: |
            "[m2 s-1] default = 0.005
            Leading coefficient in KPP shear mixing."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2": 0.0025
    RI_ZERO:
        description: |
            "[nondim] default = 0.8
            Critical Richardson for KPP shear mixing, NOTE this the internal mixing and
            this is not for setting the boundary layer depth."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.5
    N_SMOOTH_RI:
        description: |
            "default = 0
            If > 0, vertically smooth the Richardson number by applying a 1-2-1 filter
            N_SMOOTH_RI times."
        datatype: integer
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1
    USE_CVMIX_DDIFF:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    MAX_ENT_IT:
        description: |
            "default = 5
            The maximum number of iterations that may be used to
            calculate the interior diapycnal entrainment."
        datatype: integer
        value:
            $OCN_GRID == "tx0.25v1": 5
            else: 20
    TOLERANCE_ENT:
        description: |
            "[m] default = 2.683281572999748E-05
            The tolerance with which to solve for entrainment values."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx2_3v2": 1.0E-05
            $OCN_GRID == "MISOMIP": 1.0E-08
    HMIX_MIN:
        description: |
            "[m] default = 0.0
            The minimum mixed layer depth if the mixed layer depth
            is determined dynamically."
        datatype: real
        units: m
        value:
            $OCN_GRID == "MISOMIP": 20.0
            $OCN_GRID == "tx0.25v1": 0.0
            else: 2.0
    PRESSURE_DEPENDENT_FRAZIL:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    MSTAR_MODE:
        description: |
            "[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."
        datatype: integer
        units: units=nondim
        value:
            $OCN_GRID == "tx0.25v1": 2
    MSTAR:
        description: |
            "[units=nondim] default = 1.2
            The ratio of the friction velocity cubed to the TKE
            input to the mixed layer."
        datatype: real
        units: units=nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.0
    MIX_LEN_EXPONENT:
        description: |
            "[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."
        datatype: real
        units: units=nondim
        value:
            $OCN_GRID == "tx0.25v1": 1.0
    MSTAR_CAP:
        description: |
            "[units=nondim] default = -1.0
            Maximum value of mstar allowed in model if non-negative
            (used if MSTAR_MODE>0)."
        datatype: real
        units: units=nondim
        value:
            $OCN_GRID == "tx0.25v1": 10.0
    MSTAR_CONV_ADJ:
        description: |
            "[units=nondim] default = 0.0
            Factor used for reducing mstar during convection
            due to reduction of stable density gradient."
        datatype: real
        units: units=nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.667
    MSTAR2_COEF1:
        description: |
            "[units=nondim] default = 0.3
            Coefficient in computing mstar when rotation and
            stabilizing effects are both important (used if MSTAR_MODE=2)"
        datatype: real
        units: units=nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.29
    MSTAR2_COEF2:
        description: |
            "[units=nondim] default = 0.085
            Coefficient in computing mstar when only rotation limits
            the total mixing. (used only if MSTAR_MODE=2)"
        datatype: real
        units: units=nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.152
    NSTAR:
        description: |
            "[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."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.06
    TKE_DECAY:
        description: |
            "[nondim] default = 2.5
            TKE_DECAY relates the vertical rate of decay of the
            TKE available for mechanical entrainment to the natural
            Ekman depth."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.01
    ML_OMEGA_FRAC:
        description: |
            "[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)."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.001
    USE_MLD_ITERATION:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    ORIG_MLD_ITERATION:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": False
    EPBL_TRANSITION_SCALE:
        description: |
            "[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."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.01
    USE_LA_LI2016:
        description: |
            "[nondim] default = False
            A logical to use the Li et al. 2016 (submitted) formula to
            determine the Langmuir number."
        datatype: logical
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": True
    LT_ENHANCE:
        description: |
            "[nondim] default = 0
            Integer for Langmuir number mode.
            *Requires USE_LA_LI2016 to be set to True.
            Options: 0 - No Langmuir
            1 - Van Roekel et al. 2014/Li et al., 2016
            2 - Multiplied w/ adjusted La.
            3 - Added w/ adjusted La."
        datatype: integer
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 3
    LT_ENHANCE_COEF:
        description: |
            "[nondim] default = 0.447
            Coefficient for Langmuir enhancement if LT_ENHANCE > 1"
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.044
    LT_ENHANCE_EXP:
        description: |
            "[nondim] default = -1.33
            Exponent for Langmuir enhancement if LT_ENHANCE > 1"
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": -1.5
    LT_MOD_LAC1:
        description: |
            "[nondim] default = -0.87
            Coefficient for modification of Langmuir number due to
            MLD approaching Ekman depth if LT_ENHANCE=2."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.0
    LT_MOD_LAC4:
        description: |
            "[nondim] default = 0.95
            Coefficient for modification of Langmuir number due to
            ratio of Ekman to stable Obukhov depth if LT_ENHANCE=2."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.0
    LT_MOD_LAC5:
        description: |
            "[nondim] default = 0.95
            Coefficient for modification of Langmuir number due to
            ratio of Ekman to unstable Obukhov depth if LT_ENHANCE=2."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.22
    EPBL_USTAR_MIN:
        description: |
            "[m s-1]
            The (tiny) minimum friction velocity used within the
            ePBL code, derived from OMEGA and ANGSTROM."
        datatype: real
        units: m s-1
        value:
            $OCN_GRID == "tx0.25v1": 1.45842E-18
    VAR_PEN_SW:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
            $OCN_GRID == "tx2_3v2": True
    CHL_FILE:
        description: |
            "CHL_FILE is the file containing chl_a concentrations in the variable CHL_A."
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "seawifs-clim-1997-2010.1440x1080.v20180328.nc"
            $OCN_GRID == "tx2_3v2": "seawifs-clim-1997-2010-tx2_3v2.230416.nc"
    CHL_VARNAME:
        description: |
            "default = 'CHL_A'"
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "chlor_a"
    PEN_SW_NBANDS:
        description: |
            "default = 1
            The number of bands of penetrating shortwave radiation."
        datatype: integer
        value:
            $OCN_GRID == "tx0.25v1": 3
            $OCN_GRID == "tx2_3v2": 2
    OPACITY_SCHEME:
        description: |
            "default = 'MANIZZA_05'
            This character string specifies how chlorophyll concentrations are translated
            into opacities. Currently valid options include:
                   MANIZZA_05 - Use Manizza et al., GRL, 2005.
                   MOREL_88 - Use Morel, JGR, 1988.
                   OHLMANN_03 - Use Ohlmann, J Clim, 2003."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "OHLMANN_03"
    TRACER_ADVECTION_SCHEME:
        description: |
            "default = 'PLM'
            The horizontal transport scheme for tracers:
            PLM    - Piecewise Linear Method
            PPM:H3 - Piecewise Parabolic Method (Huyhn 3rd order)"
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": '"PPM:H3"'
            $OCN_GRID == "tx0.25v1": '"PPM:H3"'
    KHTR_USE_EBT_STRUCT:
        description: |
            "[Boolean] default = False
            If true, uses the equivalent barotropic structure as the vertical structure of
            the tracer diffusivity."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    KHTR:
        description: |
            "[m2 s-1] default = 0.0
            The background along-isopycnal tracer diffusivity."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "MISOMIP": 1.0
    KHTR_MIN:
        description: |
            "[m2 s-1] default = 0.0
            The minimum along-isopycnal tracer diffusivity."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2": 50.0
    FULL_DEPTH_KHTR_MIN:
        description: |
            "[Boolean] default = False
            KHTR_MIN is enforced throughout the whole water column. Otherwise,
            KHTR_MIN is only enforced at the surface. This parameter is only available
            when KHTR_USE_EBT_STRUCT=True and KHTR_MIN>0."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    DEBUG:
        description: |
            "If true, write out verbose debugging data."
        datatype: logical
        units: Boolean
        value: False
    CHECK_DIFFUSIVE_CFL:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
    MAX_TR_DIFFUSION_CFL:
        description: |
            "[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."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 2.0
    MAXTRUNC:
        description: |
            "[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."
        datatype: integer
        units: truncations save_interval-1
        value:
            $OCN_GRID == "tx0.25v1": 100000
            else: 0
    OCEAN_SURFACE_STAGGER:
        description: |
            "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'."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "A"
            $OCN_GRID == "tx0.25v1": "A"
    RESTORE_SALINITY:
        description: |
            "[Boolean] default = False
            If true, the coupled driver will add a globally-balanced
            fresh-water flux that drives sea-surface salinity
            toward specified values."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2" and $COMP_ATM == "datm": True  # for C and G compsets on tx2_3v2
            else: False
    WIND_STAGGER:
        description: |
            "default = 'C'
            A case-insensitive character string to indicate the staggering of the input
            wind stress field.  Valid values are 'A', 'B', or 'C'."
        datatype: string
        value: "A"
    ENTHALPY_FROM_COUPLER:
        description: |
            "[Boolean] default = False
            If True, the heat (enthalpy) associated with mass entering/leaving
            the ocean is provided via coupler."
        datatype: logical
        units: Boolean
        value: True
    FLUXCONST:
        description: |
            "[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."
        datatype: real
        units: m day-1
        value:
            $OCN_GRID == "tx2_3v2": 0.1667
    SALT_RESTORE_FILE:
        description: |
            "default = 'salt_restore.nc'
            A file in which to find the surface salinity to use for restoring."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "state_restore_tx2_3_20230416.nc"
    ADJUST_NET_FRESH_WATER_TO_ZERO:
        description: |
            "[Boolean] default = False
            If true, adjusts the net fresh-water forcing seen
            by the ocean (including restoring) to zero."
        datatype: logical
        units: Boolean
        value:
            $COMP_ATM == "datm": True  # for C and G compsets
            else: False
    MAX_DELTA_SRESTORE:
        description: |
            "[PSU or g kg-1] default = 999.0
            The maximum salinity difference used in restoring terms."
        datatype: real
        units: PSU or g kg-1
        value:
            $OCN_GRID == "tx2_3v2": 5.0
    SRESTORE_AS_SFLUX:
        description: |
            "[Boolean] default = False
            If true, the restoring of salinity is applied as a salt
            flux instead of as a freshwater flux."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    GUST_CONST:
        description: |
            "[Pa] default = 0.02
             The background gustiness in the winds."
        datatype: real
        units: Pa
        value: 0.0004
    USTAR_GUSTLESS_BUG:
        description: |
            "[Boolean] default = False
            If true include a bug in the time-averaging of the gustless wind
            friction velocity."
        datatype: logical
        units: Boolean
        value: False
    RESTART_CONTROL:
        description: |
            "default = 1
            An integer whose bits encode which restart files are
            written. Add 2 (bit 1) for a time-stamped file, and odd
            (bit 0) for a non-time-stamped file. A non-time-stamped
            restart file is saved at the end of the run segment
            for any non-negative value."
        datatype: integer
        value:
            $OCN_GRID == "MISOMIP": -1
            $OCN_GRID == "tx0.25v1": 1
            else: 3
    RESTINT:
        description: |
            "[days] default = 0.0
            The interval between saves of the restart file in units
            of TIMEUNIT.  Use 0 (the default) to not save
            incremental restart files at all."
        datatype: real
        units: days
        value:
            $OCN_GRID == "MISOMIP": 0.0
    ENERGYSAVEDAYS:
        description: |
            "[days] default = 1.0
            The interval in units of TIMEUNIT between saves of the
            energies of the run and other globally summed diagnostics."
        datatype: real
        units: days
        value:
            $OCN_GRID == "tx2_3v2": 1.0
            $OCN_GRID == "tx0.25v1": 0.25
            $OCN_GRID == "MISOMIP": 1.0
    ENERGETICS_SFC_PBL:
        description: |
            "[Boolean] default = False
            If true, use an implied energetics planetary boundary
            layer scheme to determine the diffusivity and viscosity
            in the surface boundary layer."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
            $OCN_GRID == "MISOMIP": True
    USE_MEKE:
        description: |
            "[Boolean] default = False
            If true, turns on the MEKE scheme which calculates
            a sub-grid mesoscale eddy kinetic energy budget."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
            $OCN_GRID == "tx2_3v2": True
    MEKE_GMCOEFF:
        description: |
            "[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."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 1.0
            $OCN_GRID == "tx2_3v2": 0.25
    MEKE_BGSRC:
        description: |
            "[W kg-1] default = 0.0
            A background energy source for MEKE."
        datatype: real
        units: W kg-1
        value:
            $OCN_GRID == "tx0.25v1": 1.0E-13
    MEKE_KHMEKE_FAC:
        description: |
            "[nondim] default = 0.0
            A factor that maps MEKE%Kh to Kh for MEKE itself."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 1.0
            $OCN_GRID == "tx2_3v2": 0.75
    MEKE_VISCOSITY_COEFF_KU:
        description: |
            "[nondim] default = 0.0
            If non-zero, is the scaling coefficient in the expression forviscosity used to
            parameterize harmonic lateral momentum mixing byunresolved eddies represented
            by MEKE. Can be negative torepresent backscatter from the unresolved eddies."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.0
    MEKE_MIN_LSCALE:
        description: |
            "[Boolean] default = False
            If true, use a strict minimum of provided length scales rather than harmonic
            mean."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    MEKE_ALPHA_RHINES:
        description: |
            "[nondim] default = 0.05
            If positive, is a coefficient weighting the Rhines scale
            in the expression for mixing length used in MEKE-derived diffusiviity."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.15
    MEKE_ALPHA_EADY:
        description: |
            "[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."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.15
            $OCN_GRID == "tx2_3v2": 1.0
    MEKE_FRCOEFF:
        description: |
            "[nondim] default = -1.0
            If positive, is a coefficient weighting the grid-spacing as a scale in the
            expression for mixing length used in MEKE-derived diffusivity."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.3
    MEKE_CT:
        description: |
            "[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)."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.0
    MEKE_POSITIVE:
        description: |
            "[Boolean] default = False
            If true, it guarantees that MEKE will always be >= 0."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    USE_SIMPLER_EADY_GROWTH_RATE:
        description: |
            "[Boolean] default = False
            If true, use a simpler method to calculate the Eady growth rate that avoids
            division by layer thickness. Recommended."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    KH_RES_SCALE_COEF:
        description: |
            "[nondim] default = 1.0
            A coefficient that determines how KhTh is scaled away if RESOLN_SCALED_... is
            true, as F = 1 / (1 + (KH_RES_SCALE_COEF*Rd/dx)^KH_RES_FN_POWER)."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.9
    KH_RES_FN_POWER:
        description: |
            "[nondim] default = 2
            The power of dx/Ld in the Kh resolution function.  Any positive integer may be
            used, although even integers are more efficient to calculate.  Setting this
            greater than 100 results in a step-function being used."
        datatype: integer
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 6
    VISC_RES_SCALE_COEF:
        description: |
            "[nondim] default = 1.0
            A coefficient that determines how Kh is scaled away if RESOLN_SCALED_... is
            true, as F = 1 / (1 + (KH_RES_SCALE_COEF*Rd/dx)^KH_RES_FN_POWER). This
            function affects lateral viscosity, Kh, and not KhTh."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.4
    MEKE_GEOMETRIC:
        description: |
            "[Boolean] default = False
            If MEKE_GEOMETRIC is true, uses the GM coefficient formulation from the
            GEOMETRIC framework (Marshall et al., 2012)."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    MEKE_GEOMETRIC_ALPHA:
        description: |
            "[nondim] default = 0.05
            The nondimensional coefficient governing the efficiency of the GEOMETRIC
            thickness diffusion."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.06
    MEKE_KHTH_FAC:
        description: |
            "[nondim] default = 0.0
            A factor that maps MEKE%Kh to KhTh."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1.0
    MEKE_KHTR_FAC:
        description: |
            "[nondim] default = 0.0
            A factor that maps MEKE%Kh to KhTr."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1.0
    MEKE_CB:
        description: |
            "[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)."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 100.0
    MEKE_CDRAG:
        description: |
            "[nondim] default = 0.003
            Drag coefficient relating the magnitude of the velocity field to the bottom
            stress in MEKE."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.0025
    MEKE_MIN_GAMMA2:
        description: |
            "[nondim] default = 1.0E-04
            The minimum allowed value of gamma_b^2."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1.0E-05
    MEKE_EQUILIBRIUM_ALT:
        description: |
            "[Boolean] default = False
            If true, use an alternative formula for computing the (equilibrium)initial
            value of MEKE."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    MEKE_VISC_DRAG:
        description: |
            "[Boolean] default = True
            If true, use the vertvisc_type to calculate the bottom drag acting on MEKE."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
    MEKE_EQUILIBRIUM_RESTORING:
        description: |
            "[Boolean] default = False
            If true, restore MEKE back to its equilibrium value, which is calculated
            at each time step."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
    MEKE_RESTORING_TIMESCALE:
        description: |
            "[s] default = 1.0E+06
            The timescale used to nudge MEKE toward its equilibrium value."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1.0E+07
    MEKE_ADVECTION_FACTOR:
        description: |
            "[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 accommodate a mismatch
            between the advecting barotropic flow and the vertical structure of MEKE."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1.0
    DIAG_COORD_DEF_Z:
        description: |
            "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"
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": '"FILE:interpolate_zgrid_40L.nc,interfaces=zw"'
    MAX_RINO_IT:
        description: |
            "[nondim] default = 50
            The maximum number of iterations that may be used to
            estimate the Richardson number driven mixing."
        datatype: integer
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 25
    CHANNEL_CONFIG:
        description: |
            "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."
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "list"
            $OCN_GRID == "tx2_3v2": "list"
    CHANNEL_LIST_FILE:
        description: |
            "default = MOM_channel_list
            The file from which the list of narrowed channels is read."
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "MOM_channels_global_025"
            $OCN_GRID == "tx2_3v2":  "channels_tx2_3v2_250107.txt"
    SMAG_BI_CONST:
        description: |
            "[nondim] default = 0.0
            The nondimensional biharmonic Smagorinsky constant,
            typically 0.015 - 0.06."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx0.25v1": 0.06
            $OCN_GRID == "MISOMIP": 0.06
    USE_JACKSON_PARAM:
        description: |
            "[Boolean] default = False
            If true, use the Jackson-Hallberg-Legg (JPO 2008)
            shear mixing parameterization."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
            $OCN_GRID == "MISOMIP": True
    KAPPA_SHEAR_ITER_BUG:
        description:
            "[Boolean] default = True
            If true, use an older, dimensionally inconsistent estimate of the derivative
            of diffusivity with energy in the Newton's method iteration.  The bug causes
            undercorrections when dz > 1 m."
        datatype: logical
        units: Boolean
        value: False
    KAPPA_SHEAR_ALL_LAYER_TKE_BUG:
        description:
            "[Boolean] default = True
            If true, report back the latest estimate of TKE instead of the time average
            TKE when there is mass in all layers.  Otherwise always report the time
            averaged TKE, as is currently done when there are some massless layers."
        datatype: logical
        units: Boolean
        value: False
    SMAGORINSKY_AH:
        description: |
            "[Boolean] default = False
            If true, use a biharmonic Smagorinsky nonlinear eddy
            viscosity."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    BAD_VAL_SSH_MAX:
        description: |
            "[m] default = 20.0
            The value of SSH above which a bad value message is
            triggered, if CHECK_BAD_SURFACE_VALS is true."
        datatype: real
        units: m
        value:
            $OCN_GRID == "tx0.25v1": 50.0   # TODO
    BAD_VAL_SSS_MAX:
        description: |
            "default = 45.0
            The value of SSS above which a bad value message is triggered, if
            CHECK_BAD_SURFACE_VALS is true."
        datatype: real
        units: PPT
        value:
            $OCN_GRID == "tx2_3v2" or $COMP_ATM == "cam": 75.0
    BAD_VAL_SST_MAX:
        description: |
            "[deg C] default = 45.0, PTripp: changed from 55.0 on 12/28/2017
            The value of SST above which a bad value message is
            triggered, if CHECK_BAD_SURFACE_VALS is true."
        datatype: real
        units: deg C
        value:
            $OCN_GRID == "tx0.25v1": 65.0
    BAD_VAL_SST_MIN:
        description: |
            "default = -2.1
            The value of SST below which a bad value message is triggered, if
            CHECK_BAD_SURFACE_VALS is true."
        datatype: real
        units: degC
        value:
            $OCN_GRID == "tx2_3v2": -3.0
            $OCN_GRID == "tx0.25v1": -3.0
    DEFAULT_ANSWER_DATE:
        description: |
            "[Boolean] default = True
            This sets the default value for the various parameters."
        datatype: string
        units: ymd
        value: 99991231
    VERTEX_SHEAR:
        description: |
            "[Boolean] default = False
            If true, do the calculations of the shear-driven mixing
            at the cell vertices (i.e., the vorticity points)."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    RECLAIM_FRAZIL:
        description: |
            " [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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    THERMO_SPANS_COUPLING:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    DO_GEOTHERMAL:
        description: |
            "[Boolean] default = False
            If true, apply geothermal heating."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
            $OCN_GRID == "tx0.25v1": True
            else: False
    PARALLEL_RESTARTFILES:
        description: |
            "[Boolean] default = False
            If true, each processor writes its own restart file,
            otherwise a single restart file is generated"
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": True
    FPMIX:
        description: |
            "[Boolean] default = False
            If true, add non-local momentum flux increments and diffuse down the Eulerian
            gradient.
        datatype: logical
        units: Boolean
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
    CEMP_NL:
        description: |
            "default = 3.6
            Empirical coefficient of non-local momentum mixing."
        datatype: real
        units: nondim
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": 3.5
    VISC_REM_BUG:
        description: |
            "[Boolean] default = True
            If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted
            for in two places. This parameter controls the defaults of two individual
            flags, VISC_REM_TIMESTEP_BUG in MOM_dynamics_split_RK2(b) and
            VISC_REM_BT_WEIGHT_BUG in MOM_barotropic."
        datatype: logical
        units: Boolean
        value: False

    # MISOMIP-only variables:

    REENTRANT_X:
        description: |
            "[Boolean] default = True
            If true, the domain is zonally reentrant."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": False
    RHO_0:
        description: |
            "[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."
        datatype: real
        units: kg m-3
        value:
            $OCN_GRID == "MISOMIP": 1028.0
    ANGSTROM:
        description: |
            "[m] default = 1.0E-10
            The minumum layer thickness, usually one-Angstrom."
        datatype: real
        units: m
        value:
            $OCN_GRID == "MISOMIP": 1.0E-15
    IC_OUTPUT_FILE:
        description: |
            "default = 'MOM_IC'
            The file into which to write the initial conditions."
        datatype: string
        value: = "${CASE}.mom6.ic.${RUN_STARTDATE}.nc"
    TRIMMING_USES_REMAPPING:
        description: |
            "[Boolean] default = False
            When trimming the column, also remap T and S."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    ISOMIP_S_SUR_SPONGE:
        description: |
            "[not defined] default = 35.0
            Surface salinity in sponge layer."
        datatype: real
        units: not defined
        value:
            $OCN_GRID == "MISOMIP": 33.8
    ISOMIP_S_BOT_SPONGE:
        description: |
            "[not defined] default = 35.0
            Bottom salinity in sponge layer."
        datatype: real
        units: not defined
        value:
            $OCN_GRID == "MISOMIP": 34.7
    ISOMIP_T_BOT_SPONGE:
        description: |
            "[not defined] default = -1.9
            Bottom temperature in sponge layer."
        datatype: real
        units: not defined
        value:
            $OCN_GRID == "MISOMIP": 1.0
    RHO_T0_S0:
        description: |
            "[kg m-3] default = 1000.0
            When EQN_OF_STATE=LINEAR,
            this is the density at T=0, S=0."
        datatype: real
        units: kg m-3
        value:
            $OCN_GRID == "MISOMIP": 999.910681
    DRHO_DT:
        description: |
            "[kg m-3 K-1] default = -0.2
            When EQN_OF_STATE=LINEAR,
            this is the partial derivative of density with
            temperature."
        datatype: real
        units: kg m-3 K-1
        value:
            $OCN_GRID == "MISOMIP": -0.038357
    DRHO_DS:
        description: |
            "[kg m-3 PSU-1] default = 0.8
            When EQN_OF_STATE=LINEAR,
            this is the partial derivative of density with
            salinity."
        datatype: real
        units: kg m-3 PSU-1
        value:
            $OCN_GRID == "MISOMIP": 0.805876
    TFREEZE_S0_P0:
        description: |
            "TODO"
        datatype: real
        value:
            $OCN_GRID == "MISOMIP": 0.0832
    DTFREEZE_DS:
        description: |
            "TODO"
        datatype: real
        value:
            $OCN_GRID == "MISOMIP": -0.0573
    USE_ISOMIP_TRACER:
        description: |
            "[Boolean] default = False
            If true, use the ISOMIP_tracer tracer package."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    AXIS_UNITS:
        description: |
            "default = 'degrees'
            The units for the Cartesian axes. Valid entries are:
            degrees - degrees of latitude and longitude
            m - meters
            k - kilometers"
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "k"
    SOUTHLAT:
        description: |
            "[k]
            The southern latitude of the domain or the equivalent
            starting value for the y-axis."
        datatype: real
        units: k
        value:
            $OCN_GRID == "MISOMIP": 0.0
    LENLAT:
        description: |
            "[k]
            The latitudinal or y-direction length of the domain."
        datatype: real
        units: k
        value:
            $OCN_GRID == "MISOMIP": 80.0
    WESTLON:
        description: |
            "[k] default = 0.0
            The western longitude of the domain or the equivalent
            starting value for the x-axis."
        datatype: real
        units: k
        value:
            $OCN_GRID == "MISOMIP": -2.0
    LENLON:
        description: |
            "[k]
            The longitudinal or x-direction length of the domain."
        datatype: real
        units: k
        value:
            $OCN_GRID == "MISOMIP": 802.0
    ROTATION:
        description: |
            "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."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "beta"
    F_0:
        description: |
            "[s-1] default = 0.0
            The reference value of the Coriolis parameter with the
            betaplane option."
        datatype: real
        units: s-1
        value:
            $OCN_GRID == "MISOMIP": -1.40871E-04
    LIGHTEST_DENSITY:
        description: |
            "[kg m-3] default = 1027.0
            The reference potential density used for the surface
            interface."
        datatype: real
        units: kg m-3
        value:
            $OCN_GRID == "MISOMIP": 1027.1524
    DENSITY_RANGE:
        description: |
            "[kg m-3] default = 2.0
            The range of reference potential densities across
            all interfaces."
        datatype: real
        units: kg m-3
        value:
            $OCN_GRID == "MISOMIP": 0.7438856
    THICKNESS_CONFIG:
        description: |
            "A string that determines how the initial layer
            thicknesses are specified for a new run:
            file - read interface heights from the file specified
            thickness_file - read thicknesses from the file specified
            by (THICKNESS_FILE).
            coord - determined by ALE coordinate.
            uniform - uniform thickness layers evenly distributed
            between the surface and MAXIMUM_DEPTH.
            DOME - use a slope and channel configuration for the
            DOME sill-overflow test case.
            ISOMIP - use a configuration for the
            ISOMIP test case.
            benchmark - use the benchmark test case thicknesses.
            search - search a density profile for the interface
            densities. This is not yet implemented.
            circle_obcs - the circle_obcs test case is used.
            DOME2D - 2D version of DOME initialization.
            adjustment2d - TBD AJA.
            sloshing - TBD AJA.
            seamount - TBD AJA.
            rossby_front - a mixed layer front in thermal wind balance.
            USER - call a user modified routine."
        datatype: string
        value:
            $RUN_TYPE == "hybrid":
                "thickness_file"
            else:
                $OCN_GRID == "MISOMIP": "ISOMIP"
    THICKNESS_FILE:
        description: "The name of the thickness file"
        datatype: string
        value:
            $RUN_TYPE == "hybrid":
                = f'./{$RUN_REFCASE}.mom6{$INST_SUFFIX}.r.{$RUN_REFDATE}-{$RUN_REFTOD}.nc'
    SPONGE_CONFIG:
        description: |
            "default = 'file'
            A string that sets how the sponges are configured:
            ISOMIP - use a configuration for the
            ISOMIP test case.
            USER - call a user modified routine."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "ISOMIP"
    MIN_THICKNESS:
        description: |
            "[m] default = 0.001
            Minimum layer thickness"
        datatype: real
        units: m
        value:
            $OCN_GRID == "MISOMIP": 1.0E-12
    HYCOM1_ONLY_IMPROVES:
        description: |
            "[Boolean] default = False
             When regridding, an interface is only moved if this improves the fit to the
             target density."
        datatype: logical
        units: Boolean
        value:
            $MOM6_VERTICAL_GRID == "hycom1" and $OCN_GRID == "tx2_3v2": True
    ISOMIP_TNUDG:
        description: |
            "default = 0.0 (days)
            Nudging time scale for sponge layers"
        datatype: real
        value:
            $OCN_GRID == "MISOMIP": 0.1
    TS_CONFIG:
        description: |
            "A string that determines how the initial tempertures
            and salinities are specified for a new run:
            file - read velocities from the file specified
            by (TS_FILE).
            fit - find the temperatures that are consistent with
            the layer densities and salinity S_REF.
            TS_profile - use temperature and salinity profiles
            (read from TS_FILE) to set layer densities.
            benchmark - use the benchmark test case T & S.
            linear - linear in logical layer space.
            DOME2D - 2D DOME initialization.
            ISOMIP - ISOMIP initialization.
            adjustment2d - TBD AJA.
            sloshing - TBD AJA.
            seamount - TBD AJA.
            rossby_front - a mixed layer front in thermal wind balance.
            SCM_ideal_hurr - used in the SCM idealized hurricane test.
            USER - call a user modified routine."
        datatype: string
        value:
            $RUN_TYPE == "hybrid":
                "file"
            else:
                $OCN_GRID == "MISOMIP": "ISOMIP"
    TS_FILE:
        description: "The initial condition file for the temperature and salinity."
        datatype: string
        value:
            $RUN_TYPE == "hybrid":
                = f'./{$RUN_REFCASE}.mom6{$INST_SUFFIX}.r.{$RUN_REFDATE}-{$RUN_REFTOD}.nc'
    TEMP_IC_VAR:
        description: "The initial condition variable for potential temperature"
        datatype: string
        value:
            $RUN_TYPE == "hybrid": "Temp"
    SALT_IC_VAR:
        description: "The initial condition variable for the salinity."
        datatype: string
        value:
            $RUN_TYPE == "hybrid": "Salt"
    VELOCITY_CONFIG:
        description: "A string that determines how the initial velocities are specified for a new run."
        datatype: string
        value:
            $RUN_TYPE == "hybrid": "file"
    VELOCITY_FILE:
        description: "The name of the velocity initial condition file."
        datatype: string
        value:
            $RUN_TYPE == "hybrid":
                = f'./{$RUN_REFCASE}.mom6{$INST_SUFFIX}.r.{$RUN_REFDATE}-{$RUN_REFTOD}.nc'
    AGE_IC_FILE:
        description: |
            "The file in which the age-tracer initial values can be found, or an empty
            string for internal initialization."
        datatype: string
        value:
            $RUN_TYPE == "hybrid" and $CONTINUE_RUN == False:
                = f'./{$RUN_REFCASE}.mom6{$INST_SUFFIX}.r.{$RUN_REFDATE}-{$RUN_REFTOD}.nc'
    T_REF:
        description: |
            "[degC]
            A reference temperature used in initialization."
        datatype: real
        units: degC
        value:
            $OCN_GRID == "MISOMIP": -1.9
    FIT_SALINITY:
        description: |
            "[Boolean] default = False
            If true, accept the prescribed temperature and fit the
            salinity; otherwise take salinity and fit temperature."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    TRIM_IC_FOR_P_SURF:
        description: |
            "[Boolean] default = False
            If true, cuts way the top of the column for initial conditions
            at the depth where the hydrostatic presure matches the imposed
            surface pressure which is read from file."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    SURFACE_PRESSURE_FILE:
        description: |
            "The initial condition file for the surface height."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "MISOMIP_181108.nc"
    SURFACE_PRESSURE_VAR:
        description: |
            "[kg m-2] default = ''
            The initial condition variable for the surface height."
        datatype: string
        units: kg m-2
        value:
            $OCN_GRID == "MISOMIP": "thick"
    SURFACE_PRESSURE_SCALE:
        description: |
            "[file dependent] default = 1.0
            A scaling factor to convert SURFACE_PRESSURE_VAR from
            file SURFACE_PRESSURE_FILE into a surface pressure."
        datatype: real
        units: file dependent
        value:
            $OCN_GRID == "MISOMIP": 8996.40
    SPONGE:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    HTBL_SHELF_MIN:
        description: |
            "[m] default = 2.0
            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."
        datatype: real
        units: m
        value:
            $OCN_GRID == "MISOMIP": 20.0
    KV:
        description: |
            "[m2 s-1]
            kinematic viscosity in the interior. The molecular value, ~1e-6
            m2 s-1, may be used."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx2_3v2": 1.0E-06
            else: 1.0E-04
    KV_BBL_MIN:
        description: |
            "[m2 s-1] default = 1.0E-04
            The minimum viscosities in the bottom boundary layer."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx0.25v1": 0.0
    KV_TBL_MIN:
        description: |
            "[m2 s-1] default = 1.0E-04
            The minimum viscosities in the top boundary layer."
        datatype: real
        units: m2 s-1
        value:
            $OCN_GRID == "tx0.25v1": 0.0
            $OCN_GRID == "MISOMIP": 0.01
    BE:
        description: |
            "[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."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "MISOMIP": 0.7
    CORIOLIS_SCHEME:
        description: |
            "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"
        datatype: string
        value:
            $OCN_GRID == "tx0.25v1": "SADOURNY75_ENSTRO"
    CORIOLIS_EN_DIS:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    HARMONIC_BL_SCALE:
        description: |
            "[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."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "MISOMIP": 1.0
    DYNAMIC_SURFACE_PRESSURE:
        description: |
            "[Boolean] default = False
            If true, add a dynamic pressure due to a viscous ice
            shelf, for instance."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
            $OCN_GRID == "tx0.25v1": True
    CORRECT_DENSITY:
        description: |
            "[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)."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": False
    BBL_EFFIC:
        description: |
            "[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."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "MISOMIP": 0.0
    IGNORE_FLUXES_OVER_LAND:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    VARIABLE_WINDS:
        description: |
            "[Boolean] default = True
            If true, the winds vary in time after the initialization."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": False
    VARIABLE_BUOYFORCE:
        description: |
            "[Boolean] default = True
            If true, the buoyancy forcing varies in time after the
            initialization of the model."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": False
    BUOY_CONFIG:
        description: |
            "The character string that indicates how buoyancy forcing
            is specified. Valid options include (file), (zero),
            (linear), (USER), and (NONE)."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "zero"
    WIND_CONFIG:
        description: |
            "The character string that indicates how wind forcing
            is specified. Valid options include (file), (2gyre),
            (1gyre), (gyres), (zero), and (USER)."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "zero"
    ICE_SHELF:
        description: |
            "[Boolean] default = False
            If true, enables the ice shelf model."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    SHELF_THERMO:
        description: |
            "[Boolean] default = False
            If true, use a thermodynamically interactive ice shelf."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    MELTING_CUTOFF_DEPTH:
        description: |
            "[not defined] default = 0.0
            Depth above which the melt is set to zero (it must be >= 0)
            Default value won't affect the solution."
        datatype: real
        units: not defined
        value:
            $OCN_GRID == "MISOMIP": 90.0
    DENSITY_ICE:
        description: |
            "[kg m-3] default = 900.0
            A typical density of ice."
        datatype: real
        units: kg m-3
        value:
            $OCN_GRID == "MISOMIP": 918.0
    SHELF_INSULATOR:
        description: |
            "TODO"
        datatype: logical
        value:
            $OCN_GRID == "MISOMIP": True
    SHELF_3EQ_GAMMA:
        description: |
            "TODO"
        datatype: logical
        value:
            $OCN_GRID == "MISOMIP": True
    SHELF_3EQ_GAMMA_T:
        description: |
            "TODO"
        datatype: real
        value:
            $OCN_GRID == "MISOMIP": 0.087
    SHELF_S_ROOT:
        description: |
            "TODO"
        datatype: logical
        value:
            $OCN_GRID == "MISOMIP": True
    SHELF_2EQ_GAMMA_T:
        description: |
            "[m s-1]
            If SHELF_THREE_EQN is false, this the fixed turbulent
            exchange velocity at the ice-ocean interface."
        datatype: real
        units: m s-1
        value:
            $OCN_GRID == "MISOMIP": 0.0
    ICE_SHELF_TEMPERATURE:
        description: |
            "[degC] default = -15.0
            The temperature at the center of the ice shelf."
        datatype: real
        units: degC
        value:
            $OCN_GRID == "MISOMIP": -20.0
    DT_FORCING:
        description: |
            "[s] default = 0.0
            The time step for changing forcing, coupling with other
            components, or potentially writing certain diagnostics.
            The default value is given by DT."
        datatype: real
        units: s
        value:
            $OCN_GRID == "MISOMIP": 300.0
    COL_THICK_MELT_THRESHOLD:
        description: |
            "[m] default = 0.0
            The minimum ML thickness where melting is allowed."
        datatype: real
        units: m
        value:
            $OCN_GRID == "MISOMIP": 10.0
    WRITE_OUTPUT_TO_FILE:
        description: |
            "[Boolean] default = False
            for debugging purposes"
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": True
    UTIDE:
        description: |
            "[m s-1] default = 0.0"
        datatype: real
        units: m s-1
        value:
            $OCN_GRID == "MISOMIP": 0.01
    ICE_PROFILE_CONFIG:
        description: |
            "This specifies how the initial ice profile is specified.
            Valid values are: CHANNEL, FILE, and USER."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "FILE"
    ICE_THICKNESS_FILE:
        description: |
            "default = 'ice_shelf_h.nc'
            The file from which the bathymetry is read."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "MISOMIP_181108.nc"
    ICE_THICKNESS_VARNAME:
        description: |
            "default = 'h_shelf'
            The name of the thickness variable in ICE_THICKNESS_FILE."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "thick"
    ICE_AREA_VARNAME:
        description: |
            "default = 'area_shelf_h'
            The name of the area variable in ICE_THICKNESS_FILE."
        datatype: string
        value:
            $OCN_GRID == "MISOMIP": "area"
    CALCULATE_APE:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": False
    DATE_STAMPED_STDOUT:
        description: |
            "[Boolean] default = True
            If true, use dates (not times) in messages to stdout"
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "MISOMIP": False
    DAYMAX:
        description: |
            "[days]
            The final time of the whole simulation, in units of
            TIMEUNIT seconds.  This also sets the potential end
            time of the present run segment if the end time is
            not set via ocean_solo_nml in input.nml."
        datatype: real
        units: days
        value:
            $OCN_GRID == "MISOMIP": 2.0
    INTERPOLATION_SCHEME:
        description: |
            "TODO"
        datatype: string
        value:
            $MOM6_VERTICAL_GRID == "MISOMIP": "PPM_H4"
            else: "PPM_CW"
    MLE_USE_PBL_MLD:
        description: |
            "TODO"
        datatype: logical
        value:
            $OCN_GRID == "tx0.25v1": True
            $OCN_GRID == "MISOMIP": True
    EPBL_IS_ADDITIVE:
        description: |
            "[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."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx0.25v1": False
    GEOTHERMAL_SCALE:
        description: |
            "[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."
        datatype: real
        units: W m-2 or various
        value:
            $OCN_GRID == "tx2_3v2": 1.0
            $OCN_GRID == "tx0.25v1": 1.0
    GEOTHERMAL_FILE:
        description: |
            "default = ''
            The file from which the geothermal heating is to be
            read, or blank to use a constant heating rate."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "geothermal_davies2013_tx2_3_20240318_cdf5.nc"
            $OCN_GRID == "tx0.25v1": "geothermal_davies2013_v1.nc"
    GEOTHERMAL_VARNAME:
        description: |
            "default = 'geo_heat'
            The name of the geothermal heating variable in
            GEOTHERMAL_FILE."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "geothermal_hf"
            $OCN_GRID == "tx0.25v1": "geothermal_hf"
    MIX_BOUNDARY_TRACER_ALE:
        description: |
            "[Boolean] default = True
            If true and in ALE mode, mix the passive tracers in massless layers at the
            bottom into the interior as though a diffusivity of KD_MIN_TR were operating."
        datatype: logical
        units: Boolean
        value: True
    USE_WAVES:
        description: |
            "default = False
            If true, enables surface wave modules."
        datatype: logical
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD != "none": True
    WAVE_METHOD:
        description: |
            "Choice of wave method, valid options include:
             TEST_PROFILE  - Prescribed from surface Stokes drift...
             SURFACE_BANDS - Computed from multiple surface values...
             DHH85         - Uses Donelan et al. 1985 empirical...
             LF17          - Infers Stokes drift profile from wind...
             EFACTOR       - Applies an enhancement factor to the KPP...""
        datatype: string
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy" : "EFACTOR"
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "SURFACE_BANDS"
    SURFBAND_SOURCE:
        description: |
            Choice of SURFACE_BANDS data mode, valid options include:
            DATAOVERRIDE  - Read from NetCDF using FMS DataOverride.
            COUPLER       - Look for variables from coupler pass
            INPUT         - Testing with fixed values.
        datatype: string
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "COUPLER"
    STOKES_DDT:
        description: |
            default = False
            Flag to use Stokes d/dt
        datatype: string
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
    STOKES_VF:
        description: |
            default = False
            Flag to use Stokes vortex force
        datatype: string
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
    STOKES_PGF:
        description: |
            default = False
            Flag to use Stokes pressure gradient force
        datatype: string
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
    STK_BAND_COUPLER:
        description: |
            default = 1
            STK_BAND_COUPLER is the number of Stokes drift bands in the coupler. This has
            to be consistent with the number of Stokes drift bands in WW3, or the model
            will fail.
        datatype: int
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": 3
    SURFBAND_WAVENUMBERS:
        description: |
            [rad/m] default = 0.12566
            Central wavenumbers for surface Stokes drift bands.
        datatype: string
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "0.04, 0.11, 0.33"
    IO_LAYOUT:
        description: |
            The processor layout to be used, or 0,0 to automatically set the io_layout to
            be the same as the layout.
        datatype: list
        value:
            $OCN_GRID == "tx0.25v1": 4, 3
            else: 1, 1
    AUTO_MASKTABLE:
        description: |
            Turn on automatic mask table generation to eliminate land blocks
        datatype: list
        value:
            $OCN_GRID in ["tx2_3v2", "tx0.25v1"]: True
    TARGET_IO_PES:
        description: |
            When AUTO_MASKTABLE is enabled, target number of IO PEs. If the given target
            number of IO PEs is not achievable, the target number of IO PEs is set to the
            nearest smaller number of PEs that is achievable.
        datatype: integer
        value:
            $OCN_GRID == "tx2_3v2" and $TEST: = - ( - $NTASKS_OCN // 256)
            $OCN_GRID == "tx0.25v1": = - ( - $NTASKS_OCN // 128)
    GEOM_FILE:
        description: |
            default = ocean_geometry.nc
            The file into which to write the ocean geometry.
        datatype: string
        value:
            "${CASE}.mom6.h.ocean_geometry.nc"
    RESTART_CHECKSUMS_REQUIRED:
        description: |
            "[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.
        datatype: logical
        value: $TEST
    ENSEMBLE_APPENDIX_PREFIX:
        description: |
            "default = ''
            The prefix for the restart file appendix (i.e., ensemble id for ensemble
            runs). If this prefix is found in the restart file name, the appendix is added
            right after the first occurrence of the prefix. If not found, the appendix is
            added to the end of the file name. This parameter is ignored for non-ensemble runs."
        datatype: string
        value: ".mom6"
    DO_SKEB:
        description: |
            "default = False
            If true, then stochastically perturb the currents using the stochastic kinetic
            energy backscatter scheme."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    SKEB_USE_FRICT:
        description: |
            "default = False
            If true, adds horizontal friction dissipation rate to the SKEBS amplitude."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    SKEB_USE_GM:
        description: |
            "default = False
            If true, adds GM work rate to the SKEBS amplitude."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    SKEB_NPASS:
        description: |
            "[nondim] default = 0
             number of passes of a 9-point smoother of the dissipation estimate."
        datatype: integer
        value:
           $OCN_GRID == "tx2_3v2": 8
    SKEB_GM_COEF:
        description: |
            "[nondim] default = 0.0
            Fraction of GM work that is added to backscatter rate."
        datatype: real
        value:
           $OCN_GRID == "tx2_3v2": 0.75
CVMix_CONVECTION:
    BV_SQR_CONV:
        description: |
            "[1/s^2] default = 0.0
            Threshold for squared buoyancy frequency needed to trigger Brunt-Vaisala
            parameterization."
        datatype: real
        units: 1/s^2
        value:
            $OCN_GRID == "tx2_3v2": -1.0E-08
KPP:
    N_SMOOTH:
        description: |
            "default = 0
            The number of times the 1-1-4-1-1 Laplacian filter is applied on
            OBL depth purely for diagnostic purposes."
        datatype: integer
        value:
            $OCN_GRID == "tx2_3v2": 3
    MATCH_TECHNIQUE:
        description: |
            "default = 'SimpleShapes'
            CVMix method to set profile function for diffusivity and NLT,
            as well as matching across OBL base. Allowed values are:
            SimpleShapes      = sigma*(1-sigma)^2 for both diffusivity and NLT
            MatchGradient     = sigma*(1-sigma)^2 for NLT; diffusivity profile from matching
            MatchBoth         = match gradient for both diffusivity and NLT
            ParabolicNonLocal = sigma*(1-sigma)^2 for diffusivity; (1-sigma)^2 for NLT"
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "MatchGradient"
    INTERP_TYPE2:
        description: |
            "Type of interpolation to compute diff and visc at OBL_depth
            Allowed types are: linear, quadratic, cubic or LMD94."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "LMD94"
    KPP_IS_ADDITIVE:
        description: |
            "[Boolean] default = True
            If true, adds KPP diffusivity to diffusivity from other schemes.If false, KPP is
            the only diffusivity wherever KPP is non-zero."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": False
    USE_KPP_LT_K:
        description: |
            default = False
            Flag for Langmuir turbulence enhancement of turbulentmixing coefficient.
        datatype: logical
        units: Boolean
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy": True
    USE_KPP_LT_VT2:
        description: |
            default = False
            Flag for Langmuir turbulence enhancement of Vt2in Bulk Richardson Number.
        datatype: logical
        units: Boolean
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy": True
    KPP_LT_K_METHOD:
        description: |
            default = "CONSTANT"
            Method to enhance mixing coefficient in KPP. Valid options are:
               CONSTANT = Constant value (KPP_K_ENH_FAC)
               VR12     = Function of Langmuir number based on VR12
               RW16     = Function of Langmuir number based on RW16
        datatype: string
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy" : VR12
    KPP_LT_VT2_METHOD:
        description: |
            default = "CONSTANT"
            Method to enhance Vt2 in KPP. Valid options are:
               CONSTANT = Constant value (KPP_VT2_ENH_FAC)
               VR12     = Function of Langmuir number based on VR12
               RW16     = Function of Langmuir number based on RW16
               LF17     = Function of Langmuir number based on LF17
        datatype: string
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD =="legacy" : VR12
    KPP_CVt2:
        description: |
            "[nondim] default = 1.6
            Parameter for Stokes MOST convection entrainment."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 1.8
    ENHANCE_DIFFUSION:
        description: |
            "default = True
            If True, adds enhanced diffusion at the based of the boundary layer."
        datatype: logical
        value:
            $OCN_GRID == "tx2_3v2": False
    STOKES_MOST:
        description: |
            "default = False
            If True, use Stokes Similarity package."
        datatype: logical
        value:
            $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
    COMPUTE_MONIN_OBUKHOV:
        description: |
            "default = False
            If True, limit the OBL depth to be no deeper than Monin-Obukhov depth."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    MINIMUM_OBL_DEPTH:
        description: |
            "[m] default = 0.0
            If non-zero, a minimum depth to use for KPP OBL depth. Independent of this
            parameter, the OBL depth is always at least as deep as the first layer."
        datatype: real
        value:
           $OCN_GRID == "tx2_3v2": 5.0

MLE:
    USE_BODNER23:
        description: |
            "[Boolean] default = False
            If true, use the Bodner et al., 2023, formulation of the re-stratifying
            mixed-layer restratification parameterization. This only works in ALE mode."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    CR:
        description: |
           "[nondim] default = 0.0
           The efficiency coefficient in eq 27 of Bodner et al., 2023."
        datatype: real
        units: nondim
        value:
            $OCN_GRID == "tx2_3v2": 0.01
    USE_CR_GRID:
        description: |
            "[Boolean] default = False
            true, read in a spatially varying Cr field."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    CR_FILE:
        description: |
            "The path to the file containing the Cr fields."
        datatype: string
        value:
            $OCN_GRID == "tx2_3v2": "mle-cr-mask_20250627.nc"
    WAVE_ENHANCED_USTAR:
        description: |
            "default = False
            If true, enhance ustar using surface waves, following Eq. 28 in Bodner23."
        datatype: logical
        units: Boolean
        value:
            $OCN_GRID == "tx2_3v2": True
    MIN_WSTAR2:
        description: |
            "[m2 s-2] default = 1.0E-24
            The minimum lower bound applied to the vertical momentum flux, w'u', in the
            Bodner et al. restratification parameterization. This avoids a division-by-zero
            in the limit when u* and the buoyancy flux are zero. The default is smaller
            than the product of the molecular viscosity of water and the Coriolis parameter
            one micron from the equator."
        datatype: real
        units: m2 s-2
        value:
            $OCN_GRID == "tx2_3v2": 1.0E-09
    BLD_DECAYING_TFILTER:
        description: |
            "default = 0.0
            The time scale for a running-mean filter applied to the boundary layer depth (BLD)
            when the BLD is shallower than the running mean. A value of 0 instantaneously sets
            the running mean to the current BLD value."
        datatype: real
        units: s
        value:
            $OCN_GRID == "tx2_3v2": 8.64E+04
    BLD_GROWING_TFILTER:
        description: |
            "[s] default = 0.0
            The time scale for a running-mean filter applied to the boundary layer depth (BLD)
            when the BLD is deeper than the running mean. A value of 0 instantaneously sets
            the running mean to the current BLD value."
        datatype: real
        units: s
        value:
            $OCN_GRID == "tx2_3v2": 300.0
    MLD_GROWING_TFILTER:
        description: |
            "[s] default = 0.0
            The time scale for a running-mean filter applied to the time-filtered boundary layer depth (BLD),
            when the filtered BLD is deeper than the running mean. A value of 0 instantaneously sets
            the running mean to the current filtered BLD value."
        datatype: real
        units: s
        value:
            $OCN_GRID == "tx2_3v2": 3600.0
    MLD_DECAYING_TFILTER:
        description: |
            "[s] default = 0.0
            The time scale for a running-mean filter applied to the time-filtered boundary layer depth (BLD),
            when the filtered BLD is shallower than the running mean. A value of 0 instantaneously sets
            the running mean to the current filtered BLD value."
        datatype: real
        units: s
        value:
            $OCN_GRID == "tx2_3v2": 2.592E+06
...