Skip to content

Commit fb5ce02

Browse files
gustavo-marquesgustavo-marques
authored
Add new parameter defaults for beta06 and fixes typo in diag_table (#252)
* Make params used in 2025.049 as default * Switch to mle-cr-tx2_3v2-v10_20250422.nc * Fixes typo in the min/max for mlotst * Introduced MLE configuration section Introduced MLE configuration section to enable the use of different mixed-layer eddy (MLE) parameterizations when USE_BODNER23 = True. * Update CR_FILE to mle-cr-tx2_3v2-v10_20250423.nc * Fix typo and add CR_FILE to input_data_list Because MLE_FL_FILE is no longer used, this commit updates the configuration to use CR_FILE instead. * Move BODNER_DETECT_MLD outside the MLE section * Correct values in mle-CR file Previous version contained incorrect values; this update fixes them.
1 parent 2e6c673 commit fb5ce02

6 files changed

Lines changed: 235 additions & 41 deletions

File tree

‎param_templates/MOM_input.yaml‎

Lines changed: 116 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -625,6 +625,17 @@ Global:
625625
units: Boolean
626626
value:
627627
$OCN_GRID == "tx2_3v2": True
628+
REMAPPING_USE_OM4_SUBCELLS:
629+
description: |
630+
"[Boolean] default = True
631+
This selects the remapping algorithm used in OM4 that does not use the full
632+
reconstruction for the top- and lower-most sub-layers. Instead, it assumes
633+
they are always vanished (which is untrue) and uses only their edge values.
634+
It is recommended to set this option to false."
635+
datatype: bool
636+
units: none
637+
value:
638+
$OCN_GRID == "tx2_3v2": False
628639
INIT_LAYERS_FROM_Z_FILE:
629640
description: |
630641
"[Boolean] default = False
@@ -1506,6 +1517,24 @@ Global:
15061517
value:
15071518
$OCN_GRID == "MISOMIP": False
15081519
else: True
1520+
BODNER_DETECT_MLD:
1521+
description: |
1522+
"[Boolean] default = False
1523+
If true, the Bodner parameterization will use the mixed-layer depth detected
1524+
via the density difference criterion defined by MLE_DENSITY_DIFF."
1525+
datatype: bool
1526+
units: none
1527+
value:
1528+
$OCN_GRID == "tx2_3v2": True
1529+
MLE_DENSITY_DIFF:
1530+
description: |
1531+
"[kg/m3] default = 0.03
1532+
Density difference used to detect the mixed-layer depth for the
1533+
mixed-layer eddy parameterization by Fox-Kemper et al. (2010)."
1534+
datatype: real
1535+
units: kg/m3
1536+
value:
1537+
$OCN_GRID == "tx2_3v2": 0.02
15091538
FOX_KEMPER_ML_RESTRAT_COEF:
15101539
description: |
15111540
"[nondim] default = 0.0
@@ -1547,13 +1576,6 @@ Global:
15471576
units: Boolean
15481577
value:
15491578
$OCN_GRID == "tx2_3v2": False
1550-
MLE_FL_FILE:
1551-
description: |
1552-
"The path to the file containing the MLE
1553-
front-length scale.."
1554-
datatype: string
1555-
value:
1556-
$OCN_GRID == "tx2_3v2": "mle-lf-clim-tx2_3v2_20250115.nc"
15571579
MLE_MLD_DECAY_TIME:
15581580
description: |
15591581
"[s] default = 0.0
@@ -3657,8 +3679,8 @@ Global:
36573679
nearest smaller number of PEs that is achievable.
36583680
datatype: integer
36593681
value:
3660-
$OCN_GRID == "tx2_3v2": = - ( - $NTASKS_OCN // 256)
3661-
$OCN_GRID == "tx0.25v1": = - ( - $NTASKS_OCN // 128)
3682+
$OCN_GRID == "tx2_3v2": = - ( - $NTASKS_OCN // 256)
3683+
$OCN_GRID == "tx0.25v1": = - ( - $NTASKS_OCN // 128)
36623684
GEOM_FILE:
36633685
description: |
36643686
default = ocean_geometry.nc
@@ -3692,8 +3714,7 @@ KPP:
36923714
description: |
36933715
"default = 0
36943716
The number of times the 1-1-4-1-1 Laplacian filter is applied on
3695-
OBL depth.
3696-
purely for diagnostic purposes."
3717+
OBL depth purely for diagnostic purposes."
36973718
datatype: integer
36983719
value:
36993720
$OCN_GRID == "tx2_3v2": 3
@@ -3762,6 +3783,14 @@ KPP:
37623783
datatype: string
37633784
value:
37643785
$COMP_WAV == "ww3": VR12
3786+
KPP_CVt2:
3787+
description: |
3788+
"[nondim] default = 1.6
3789+
Parameter for Stokes MOST convection entrainment."
3790+
datatype: real
3791+
units: nondim
3792+
value:
3793+
$OCN_GRID == "tx2_3v2": 1.0
37653794
STOKES_MOST:
37663795
description: |
37673796
default = False
@@ -3785,5 +3814,80 @@ KPP:
37853814
datatype: real
37863815
value:
37873816
$OCN_GRID == "tx2_3v2": 5.0
3817+
MLE:
3818+
USE_BODNER23:
3819+
description: |
3820+
"[Boolean] default = False
3821+
If true, use the Bodner et al., 2023, formulation of the re-stratifying
3822+
mixed-layer restratification parameterization. This only works in ALE mode."
3823+
datatype: logical
3824+
units: Boolean
3825+
value:
3826+
$OCN_GRID == "tx2_3v2": True
3827+
USE_CR_GRID:
3828+
description: |
3829+
"[Boolean] default = False
3830+
true, read in a spatially varying Cr field."
3831+
datatype: logical
3832+
units: Boolean
3833+
value:
3834+
$OCN_GRID == "tx2_3v2": True
3835+
CR_FILE:
3836+
description: |
3837+
"The path to the file containing the Cr fields."
3838+
datatype: string
3839+
value:
3840+
$OCN_GRID == "tx2_3v2": "mle-cr-tx2_3v2-v10_20250426.nc"
3841+
MIN_WSTAR2:
3842+
description: |
3843+
"[m2 s-2] default = 1.0E-24
3844+
The minimum lower bound applied to the vertical momentum flux, w'u', in the
3845+
Bodner et al. restratification parameterization. This avoids a division-by-zero
3846+
in the limit when u* and the buoyancy flux are zero. The default is smaller
3847+
than the product of the molecular viscosity of water and the Coriolis parameter
3848+
one micron from the equator."
3849+
datatype: real
3850+
units: m2 s-2
3851+
value:
3852+
$OCN_GRID == "tx2_3v2": 1.0E-09
3853+
BLD_DECAYING_TFILTER:
3854+
description: |
3855+
"default = 0.0
3856+
The time scale for a running-mean filter applied to the boundary layer depth (BLD)
3857+
when the BLD is shallower than the running mean. A value of 0 instantaneously sets
3858+
the running mean to the current BLD value."
3859+
datatype: real
3860+
units: s
3861+
value:
3862+
$OCN_GRID == "tx2_3v2": 8.64E+04
3863+
BLD_GROWING_TFILTER:
3864+
description: |
3865+
"[s] default = 0.0
3866+
The time scale for a running-mean filter applied to the boundary layer depth (BLD)
3867+
when the BLD is deeper than the running mean. A value of 0 instantaneously sets
3868+
the running mean to the current BLD value."
3869+
datatype: real
3870+
units: s
3871+
value:
3872+
$OCN_GRID == "tx2_3v2": 300.0
3873+
MLD_GROWING_TFILTER:
3874+
description: |
3875+
"[s] default = 0.0
3876+
The time scale for a running-mean filter applied to the time-filtered boundary layer depth (BLD),
3877+
when the filtered BLD is deeper than the running mean. A value of 0 instantaneously sets
3878+
the running mean to the current filtered BLD value."
3879+
datatype: real
3880+
units: s
3881+
value:
3882+
$OCN_GRID == "tx2_3v2": 3600.0
3883+
MLD_DECAYING_TFILTER:
3884+
description: |
3885+
"[s] default = 0.0
3886+
The time scale for a running-mean filter applied to the time-filtered boundary layer depth (BLD),
3887+
when the filtered BLD is shallower than the running mean. A value of 0 instantaneously sets
3888+
the running mean to the current filtered BLD value."
3889+
datatype: real
3890+
units: s
3891+
value:
3892+
$OCN_GRID == "tx2_3v2": 2.592E+06
37883893
...
3789-

‎param_templates/diag_table.yaml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ FieldLists:
1515
- &tracers ["agessc", "T_ady_2d", "T_adx_2d", "T_diffy_2d", "T_diffx_2d",
1616
"T_hbd_diffx_2d", 'T_hbd_diffy_2d']
1717

18-
- &surface_flds_common ["tos", "tos:tos_min:min", "tos:tos_max:max",
19-
"sos", "sos:sos_min:min", "sos:sos_max:max",
18+
- &surface_flds_common ["tos", "tos:tos_min:min", "tos:tos_max:max",
19+
"sos", "sos:sos_min:min", "sos:sos_max:max",
2020
"SSU", "SSV", "opottempmint", "somint", "Rd_dx", "speed",
21-
"mlotst", "mlotst:mlots_min:min", "mlotst:mlots_max:max"]
22-
21+
"mlotst", "mlotst:mlotst_min:min", "mlotst:mlotst_max:max"]
22+
2323
- &surface_flds_daily ["zos", "zossq"]
2424

2525
- &surface_flds_monthly ["sst_global", "sss_global", "SSH", "mass_wt"]
@@ -73,8 +73,8 @@ FieldLists:
7373
Files:
7474
# sigma2
7575
sigma2_hist:
76-
suffix:
77-
$TEST == True: "h.rho2%4yr-%2mo-%2dy"
76+
suffix:
77+
$TEST == True: "h.rho2%4yr-%2mo-%2dy"
7878
else: "h.rho2%4yr-%2mo"
7979
output_freq: 1
8080
output_freq_units:
@@ -98,8 +98,8 @@ Files:
9898
[ *cfc_3d ]
9999
# native grid
100100
hist:
101-
suffix:
102-
$TEST == True: "h.native%4yr-%2mo-%2dy"
101+
suffix:
102+
$TEST == True: "h.native%4yr-%2mo-%2dy"
103103
else: "h.native%4yr-%2mo"
104104
output_freq: 1
105105
output_freq_units:
@@ -141,7 +141,7 @@ Files:
141141

142142
# essential variable mapped to z_space
143143
hist_z_space:
144-
suffix:
144+
suffix:
145145
$TEST == True: "h.z%4yr-%2mo-%2dy"
146146
else: "h.z%4yr-%2mo"
147147
output_freq: 1
@@ -167,7 +167,7 @@ Files:
167167
[ *cfc_3d ]
168168

169169
surface_avg:
170-
suffix:
170+
suffix:
171171
$TEST == True: "h.sfc%4yr-%2mo-%2dy"
172172
else: "h.sfc%4yr-%2mo"
173173
output_freq:
@@ -189,7 +189,7 @@ Files:
189189
*surface_flds_daily,
190190
*kpp_diags ]
191191
forcing_avg:
192-
suffix:
192+
suffix:
193193
$TEST == True: "h.frc%4yr-%2mo-%2dy"
194194
else: "h.frc%4yr-%2mo"
195195
output_freq: 1

‎param_templates/input_data_list.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ mom.input_data_list:
4343
CHL_FILE:
4444
$OCN_GRID == "tx0.25v1": "${INPUTDIR}/seawifs-clim-1997-2010.1440x1080.v20180328.nc"
4545
$OCN_GRID == "tx2_3v2": "${INPUTDIR}/seawifs-clim-1997-2010-tx2_3v2.230416.nc"
46-
MLE_FL_FILE:
47-
$OCN_GRID == "tx2_3v2": "${INPUTDIR}/mle-lf-clim-tx2_3v2_20250115.nc"
46+
CR_FILE:
47+
$OCN_GRID == "tx2_3v2": "${INPUTDIR}/mle-cr-tx2_3v2-v10_20250426.nc"
4848
CFC_BC_FILE: "${DIN_LOC_ROOT}/ocn/mom/grid_indpt/cfc_atm_20230310.nc"
4949
DIAG_COORD_DEF_RHO2:
5050
$OCN_GRID == "tx2_3v2": "${INPUTDIR}/ocean_rho2_190917.nc"

‎param_templates/json/MOM_input.json‎

Lines changed: 98 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,14 @@
478478
"$OCN_GRID == \"tx2_3v2\"": true
479479
}
480480
},
481+
"REMAPPING_USE_OM4_SUBCELLS": {
482+
"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",
483+
"datatype": "bool",
484+
"units": "none",
485+
"value": {
486+
"$OCN_GRID == \"tx2_3v2\"": false
487+
}
488+
},
481489
"INIT_LAYERS_FROM_Z_FILE": {
482490
"description": "\"[Boolean] default = False\nIf true, intialize the layer thicknesses, temperatures,\nand salnities from a Z-space file on a latitude-\nlongitude grid.\"\n",
483491
"datatype": "logical",
@@ -1144,6 +1152,22 @@
11441152
"else": true
11451153
}
11461154
},
1155+
"BODNER_DETECT_MLD": {
1156+
"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",
1157+
"datatype": "bool",
1158+
"units": "none",
1159+
"value": {
1160+
"$OCN_GRID == \"tx2_3v2\"": true
1161+
}
1162+
},
1163+
"MLE_DENSITY_DIFF": {
1164+
"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",
1165+
"datatype": "real",
1166+
"units": "kg/m3",
1167+
"value": {
1168+
"$OCN_GRID == \"tx2_3v2\"": 0.02
1169+
}
1170+
},
11471171
"FOX_KEMPER_ML_RESTRAT_COEF": {
11481172
"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",
11491173
"datatype": "real",
@@ -1170,13 +1194,6 @@
11701194
"$OCN_GRID == \"tx2_3v2\"": false
11711195
}
11721196
},
1173-
"MLE_FL_FILE": {
1174-
"description": "\"The path to the file containing the MLE\nfront-length scale..\"\n",
1175-
"datatype": "string",
1176-
"value": {
1177-
"$OCN_GRID == \"tx2_3v2\"": "mle-lf-clim-tx2_3v2_20250115.nc"
1178-
}
1179-
},
11801197
"MLE_MLD_DECAY_TIME": {
11811198
"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",
11821199
"datatype": "real",
@@ -2990,7 +3007,7 @@
29903007
},
29913008
"KPP": {
29923009
"N_SMOOTH": {
2993-
"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",
3010+
"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",
29943011
"datatype": "integer",
29953012
"value": {
29963013
"$OCN_GRID == \"tx2_3v2\"": 3
@@ -3048,6 +3065,14 @@
30483065
"$COMP_WAV == \"ww3\"": "VR12"
30493066
}
30503067
},
3068+
"KPP_CVt2": {
3069+
"description": "\"[nondim] default = 1.6\nParameter for Stokes MOST convection entrainment.\"\n",
3070+
"datatype": "real",
3071+
"units": "nondim",
3072+
"value": {
3073+
"$OCN_GRID == \"tx2_3v2\"": 1.0
3074+
}
3075+
},
30513076
"STOKES_MOST": {
30523077
"description": "default = False\nIf True, use Stokes Similarity package.\n",
30533078
"datatype": "logical",
@@ -3070,5 +3095,70 @@
30703095
"$OCN_GRID == \"tx2_3v2\"": 5.0
30713096
}
30723097
}
3098+
},
3099+
"MLE": {
3100+
"USE_BODNER23": {
3101+
"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",
3102+
"datatype": "logical",
3103+
"units": "Boolean",
3104+
"value": {
3105+
"$OCN_GRID == \"tx2_3v2\"": true
3106+
}
3107+
},
3108+
"USE_CR_GRID": {
3109+
"description": "\"[Boolean] default = False\ntrue, read in a spatially varying Cr field.\"\n",
3110+
"datatype": "logical",
3111+
"units": "Boolean",
3112+
"value": {
3113+
"$OCN_GRID == \"tx2_3v2\"": true
3114+
}
3115+
},
3116+
"CR_FILE": {
3117+
"description": "\"The path to the file containing the Cr fields.\"\n",
3118+
"datatype": "string",
3119+
"value": {
3120+
"$OCN_GRID == \"tx2_3v2\"": "mle-cr-tx2_3v2-v10_20250426.nc"
3121+
}
3122+
},
3123+
"MIN_WSTAR2": {
3124+
"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",
3125+
"datatype": "real",
3126+
"units": "m2 s-2",
3127+
"value": {
3128+
"$OCN_GRID == \"tx2_3v2\"": 1e-09
3129+
}
3130+
},
3131+
"BLD_DECAYING_TFILTER": {
3132+
"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",
3133+
"datatype": "real",
3134+
"units": "s",
3135+
"value": {
3136+
"$OCN_GRID == \"tx2_3v2\"": 86400.0
3137+
}
3138+
},
3139+
"BLD_GROWING_TFILTER": {
3140+
"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",
3141+
"datatype": "real",
3142+
"units": "s",
3143+
"value": {
3144+
"$OCN_GRID == \"tx2_3v2\"": 300.0
3145+
}
3146+
},
3147+
"MLD_GROWING_TFILTER": {
3148+
"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",
3149+
"datatype": "real",
3150+
"units": "s",
3151+
"value": {
3152+
"$OCN_GRID == \"tx2_3v2\"": 3600.0
3153+
}
3154+
},
3155+
"MLD_DECAYING_TFILTER": {
3156+
"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",
3157+
"datatype": "real",
3158+
"units": "s",
3159+
"value": {
3160+
"$OCN_GRID == \"tx2_3v2\"": 2592000.0
3161+
}
3162+
}
30733163
}
30743164
}

0 commit comments

Comments
 (0)