diff --git a/param_templates/MOM_input.yaml b/param_templates/MOM_input.yaml index cfd77c9..88fbb17 100644 --- a/param_templates/MOM_input.yaml +++ b/param_templates/MOM_input.yaml @@ -220,7 +220,7 @@ Global: for backward compatibility but ideally should be 0." datatype: real units: PPT - value: + value: $COMP_ATM == "cam": 1.0e-6 else: 0.0 BOUND_SALINITY: @@ -560,6 +560,14 @@ Global: 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] @@ -990,7 +998,9 @@ Global: If true, use a Laplacian horizontal viscosity." datatype: logical units: Boolean - value: True + value: + $OCN_GRID == "tx2_3v2": False + else: True KH: description: | "[m2 s-1] default = 0.0 @@ -1052,6 +1062,16 @@ Global: 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": False LEITH_AH: description: | "[Boolean] default = False @@ -1069,6 +1089,14 @@ Global: units: nondim value: $OCN_GRID == "tx2_3v2": 128.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 @@ -1080,6 +1108,15 @@ Global: 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] @@ -1504,6 +1541,21 @@ Global: 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_FL_FILE: + description: | + "The path to the file containing the MLE + front-length scale.." + datatype: string + value: + $OCN_GRID == "tx2_3v2": "mle-lf-clim-tx2_3v2_20250115.nc" MLE_MLD_DECAY_TIME: description: | "[s] default = 0.0 @@ -1587,7 +1639,7 @@ Global: datatype: real units: m2 s-1 value: - $OCN_GRID == "tx2_3v2": 0.0 + $OCN_GRID == "tx2_3v2": 1.0E-07 $OCN_GRID == "tx0.25v1": 1.5E-05 $OCN_GRID == "MISOMIP": 5.0E-05 else: 2.0E-05 @@ -1609,7 +1661,7 @@ Global: 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-04 / 2.0E-05 + else: = 1.0E-06 / 1.0E-07 KD_MIN: description: | "[m2 s-1] default = 2.0E-07 @@ -1620,7 +1672,7 @@ Global: datatype: real units: m2 s-1 value: - $OCN_GRID == "tx2_3v2": 2.0E-07 + $OCN_GRID == "tx2_3v2": 1.0E-07 else: 2.0E-06 INT_TIDE_DECAY_SCALE: description: | @@ -2564,7 +2616,7 @@ Global: datatype: string value: $OCN_GRID == "tx0.25v1": "MOM_channels_global_025" - $OCN_GRID == "tx2_3v2": "MOM_channels_global_tx2_3v2_240501" + $OCN_GRID == "tx2_3v2": "channels_tx2_3v2_250107.txt" SMAG_BI_CONST: description: | "[nondim] default = 0.0 @@ -2697,13 +2749,6 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True - TOPO_EDITS_FILE: - description: | - "default = - The file from which to read a list of i,j,z topography overrides." - datatype: string - value: - $OCN_GRID == "tx0.25v1": "All_edits.nc" PARALLEL_RESTARTFILES: description: | "[Boolean] default = False @@ -2730,6 +2775,16 @@ Global: units: nondim value: $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": 2.0 + 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: @@ -3150,7 +3205,7 @@ Global: datatype: real units: m2 s-1 value: - $OCN_GRID == "tx2_3v2": 0.0 + $OCN_GRID == "tx2_3v2": 1.0E-06 else: 1.0E-04 KV_BBL_MIN: description: | @@ -3698,6 +3753,22 @@ KPP: If True, use Stokes Similarity package. datatype: logical value: - $COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True - + $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": 2.5 ... + diff --git a/param_templates/input_data_list.yaml b/param_templates/input_data_list.yaml index ea1c7e3..a855a75 100644 --- a/param_templates/input_data_list.yaml +++ b/param_templates/input_data_list.yaml @@ -18,6 +18,7 @@ mom.input_data_list: $OCN_GRID == "tx2_3v2": "${INPUTDIR}/ocean_topo_tx2_3v2_240501.nc" $OCN_GRID == "tx0.25v1": "${INPUTDIR}/ocean_topog.nc" TOPO_EDITS_FILE: + $OCN_GRID == "tx2_3v2": "${INPUTDIR}/topo_edits_tx2_3v2_250107.nc" $OCN_GRID == "tx0.25v1": "${INPUTDIR}/All_edits.nc" TEMP_SALT_Z_INIT_FILE: $OCN_GRID in ["tx2_3v2", "tx0.25v1"]: @@ -34,7 +35,7 @@ mom.input_data_list: $OCN_GRID == "tx2_3v2": "${INPUTDIR}/energy_new_tx2_3_conserve_230415_cdf5.nc" $OCN_GRID == "tx0.25v1": "${INPUTDIR}/tidal_amplitude.v20140616.nc" CHANNEL_LIST_FILE: - $OCN_GRID == "tx2_3v2": "${INPUTDIR}/MOM_channels_global_tx2_3v2_240501" + $OCN_GRID == "tx2_3v2": "${INPUTDIR}/channels_tx2_3v2_250107.txt" $OCN_GRID == "tx0.25v1": "${INPUTDIR}/MOM_channels_global_025" GEOTHERMAL_FILE: $OCN_GRID == "tx2_3v2": "${INPUTDIR}/geothermal_davies2013_tx2_3_20240318_cdf5.nc" @@ -42,6 +43,8 @@ mom.input_data_list: CHL_FILE: $OCN_GRID == "tx0.25v1": "${INPUTDIR}/seawifs-clim-1997-2010.1440x1080.v20180328.nc" $OCN_GRID == "tx2_3v2": "${INPUTDIR}/seawifs-clim-1997-2010-tx2_3v2.230416.nc" + MLE_FL_FILE: + $OCN_GRID == "tx2_3v2": "${INPUTDIR}/mle-lf-clim-tx2_3v2_20250115.nc" CFC_BC_FILE: "${DIN_LOC_ROOT}/ocn/mom/grid_indpt/cfc_atm_20230310.nc" DIAG_COORD_DEF_RHO2: $OCN_GRID == "tx2_3v2": "${INPUTDIR}/ocean_rho2_190917.nc" diff --git a/param_templates/json/MOM_input.json b/param_templates/json/MOM_input.json index 356fd6d..e286f17 100644 --- a/param_templates/json/MOM_input.json +++ b/param_templates/json/MOM_input.json @@ -429,6 +429,14 @@ "$OCN_GRID == \"tx0.25v1\"": "ocean_topog.nc" } }, + "TOPO_EDITS_FILE": { + "description": "\"default = ''\nThe file from which to read a list of i,j,z topography overrides.\"\n", + "datatype": "string", + "value": { + "$OCN_GRID == \"tx2_3v2\"": "topo_edits_tx2_3v2_250107.nc", + "$OCN_GRID == \"tx0.25v1\"": "All_edits.nc" + } + }, "MAXIMUM_DEPTH": { "description": "\"[m]\nThe maximum depth of the ocean.\"\n", "datatype": "real", @@ -747,7 +755,10 @@ "description": "\"[Boolean] default = False\nIf true, use a Laplacian horizontal viscosity.\"\n", "datatype": "logical", "units": "Boolean", - "value": true + "value": { + "$OCN_GRID == \"tx2_3v2\"": false, + "else": true + } }, "KH": { "description": "\"[m2 s-1] default = 0.0\nThe background Laplacian horizontal viscosity.\"\n", @@ -802,6 +813,14 @@ "$OCN_GRID == \"MISOMIP\"": 0.001 } }, + "USE_LEITHY": { + "description": "\"[Boolean] default = False\nIf true, use a modified version of the biharmonic Leith nonlinear\neddy viscosity. This implementation can include harmonic backscatter\nwhen LEITHY_CK > 0.\"\n", + "datatype": "logical", + "units": "Boolean", + "value": { + "$OCN_GRID == \"tx2_3v2\"": false + } + }, "LEITH_AH": { "description": "\"[Boolean] default = False\nIf true, use a biharmonic Leith nonlinear eddy viscosity.\"\n", "datatype": "logical", @@ -818,12 +837,26 @@ "$OCN_GRID == \"tx2_3v2\"": 128.0 } }, + "LEITHY_CK": { + "description": "\"[nondim] default = 1.0\nFraction of biharmonic dissipation that gets backscattered, in Leith+E.\"\n", + "datatype": "real", + "units": "nondim", + "value": { + "$OCN_GRID == \"tx2_3v2\"": 0.0 + } + }, "USE_LAND_MASK_FOR_HVISC": { "description": "\"[Boolean] default = False\nIf true, use Use the land mask for the computation of thicknesses\nat velocity locations. This eliminates the dependence on arbitrary\nvalues over land or outside of the domain. Default is False in order to\nmaintain answers with legacy experiments but should be changed to True\nfor new experiments.\"\n", "datatype": "logical", "units": "Boolean", "value": true }, + "FRICTWORK_BUG": { + "description": "\"[Boolean] default = True\nIf true, retain an answer-changing bug in calculating the FrictWork, which\ncancels the h in thickness flux and the h at velocity point. This is not\nrecommended.\"\n", + "datatype": "logical", + "units": "Boolean", + "value": false + }, "HMIX_FIXED": { "description": "\"[m]\nThe prescribed depth over which the near-surface\nviscosity and diffusivity are elevated when the bulk\nmixed layer is not used.\"\n", "datatype": "real", @@ -1132,6 +1165,21 @@ "$OCN_GRID == \"tx0.25v1\"": 500.0 } }, + "MLE_FRONT_LENGTH_FROM_FILE": { + "description": "\"[Boolean] default = False\nIf true, the MLE front-length scale is read from a file.\"\n", + "datatype": "logical", + "units": "Boolean", + "value": { + "$OCN_GRID == \"tx2_3v2\"": false + } + }, + "MLE_FL_FILE": { + "description": "\"The path to the file containing the MLE\nfront-length scale..\"\n", + "datatype": "string", + "value": { + "$OCN_GRID == \"tx2_3v2\"": "mle-lf-clim-tx2_3v2_20250115.nc" + } + }, "MLE_MLD_DECAY_TIME": { "description": "\"[s] default = 0.0\nThe time-scale for a running-mean filter applied to the mixed-layer\ndepth used in the MLE restratification parameterization. When\nthe MLD deepens below the current running-mean the running-mean\nis instantaneously set to the current MLD.\"\n", "datatype": "real", @@ -1198,7 +1246,7 @@ "datatype": "real", "units": "m2 s-1", "value": { - "$OCN_GRID == \"tx2_3v2\"": 0.0, + "$OCN_GRID == \"tx2_3v2\"": 1e-07, "$OCN_GRID == \"tx0.25v1\"": 1.5e-05, "$OCN_GRID == \"MISOMIP\"": 5e-05, "else": 2e-05 @@ -1217,7 +1265,7 @@ "value": { "$OCN_GRID == \"tx0.25v1\"": "= 1.0E-04 / 1.5E-05", "$OCN_GRID == \"MISOMIP\"": "= 1.0E-04 / 5.0E-05", - "else": "= 1.0E-04 / 2.0E-05" + "else": "= 1.0E-06 / 1.0E-07" } }, "KD_MIN": { @@ -1225,7 +1273,7 @@ "datatype": "real", "units": "m2 s-1", "value": { - "$OCN_GRID == \"tx2_3v2\"": 2e-07, + "$OCN_GRID == \"tx2_3v2\"": 1e-07, "else": 2e-06 } }, @@ -2026,7 +2074,7 @@ "datatype": "string", "value": { "$OCN_GRID == \"tx0.25v1\"": "MOM_channels_global_025", - "$OCN_GRID == \"tx2_3v2\"": "MOM_channels_global_tx2_3v2_240501" + "$OCN_GRID == \"tx2_3v2\"": "channels_tx2_3v2_250107.txt" } }, "SMAG_BI_CONST": { @@ -2139,13 +2187,6 @@ "$OCN_GRID == \"tx0.25v1\"": true } }, - "TOPO_EDITS_FILE": { - "description": "\"default =\nThe file from which to read a list of i,j,z topography overrides.\"\n", - "datatype": "string", - "value": { - "$OCN_GRID == \"tx0.25v1\"": "All_edits.nc" - } - }, "PARALLEL_RESTARTFILES": { "description": "\"[Boolean] default = False\nIf true, each processor writes its own restart file,\notherwise a single restart file is generated\"\n", "datatype": "logical", @@ -2170,6 +2211,12 @@ "$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": 2.0 } }, + "VISC_REM_BUG": { + "description": "\"[Boolean] default = True\nIf true, visc_rem_[uv] in split mode is incorrectly calculated or accounted\nfor in two places. This parameter controls the defaults of two individual\nflags, VISC_REM_TIMESTEP_BUG in MOM_dynamics_split_RK2(b) and\nVISC_REM_BT_WEIGHT_BUG in MOM_barotropic.\"\n", + "datatype": "logical", + "units": "Boolean", + "value": false + }, "REENTRANT_X": { "description": "\"[Boolean] default = True\nIf true, the domain is zonally reentrant.\"\n", "datatype": "logical", @@ -2521,7 +2568,7 @@ "datatype": "real", "units": "m2 s-1", "value": { - "$OCN_GRID == \"tx2_3v2\"": 0.0, + "$OCN_GRID == \"tx2_3v2\"": 1e-06, "else": 0.0001 } }, @@ -2997,6 +3044,21 @@ "value": { "$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true } + }, + "COMPUTE_MONIN_OBUKHOV": { + "description": "default = False\nIf True, limit the OBL depth to be no deeper than Monin-Obukhov depth.\n", + "datatype": "logical", + "units": "Boolean", + "value": { + "$OCN_GRID == \"tx2_3v2\"": true + } + }, + "MINIMUM_OBL_DEPTH": { + "description": "\"[m] default = 0.0\nIf non-zero, a minimum depth to use for KPP OBL depth. Independent of this\nparameter, the OBL depth is always at least as deep as the first layer.\"\n", + "datatype": "real", + "value": { + "$OCN_GRID == \"tx2_3v2\"": 2.5 + } } } } \ No newline at end of file diff --git a/param_templates/json/input_data_list.json b/param_templates/json/input_data_list.json index 5a116b2..a11d65d 100644 --- a/param_templates/json/input_data_list.json +++ b/param_templates/json/input_data_list.json @@ -22,6 +22,7 @@ "$OCN_GRID == \"tx0.25v1\"": "${INPUTDIR}/ocean_topog.nc" }, "TOPO_EDITS_FILE": { + "$OCN_GRID == \"tx2_3v2\"": "${INPUTDIR}/topo_edits_tx2_3v2_250107.nc", "$OCN_GRID == \"tx0.25v1\"": "${INPUTDIR}/All_edits.nc" }, "TEMP_SALT_Z_INIT_FILE": { @@ -43,7 +44,7 @@ "$OCN_GRID == \"tx0.25v1\"": "${INPUTDIR}/tidal_amplitude.v20140616.nc" }, "CHANNEL_LIST_FILE": { - "$OCN_GRID == \"tx2_3v2\"": "${INPUTDIR}/MOM_channels_global_tx2_3v2_240501", + "$OCN_GRID == \"tx2_3v2\"": "${INPUTDIR}/channels_tx2_3v2_250107.txt", "$OCN_GRID == \"tx0.25v1\"": "${INPUTDIR}/MOM_channels_global_025" }, "GEOTHERMAL_FILE": { @@ -54,6 +55,9 @@ "$OCN_GRID == \"tx0.25v1\"": "${INPUTDIR}/seawifs-clim-1997-2010.1440x1080.v20180328.nc", "$OCN_GRID == \"tx2_3v2\"": "${INPUTDIR}/seawifs-clim-1997-2010-tx2_3v2.230416.nc" }, + "MLE_FL_FILE": { + "$OCN_GRID == \"tx2_3v2\"": "${INPUTDIR}/mle-lf-clim-tx2_3v2_20250115.nc" + }, "CFC_BC_FILE": "${DIN_LOC_ROOT}/ocn/mom/grid_indpt/cfc_atm_20230310.nc", "DIAG_COORD_DEF_RHO2": { "$OCN_GRID == \"tx2_3v2\"": "${INPUTDIR}/ocean_rho2_190917.nc"