Skip to content

Commit 9d0d916

Browse files
alperaltuntasalperaltuntas
authored
Miscellaneous runtime parameter changes (#216)
* Miscellaneous runtime parameter changes: - Introduce MOM6_WW3_CPL_METHOD xml variable controlling which wave coupling method gets used: most, legacy, or none - For B cases, set MIN_SALINITY to 1.0e-6 - For t232, set Laplacian to False - For t232, remove MEKE_ALPHA_RHINES, MEKE_ALPHA_DEFORM, MEKE_ALPHA_FRICT, MEKE_ALPHA_GRID, MEKE_CT * revert LAPLACIAN to True
1 parent 2ece021 commit 9d0d916

3 files changed

Lines changed: 70 additions & 81 deletions

File tree

‎cime_config/config_component.xml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,26 @@
8383
</desc>
8484
</entry>
8585

86+
<entry id="MOM6_WW3_CPL_METHOD">
87+
<type>char</type>
88+
<valid_values>none,legacy,most</valid_values>
89+
<default_value>most</default_value>
90+
<values>
91+
<value grid="w%ww3a">legacy</value>
92+
<value compset="_SWAV|_DWAV">none</value>
93+
</values>
94+
<group>run_component_mom</group>
95+
<file>env_run.xml</file>
96+
<desc> This variable determines the method used to couple MOM6 to WW3.
97+
The method "most" corresponds to the newest coupling method
98+
that turns on FPMix parameterization, Stokes_Bands coupling,
99+
and Stokes similarity package. The method "legacy" corresponds to
100+
the older coupling method based on receiving a Langmuir number from
101+
WW3 and passing it to CVMix. When set to "none", no wave
102+
parameterization is used.
103+
</desc>
104+
</entry>
105+
86106
<entry id="OCN_DIAG_MODE">
87107
<type>char</type>
88108
<valid_values>spinup,production,development,none</valid_values>

‎param_templates/MOM_input.yaml‎

Lines changed: 25 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,9 @@ Global:
220220
for backward compatibility but ideally should be 0."
221221
datatype: real
222222
units: PPT
223-
value: 0.0
223+
value:
224+
$COMP_ATM == "cam": 1.0e-6
225+
else: 0.0
224226
BOUND_SALINITY:
225227
description: |
226228
"[Boolean] default = False
@@ -2331,7 +2333,6 @@ Global:
23312333
units: nondim
23322334
value:
23332335
$OCN_GRID == "tx0.25v1": 0.15
2334-
$OCN_GRID == "tx2_3v2": 1.0
23352336
MEKE_ALPHA_EADY:
23362337
description: |
23372338
"[nondim] default = 0.05
@@ -2342,42 +2343,24 @@ Global:
23422343
value:
23432344
$OCN_GRID == "tx0.25v1": 0.15
23442345
$OCN_GRID == "tx2_3v2": 1.0
2345-
MEKE_ALPHA_DEFORM:
2346-
description: |
2347-
"[nondim] default = 0.0
2348-
If positive, is a coefficient weighting the deformation scale in the
2349-
expression for mixing length used in MEKE-derived diffusivity."
2350-
datatype: real
2351-
units: nondim
2352-
value:
2353-
$OCN_GRID == "tx2_3v2": 1.0
2354-
MEKE_ALPHA_FRICT:
2355-
description: |
2356-
"[nondim] default = 0.0
2357-
If positive, is a coefficient weighting the frictional arrest scale in the
2358-
expression for mixing length used in MEKE-derived diffusivity."
2359-
datatype: real
2360-
units: nondim
2361-
value:
2362-
$OCN_GRID == "tx2_3v2": 1.0
2363-
MEKE_ALPHA_GRID:
2346+
MEKE_FRCOEFF:
23642347
description: |
2365-
"[nondim] default = 0.0
2348+
"[nondim] default = -1.0
23662349
If positive, is a coefficient weighting the grid-spacing as a scale in the
23672350
expression for mixing length used in MEKE-derived diffusivity."
23682351
datatype: real
23692352
units: nondim
23702353
value:
2371-
$OCN_GRID == "tx2_3v2": 1.0
2372-
MEKE_FRCOEFF:
2354+
$OCN_GRID == "tx2_3v2": 0.3
2355+
MEKE_CT:
23732356
description: |
2374-
"[nondim] default = -1.0
2375-
If positive, is a coefficient weighting the grid-spacing as a scale in the
2376-
expression for mixing length used in MEKE-derived diffusivity."
2357+
"[nondim] default = 50.0
2358+
! A coefficient in the expression for the ratio of barotropic eddy energy and
2359+
! mean column energy (see Jansen et al. 2015)."
23772360
datatype: real
23782361
units: nondim
23792362
value:
2380-
$OCN_GRID == "tx2_3v2": 0.3
2363+
$OCN_GRID == "tx2_3v2": 0.0
23812364
MEKE_POSITIVE:
23822365
description: |
23832366
"[Boolean] default = False
@@ -2738,15 +2721,15 @@ Global:
27382721
datatype: logical
27392722
units: Boolean
27402723
value:
2741-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
2724+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
27422725
CEMP_NL:
27432726
description: |
27442727
"default = 3.6
27452728
Empirical coefficient of non-local momentum mixing."
27462729
datatype: real
27472730
units: nondim
27482731
value:
2749-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: 2.0
2732+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": 2.0
27502733

27512734
# MISOMIP-only variables:
27522735

@@ -3541,7 +3524,7 @@ Global:
35413524
If true, enables surface wave modules."
35423525
datatype: logical
35433526
value:
3544-
$COMP_WAV == "ww3": True
3527+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD != "none": True
35453528
WAVE_METHOD:
35463529
description: |
35473530
"Choice of wave method, valid options include:
@@ -3552,8 +3535,8 @@ Global:
35523535
EFACTOR - Applies an enhancement factor to the KPP...""
35533536
datatype: string
35543537
value:
3555-
$COMP_WAV == "ww3" and $WAV_GRID == "ww3a" : "EFACTOR"
3556-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: "SURFACE_BANDS"
3538+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy" : "EFACTOR"
3539+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "SURFACE_BANDS"
35573540
SURFBAND_SOURCE:
35583541
description: |
35593542
Choice of SURFACE_BANDS data mode, valid options include:
@@ -3562,28 +3545,28 @@ Global:
35623545
INPUT - Testing with fixed values.
35633546
datatype: string
35643547
value:
3565-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: "COUPLER"
3548+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "COUPLER"
35663549
STOKES_DDT:
35673550
description: |
35683551
default = False
35693552
Flag to use Stokes d/dt
35703553
datatype: string
35713554
value:
3572-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
3555+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
35733556
STOKES_VF:
35743557
description: |
35753558
default = False
35763559
Flag to use Stokes vortex force
35773560
datatype: string
35783561
value:
3579-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
3562+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
35803563
STOKES_PGF:
35813564
description: |
35823565
default = False
35833566
Flag to use Stokes pressure gradient force
35843567
datatype: string
35853568
value:
3586-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
3569+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
35873570
STK_BAND_COUPLER:
35883571
description: |
35893572
default = 1
@@ -3592,14 +3575,14 @@ Global:
35923575
will fail.
35933576
datatype: int
35943577
value:
3595-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: 3
3578+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": 3
35963579
SURFBAND_WAVENUMBERS:
35973580
description: |
35983581
[rad/m] default = 0.12566
35993582
Central wavenumbers for surface Stokes drift bands.
36003583
datatype: string
36013584
value:
3602-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: "0.04, 0.11, 0.33"
3585+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "0.04, 0.11, 0.33"
36033586
IO_LAYOUT:
36043587
description: |
36053588
The processor layout to be used, or 0,0 to automatically set the io_layout to
@@ -3679,15 +3662,15 @@ KPP:
36793662
datatype: logical
36803663
units: Boolean
36813664
value:
3682-
$COMP_WAV == "ww3" and $WAV_GRID == "ww3a" : True
3665+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy": True
36833666
USE_KPP_LT_VT2:
36843667
description: |
36853668
default = False
36863669
Flag for Langmuir turbulence enhancement of Vt2in Bulk Richardson Number.
36873670
datatype: logical
36883671
units: Boolean
36893672
value:
3690-
$COMP_WAV == "ww3" and $WAV_GRID == "ww3a" : True
3673+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy": True
36913674
KPP_LT_K_METHOD:
36923675
description: |
36933676
default = "CONSTANT"
@@ -3715,6 +3698,6 @@ KPP:
37153698
If True, use Stokes Similarity package.
37163699
datatype: logical
37173700
value:
3718-
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
3701+
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
37193702

37203703
...

‎param_templates/json/MOM_input.json‎

Lines changed: 25 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,10 @@
140140
"description": "\"[PPT] default = 0.01\n The minimum value of salinity when BOUND_SALINITY=True. The default is 0.01\n for backward compatibility but ideally should be 0.\"\n",
141141
"datatype": "real",
142142
"units": "PPT",
143-
"value": 0.0
143+
"value": {
144+
"$COMP_ATM == \"cam\"": 1e-06,
145+
"else": 0.0
146+
}
144147
},
145148
"BOUND_SALINITY": {
146149
"description": "\"[Boolean] default = False\nIf true, limit salinity to being positive. (The sea-ice\nmodel may ask for more salt than is available and\ndrive the salinity negative otherwise.)\"\n",
@@ -1831,8 +1834,7 @@
18311834
"datatype": "real",
18321835
"units": "nondim",
18331836
"value": {
1834-
"$OCN_GRID == \"tx0.25v1\"": 0.15,
1835-
"$OCN_GRID == \"tx2_3v2\"": 1.0
1837+
"$OCN_GRID == \"tx0.25v1\"": 0.15
18361838
}
18371839
},
18381840
"MEKE_ALPHA_EADY": {
@@ -1844,36 +1846,20 @@
18441846
"$OCN_GRID == \"tx2_3v2\"": 1.0
18451847
}
18461848
},
1847-
"MEKE_ALPHA_DEFORM": {
1848-
"description": "\"[nondim] default = 0.0\nIf positive, is a coefficient weighting the deformation scale in the\nexpression for mixing length used in MEKE-derived diffusivity.\"\n",
1849-
"datatype": "real",
1850-
"units": "nondim",
1851-
"value": {
1852-
"$OCN_GRID == \"tx2_3v2\"": 1.0
1853-
}
1854-
},
1855-
"MEKE_ALPHA_FRICT": {
1856-
"description": "\"[nondim] default = 0.0\nIf positive, is a coefficient weighting the frictional arrest scale in the\nexpression for mixing length used in MEKE-derived diffusivity.\"\n",
1857-
"datatype": "real",
1858-
"units": "nondim",
1859-
"value": {
1860-
"$OCN_GRID == \"tx2_3v2\"": 1.0
1861-
}
1862-
},
1863-
"MEKE_ALPHA_GRID": {
1864-
"description": "\"[nondim] default = 0.0\nIf positive, is a coefficient weighting the grid-spacing as a scale in the\nexpression for mixing length used in MEKE-derived diffusivity.\"\n",
1849+
"MEKE_FRCOEFF": {
1850+
"description": "\"[nondim] default = -1.0\nIf positive, is a coefficient weighting the grid-spacing as a scale in the\nexpression for mixing length used in MEKE-derived diffusivity.\"\n",
18651851
"datatype": "real",
18661852
"units": "nondim",
18671853
"value": {
1868-
"$OCN_GRID == \"tx2_3v2\"": 1.0
1854+
"$OCN_GRID == \"tx2_3v2\"": 0.3
18691855
}
18701856
},
1871-
"MEKE_FRCOEFF": {
1872-
"description": "\"[nondim] default = -1.0\nIf positive, is a coefficient weighting the grid-spacing as a scale in the\nexpression for mixing length used in MEKE-derived diffusivity.\"\n",
1857+
"MEKE_CT": {
1858+
"description": "\"[nondim] default = 50.0\n! A coefficient in the expression for the ratio of barotropic eddy energy and\n! mean column energy (see Jansen et al. 2015).\"\n",
18731859
"datatype": "real",
18741860
"units": "nondim",
18751861
"value": {
1876-
"$OCN_GRID == \"tx2_3v2\"": 0.3
1862+
"$OCN_GRID == \"tx2_3v2\"": 0.0
18771863
}
18781864
},
18791865
"MEKE_POSITIVE": {
@@ -2173,15 +2159,15 @@
21732159
"datatype": "logical",
21742160
"units": "Boolean",
21752161
"value": {
2176-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
2162+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
21772163
}
21782164
},
21792165
"CEMP_NL": {
21802166
"description": "\"default = 3.6\nEmpirical coefficient of non-local momentum mixing.\"\n",
21812167
"datatype": "real",
21822168
"units": "nondim",
21832169
"value": {
2184-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": 2.0
2170+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": 2.0
21852171
}
21862172
},
21872173
"REENTRANT_X": {
@@ -2869,57 +2855,57 @@
28692855
"description": "\"default = False\nIf true, enables surface wave modules.\"\n",
28702856
"datatype": "logical",
28712857
"value": {
2872-
"$COMP_WAV == \"ww3\"": true
2858+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD != \"none\"": true
28732859
}
28742860
},
28752861
"WAVE_METHOD": {
28762862
"description": "\"Choice of wave method, valid options include:\n TEST_PROFILE - Prescribed from surface Stokes drift...\n SURFACE_BANDS - Computed from multiple surface values...\n DHH85 - Uses Donelan et al. 1985 empirical...\n LF17 - Infers Stokes drift profile from wind...\n EFACTOR - Applies an enhancement factor to the KPP...\"\"\n",
28772863
"datatype": "string",
28782864
"value": {
2879-
"$COMP_WAV == \"ww3\" and $WAV_GRID == \"ww3a\"": "EFACTOR",
2880-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": "SURFACE_BANDS"
2865+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"legacy\"": "EFACTOR",
2866+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": "SURFACE_BANDS"
28812867
}
28822868
},
28832869
"SURFBAND_SOURCE": {
28842870
"description": "Choice of SURFACE_BANDS data mode, valid options include:\nDATAOVERRIDE - Read from NetCDF using FMS DataOverride.\nCOUPLER - Look for variables from coupler pass\nINPUT - Testing with fixed values.\n",
28852871
"datatype": "string",
28862872
"value": {
2887-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": "COUPLER"
2873+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": "COUPLER"
28882874
}
28892875
},
28902876
"STOKES_DDT": {
28912877
"description": "default = False\nFlag to use Stokes d/dt\n",
28922878
"datatype": "string",
28932879
"value": {
2894-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
2880+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
28952881
}
28962882
},
28972883
"STOKES_VF": {
28982884
"description": "default = False\nFlag to use Stokes vortex force\n",
28992885
"datatype": "string",
29002886
"value": {
2901-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
2887+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
29022888
}
29032889
},
29042890
"STOKES_PGF": {
29052891
"description": "default = False\nFlag to use Stokes pressure gradient force\n",
29062892
"datatype": "string",
29072893
"value": {
2908-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
2894+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
29092895
}
29102896
},
29112897
"STK_BAND_COUPLER": {
29122898
"description": "default = 1\nSTK_BAND_COUPLER is the number of Stokes drift bands in the coupler. This has\nto be consistent with the number of Stokes drift bands in WW3, or the model\nwill fail.\n",
29132899
"datatype": "int",
29142900
"value": {
2915-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": 3
2901+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": 3
29162902
}
29172903
},
29182904
"SURFBAND_WAVENUMBERS": {
29192905
"description": "[rad/m] default = 0.12566\nCentral wavenumbers for surface Stokes drift bands.\n",
29202906
"datatype": "string",
29212907
"value": {
2922-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": "0.04, 0.11, 0.33"
2908+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": "0.04, 0.11, 0.33"
29232909
}
29242910
},
29252911
"AUTO_MASKTABLE": {
@@ -2980,15 +2966,15 @@
29802966
"datatype": "logical",
29812967
"units": "Boolean",
29822968
"value": {
2983-
"$COMP_WAV == \"ww3\" and $WAV_GRID == \"ww3a\"": true
2969+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"legacy\"": true
29842970
}
29852971
},
29862972
"USE_KPP_LT_VT2": {
29872973
"description": "default = False\nFlag for Langmuir turbulence enhancement of Vt2in Bulk Richardson Number.\n",
29882974
"datatype": "logical",
29892975
"units": "Boolean",
29902976
"value": {
2991-
"$COMP_WAV == \"ww3\" and $WAV_GRID == \"ww3a\"": true
2977+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"legacy\"": true
29922978
}
29932979
},
29942980
"KPP_LT_K_METHOD": {
@@ -3009,7 +2995,7 @@
30092995
"description": "default = False\nIf True, use Stokes Similarity package.\n",
30102996
"datatype": "logical",
30112997
"value": {
3012-
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
2998+
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
30132999
}
30143000
}
30153001
}

0 commit comments

Comments
 (0)