Skip to content
Merged
71 changes: 52 additions & 19 deletions param_templates/MOM_input.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -1052,10 +1060,12 @@ Global:
value:
$OCN_GRID == "tx0.25v1": 0.01
$OCN_GRID == "MISOMIP": 0.001
LEITH_AH:
USE_LEITHY:
description: |
"[Boolean] default = False
If true, use a biharmonic Leith nonlinear eddy viscosity."
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:
Expand All @@ -1068,7 +1078,7 @@ Global:
datatype: real
units: nondim
value:
$OCN_GRID == "tx2_3v2": 128.0
$OCN_GRID == "tx2_3v2": 90.0
USE_LAND_MASK_FOR_HVISC:
description: |
"[Boolean] default = False
Expand Down Expand Up @@ -1502,8 +1512,22 @@ Global:
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": True
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_20250108.nc"
MLE_MLD_DECAY_TIME:
description: |
"[s] default = 0.0
Expand Down Expand Up @@ -1587,7 +1611,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
Expand All @@ -1609,7 +1633,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
Expand All @@ -1620,7 +1644,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: |
Expand Down Expand Up @@ -2564,7 +2588,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
Expand Down Expand Up @@ -2697,13 +2721,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
Expand Down Expand Up @@ -3150,7 +3167,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: |
Expand Down Expand Up @@ -3698,6 +3715,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
...

5 changes: 4 additions & 1 deletion param_templates/input_data_list.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]:
Expand All @@ -34,14 +35,16 @@ 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"
$OCN_GRID == "tx0.25v1": "${INPUTDIR}/geothermal_davies2013_v1.nc"
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_20250108.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"
Expand Down
62 changes: 46 additions & 16 deletions param_templates/json/MOM_input.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -802,8 +810,8 @@
"$OCN_GRID == \"MISOMIP\"": 0.001
}
},
"LEITH_AH": {
"description": "\"[Boolean] default = False\nIf true, use a biharmonic Leith nonlinear eddy viscosity.\"\n",
"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": {
Expand All @@ -815,7 +823,7 @@
"datatype": "real",
"units": "nondim",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 128.0
"$OCN_GRID == \"tx2_3v2\"": 90.0
}
},
"USE_LAND_MASK_FOR_HVISC": {
Expand Down Expand Up @@ -1128,10 +1136,24 @@
"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\nIf true, the MLE front-length scale is read from a file.\"\n",
"datatype": "logical",
"units": "Boolean",
"value": {
"$OCN_GRID == \"tx2_3v2\"": true
}
},
"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_20250108.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",
Expand Down Expand Up @@ -1198,7 +1220,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
Expand All @@ -1217,15 +1239,15 @@
"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": {
"description": "\"[m2 s-1] default = 2.0E-07\nThe minimum diapycnal diffusivity.\nIf true, use an internal tidal dissipation scheme to\ndrive diapycnal mixing, along the lines of St. Laurent\net al. (2002) and Simmons et al. (2004).\"\n",
"datatype": "real",
"units": "m2 s-1",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 2e-07,
"$OCN_GRID == \"tx2_3v2\"": 1e-07,
"else": 2e-06
}
},
Expand Down Expand Up @@ -2026,7 +2048,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": {
Expand Down Expand Up @@ -2139,13 +2161,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",
Expand Down Expand Up @@ -2521,7 +2536,7 @@
"datatype": "real",
"units": "m2 s-1",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 0.0,
"$OCN_GRID == \"tx2_3v2\"": 1e-06,
"else": 0.0001
}
},
Expand Down Expand Up @@ -2997,6 +3012,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
}
}
}
}
6 changes: 5 additions & 1 deletion param_templates/json/input_data_list.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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": {
Expand All @@ -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_20250108.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"
Expand Down
Loading