Skip to content

Add new parameter defaults for beta06 and fixes typo in diag_table #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add new parameter defaults for beta06 and fixes typo in diag_table #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b6f7792
Make params used in 2025.049 as default
gustavo-marques Apr 22, 2025
43c859d
Switch to mle-cr-tx2_3v2-v10_20250422.nc
gustavo-marques Apr 23, 2025
b19a23a
Fixes typo in the min/max for mlotst
gustavo-marques Apr 23, 2025
cafafd4
Merge branch 'main' into add_params_075
gustavo-marques Apr 23, 2025
07480dc
Introduced MLE configuration section
gustavo-marques Apr 23, 2025
0e96adc
Update CR_FILE to mle-cr-tx2_3v2-v10_20250423.nc
gustavo-marques Apr 23, 2025
cac6de7
Fix typo and add CR_FILE to input_data_list
gustavo-marques Apr 23, 2025
17eff12
Move BODNER_DETECT_MLD outside the MLE section
gustavo-marques Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 116 additions & 12 deletions param_templates/MOM_input.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,17 @@ Global:
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
Expand Down Expand Up @@ -1506,6 +1517,24 @@ Global:
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
Expand Down Expand Up @@ -1547,13 +1576,6 @@ Global:
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
Expand Down Expand Up @@ -3657,8 +3679,8 @@ Global:
nearest smaller number of PEs that is achievable.
datatype: integer
value:
$OCN_GRID == "tx2_3v2": = - ( - $NTASKS_OCN // 256)
$OCN_GRID == "tx0.25v1": = - ( - $NTASKS_OCN // 128)
$OCN_GRID == "tx2_3v2": = - ( - $NTASKS_OCN // 256)
$OCN_GRID == "tx0.25v1": = - ( - $NTASKS_OCN // 128)
GEOM_FILE:
description: |
default = ocean_geometry.nc
Expand Down Expand Up @@ -3692,8 +3714,7 @@ KPP:
description: |
"default = 0
The number of times the 1-1-4-1-1 Laplacian filter is applied on
OBL depth.
purely for diagnostic purposes."
OBL depth purely for diagnostic purposes."
datatype: integer
value:
$OCN_GRID == "tx2_3v2": 3
Expand Down Expand Up @@ -3762,6 +3783,14 @@ KPP:
datatype: string
value:
$COMP_WAV == "ww3": VR12
KPP_CVt2:
description: |
"[nondim] default = 1.6
Parameter for Stokes MOST convection entrainment."
datatype: real
units: nondim
value:
$OCN_GRID == "tx2_3v2": 1.0
STOKES_MOST:
description: |
default = False
Expand All @@ -3785,5 +3814,80 @@ KPP:
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
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-tx2_3v2-v10_20250423.nc"
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
...

22 changes: 11 additions & 11 deletions param_templates/diag_table.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ FieldLists:
- &tracers ["agessc", "T_ady_2d", "T_adx_2d", "T_diffy_2d", "T_diffx_2d",
"T_hbd_diffx_2d", 'T_hbd_diffy_2d']

- &surface_flds_common ["tos", "tos:tos_min:min", "tos:tos_max:max",
"sos", "sos:sos_min:min", "sos:sos_max:max",
- &surface_flds_common ["tos", "tos:tos_min:min", "tos:tos_max:max",
"sos", "sos:sos_min:min", "sos:sos_max:max",
"SSU", "SSV", "opottempmint", "somint", "Rd_dx", "speed",
"mlotst", "mlotst:mlots_min:min", "mlotst:mlots_max:max"]
"mlotst", "mlotst:mlotst_min:min", "mlotst:mlotst_max:max"]

- &surface_flds_daily ["zos", "zossq"]

- &surface_flds_monthly ["sst_global", "sss_global", "SSH", "mass_wt"]
Expand Down Expand Up @@ -73,8 +73,8 @@ FieldLists:
Files:
# sigma2
sigma2_hist:
suffix:
$TEST == True: "h.rho2%4yr-%2mo-%2dy"
suffix:
$TEST == True: "h.rho2%4yr-%2mo-%2dy"
else: "h.rho2%4yr-%2mo"
output_freq: 1
output_freq_units:
Expand All @@ -98,8 +98,8 @@ Files:
[ *cfc_3d ]
# native grid
hist:
suffix:
$TEST == True: "h.native%4yr-%2mo-%2dy"
suffix:
$TEST == True: "h.native%4yr-%2mo-%2dy"
else: "h.native%4yr-%2mo"
output_freq: 1
output_freq_units:
Expand Down Expand Up @@ -141,7 +141,7 @@ Files:

# essential variable mapped to z_space
hist_z_space:
suffix:
suffix:
$TEST == True: "h.z%4yr-%2mo-%2dy"
else: "h.z%4yr-%2mo"
output_freq: 1
Expand All @@ -167,7 +167,7 @@ Files:
[ *cfc_3d ]

surface_avg:
suffix:
suffix:
$TEST == True: "h.sfc%4yr-%2mo-%2dy"
else: "h.sfc%4yr-%2mo"
output_freq:
Expand All @@ -189,7 +189,7 @@ Files:
*surface_flds_daily,
*kpp_diags ]
forcing_avg:
suffix:
suffix:
$TEST == True: "h.frc%4yr-%2mo-%2dy"
else: "h.frc%4yr-%2mo"
output_freq: 1
Expand Down
4 changes: 2 additions & 2 deletions param_templates/input_data_list.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +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"
CR_FILE:
$OCN_GRID == "tx2_3v2": "${INPUTDIR}/mle-cr-tx2_3v2-v10_20250423.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
106 changes: 98 additions & 8 deletions param_templates/json/MOM_input.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,14 @@
"$OCN_GRID == \"tx2_3v2\"": true
}
},
"REMAPPING_USE_OM4_SUBCELLS": {
"description": "\"[Boolean] default = True\nThis selects the remapping algorithm used in OM4 that does not use the full\nreconstruction for the top- and lower-most sub-layers. Instead, it assumes\nthey are always vanished (which is untrue) and uses only their edge values.\nIt is recommended to set this option to false.\"\n",
"datatype": "bool",
"units": "none",
"value": {
"$OCN_GRID == \"tx2_3v2\"": false
}
},
"INIT_LAYERS_FROM_Z_FILE": {
"description": "\"[Boolean] default = False\nIf true, intialize the layer thicknesses, temperatures,\nand salnities from a Z-space file on a latitude-\nlongitude grid.\"\n",
"datatype": "logical",
Expand Down Expand Up @@ -1144,6 +1152,22 @@
"else": true
}
},
"BODNER_DETECT_MLD": {
"description": "\"[Boolean] default = False\nIf true, the Bodner parameterization will use the mixed-layer depth detected\nvia the density difference criterion defined by MLE_DENSITY_DIFF.\"\n",
"datatype": "bool",
"units": "none",
"value": {
"$OCN_GRID == \"tx2_3v2\"": true
}
},
"MLE_DENSITY_DIFF": {
"description": "\"[kg/m3] default = 0.03\nDensity difference used to detect the mixed-layer depth for the\nmixed-layer eddy parameterization by Fox-Kemper et al. (2010).\"\n",
"datatype": "real",
"units": "kg/m3",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 0.02
}
},
"FOX_KEMPER_ML_RESTRAT_COEF": {
"description": "\"[nondim] default = 0.0\nA nondimensional coefficient that is proportional to\nthe ratio of the deformation radius to the dominant\nlengthscale of the submesoscale mixed layer\ninstabilities, times the minimum of the ratio of the\nmesoscale eddy kinetic energy to the large-scale\ngeostrophic kinetic energy or 1 plus the square of the\ngrid spacing over the deformation radius, as detailed\nby Fox-Kemper et al. (2010)\nThe file that specifies the vertical grid for\ndepth-space diagnostics, or blank to disable\ndepth-space output.\nThe number of depth-space levels. This is determined\nfrom the size of the variable zw in the output grid file.\"\n",
"datatype": "real",
Expand All @@ -1170,13 +1194,6 @@
"$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",
Expand Down Expand Up @@ -2990,7 +3007,7 @@
},
"KPP": {
"N_SMOOTH": {
"description": "\"default = 0\nThe number of times the 1-1-4-1-1 Laplacian filter is applied on\nOBL depth.\npurely for diagnostic purposes.\"\n",
"description": "\"default = 0\nThe number of times the 1-1-4-1-1 Laplacian filter is applied on\nOBL depth purely for diagnostic purposes.\"\n",
"datatype": "integer",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 3
Expand Down Expand Up @@ -3048,6 +3065,14 @@
"$COMP_WAV == \"ww3\"": "VR12"
}
},
"KPP_CVt2": {
"description": "\"[nondim] default = 1.6\nParameter for Stokes MOST convection entrainment.\"\n",
"datatype": "real",
"units": "nondim",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 1.0
}
},
"STOKES_MOST": {
"description": "default = False\nIf True, use Stokes Similarity package.\n",
"datatype": "logical",
Expand All @@ -3070,5 +3095,70 @@
"$OCN_GRID == \"tx2_3v2\"": 5.0
}
}
},
"MLE": {
"USE_BODNER23": {
"description": "\"[Boolean] default = False\nIf true, use the Bodner et al., 2023, formulation of the re-stratifying\nmixed-layer restratification parameterization. This only works in ALE mode.\"\n",
"datatype": "logical",
"units": "Boolean",
"value": {
"$OCN_GRID == \"tx2_3v2\"": true
}
},
"USE_CR_GRID": {
"description": "\"[Boolean] default = False\ntrue, read in a spatially varying Cr field.\"\n",
"datatype": "logical",
"units": "Boolean",
"value": {
"$OCN_GRID == \"tx2_3v2\"": true
}
},
"CR_FILE": {
"description": "\"The path to the file containing the Cr fields.\"\n",
"datatype": "string",
"value": {
"$OCN_GRID == \"tx2_3v2\"": "mle-cr-tx2_3v2-v10_20250423.nc"
}
},
"MIN_WSTAR2": {
"description": "\"[m2 s-2] default = 1.0E-24\nThe minimum lower bound applied to the vertical momentum flux, w'u', in the\nBodner et al. restratification parameterization. This avoids a division-by-zero\nin the limit when u* and the buoyancy flux are zero. The default is smaller\nthan the product of the molecular viscosity of water and the Coriolis parameter\none micron from the equator.\"\n",
"datatype": "real",
"units": "m2 s-2",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 1e-09
}
},
"BLD_DECAYING_TFILTER": {
"description": "\"default = 0.0\nThe time scale for a running-mean filter applied to the boundary layer depth (BLD)\nwhen the BLD is shallower than the running mean. A value of 0 instantaneously sets\nthe running mean to the current BLD value.\"\n",
"datatype": "real",
"units": "s",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 86400.0
}
},
"BLD_GROWING_TFILTER": {
"description": "\"[s] default = 0.0\nThe time scale for a running-mean filter applied to the boundary layer depth (BLD)\nwhen the BLD is deeper than the running mean. A value of 0 instantaneously sets\nthe running mean to the current BLD value.\"\n",
"datatype": "real",
"units": "s",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 300.0
}
},
"MLD_GROWING_TFILTER": {
"description": "\"[s] default = 0.0\nThe time scale for a running-mean filter applied to the time-filtered boundary layer depth (BLD),\nwhen the filtered BLD is deeper than the running mean. A value of 0 instantaneously sets\nthe running mean to the current filtered BLD value.\"\n",
"datatype": "real",
"units": "s",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 3600.0
}
},
"MLD_DECAYING_TFILTER": {
"description": "\"[s] default = 0.0\nThe time scale for a running-mean filter applied to the time-filtered boundary layer depth (BLD),\nwhen the filtered BLD is shallower than the running mean. A value of 0 instantaneously sets\nthe running mean to the current filtered BLD value.\"\n",
"datatype": "real",
"units": "s",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 2592000.0
}
}
}
}
Loading