Skip to content
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

Miscellaneous runtime parameter changes #216

Merged
merged 2 commits into from
Jan 8, 2025
Merged

Miscellaneous runtime parameter changes #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05182ac
Miscellaneous runtime parameter changes:
alperaltuntas Jan 7, 2025
7b99707
revert LAPLACIAN to True
alperaltuntas Jan 8, 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
20 changes: 20 additions & 0 deletions cime_config/config_component.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,26 @@
</desc>
</entry>

<entry id="MOM6_WW3_CPL_METHOD">
<type>char</type>
<valid_values>none,legacy,most</valid_values>
<default_value>most</default_value>
<values>
<value grid="w%ww3a">legacy</value>
<value compset="_SWAV|_DWAV">none</value>
</values>
<group>run_component_mom</group>
<file>env_run.xml</file>
<desc> This variable determines the method used to couple MOM6 to WW3.
The method "most" corresponds to the newest coupling method
that turns on FPMix parameterization, Stokes_Bands coupling,
and Stokes similarity package. The method "legacy" corresponds to
the older coupling method based on receiving a Langmuir number from
WW3 and passing it to CVMix. When set to "none", no wave
parameterization is used.
</desc>
</entry>

<entry id="OCN_DIAG_MODE">
<type>char</type>
<valid_values>spinup,production,development,none</valid_values>
Expand Down
67 changes: 25 additions & 42 deletions param_templates/MOM_input.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,9 @@ Global:
for backward compatibility but ideally should be 0."
datatype: real
units: PPT
value: 0.0
value:
$COMP_ATM == "cam": 1.0e-6
else: 0.0
BOUND_SALINITY:
description: |
"[Boolean] default = False
Expand Down Expand Up @@ -2331,7 +2333,6 @@ Global:
units: nondim
value:
$OCN_GRID == "tx0.25v1": 0.15
$OCN_GRID == "tx2_3v2": 1.0
MEKE_ALPHA_EADY:
description: |
"[nondim] default = 0.05
Expand All @@ -2342,42 +2343,24 @@ Global:
value:
$OCN_GRID == "tx0.25v1": 0.15
$OCN_GRID == "tx2_3v2": 1.0
MEKE_ALPHA_DEFORM:
description: |
"[nondim] default = 0.0
If positive, is a coefficient weighting the deformation scale in the
expression for mixing length used in MEKE-derived diffusivity."
datatype: real
units: nondim
value:
$OCN_GRID == "tx2_3v2": 1.0
MEKE_ALPHA_FRICT:
description: |
"[nondim] default = 0.0
If positive, is a coefficient weighting the frictional arrest scale in the
expression for mixing length used in MEKE-derived diffusivity."
datatype: real
units: nondim
value:
$OCN_GRID == "tx2_3v2": 1.0
MEKE_ALPHA_GRID:
MEKE_FRCOEFF:
description: |
"[nondim] default = 0.0
"[nondim] default = -1.0
If positive, is a coefficient weighting the grid-spacing as a scale in the
expression for mixing length used in MEKE-derived diffusivity."
datatype: real
units: nondim
value:
$OCN_GRID == "tx2_3v2": 1.0
MEKE_FRCOEFF:
$OCN_GRID == "tx2_3v2": 0.3
MEKE_CT:
description: |
"[nondim] default = -1.0
If positive, is a coefficient weighting the grid-spacing as a scale in the
expression for mixing length used in MEKE-derived diffusivity."
"[nondim] default = 50.0
! A coefficient in the expression for the ratio of barotropic eddy energy and
! mean column energy (see Jansen et al. 2015)."
datatype: real
units: nondim
value:
$OCN_GRID == "tx2_3v2": 0.3
$OCN_GRID == "tx2_3v2": 0.0
MEKE_POSITIVE:
description: |
"[Boolean] default = False
Expand Down Expand Up @@ -2738,15 +2721,15 @@ Global:
datatype: logical
units: Boolean
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
CEMP_NL:
description: |
"default = 3.6
Empirical coefficient of non-local momentum mixing."
datatype: real
units: nondim
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: 2.0
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": 2.0

# MISOMIP-only variables:

Expand Down Expand Up @@ -3541,7 +3524,7 @@ Global:
If true, enables surface wave modules."
datatype: logical
value:
$COMP_WAV == "ww3": True
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD != "none": True
WAVE_METHOD:
description: |
"Choice of wave method, valid options include:
Expand All @@ -3552,8 +3535,8 @@ Global:
EFACTOR - Applies an enhancement factor to the KPP...""
datatype: string
value:
$COMP_WAV == "ww3" and $WAV_GRID == "ww3a" : "EFACTOR"
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: "SURFACE_BANDS"
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy" : "EFACTOR"
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "SURFACE_BANDS"
SURFBAND_SOURCE:
description: |
Choice of SURFACE_BANDS data mode, valid options include:
Expand All @@ -3562,28 +3545,28 @@ Global:
INPUT - Testing with fixed values.
datatype: string
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: "COUPLER"
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "COUPLER"
STOKES_DDT:
description: |
default = False
Flag to use Stokes d/dt
datatype: string
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
STOKES_VF:
description: |
default = False
Flag to use Stokes vortex force
datatype: string
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
STOKES_PGF:
description: |
default = False
Flag to use Stokes pressure gradient force
datatype: string
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True
STK_BAND_COUPLER:
description: |
default = 1
Expand All @@ -3592,14 +3575,14 @@ Global:
will fail.
datatype: int
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: 3
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": 3
SURFBAND_WAVENUMBERS:
description: |
[rad/m] default = 0.12566
Central wavenumbers for surface Stokes drift bands.
datatype: string
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: "0.04, 0.11, 0.33"
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": "0.04, 0.11, 0.33"
IO_LAYOUT:
description: |
The processor layout to be used, or 0,0 to automatically set the io_layout to
Expand Down Expand Up @@ -3679,15 +3662,15 @@ KPP:
datatype: logical
units: Boolean
value:
$COMP_WAV == "ww3" and $WAV_GRID == "ww3a" : True
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy": True
USE_KPP_LT_VT2:
description: |
default = False
Flag for Langmuir turbulence enhancement of Vt2in Bulk Richardson Number.
datatype: logical
units: Boolean
value:
$COMP_WAV == "ww3" and $WAV_GRID == "ww3a" : True
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "legacy": True
KPP_LT_K_METHOD:
description: |
default = "CONSTANT"
Expand Down Expand Up @@ -3715,6 +3698,6 @@ KPP:
If True, use Stokes Similarity package.
datatype: logical
value:
$COMP_WAV == "ww3" and $WAV_GRID in ["wtx2_3v2", "wgx3v7"]: True
$COMP_WAV == "ww3" and $MOM6_WW3_CPL_METHOD == "most": True

...
64 changes: 25 additions & 39 deletions param_templates/json/MOM_input.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,10 @@
"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",
"datatype": "real",
"units": "PPT",
"value": 0.0
"value": {
"$COMP_ATM == \"cam\"": 1e-06,
"else": 0.0
}
},
"BOUND_SALINITY": {
"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",
Expand Down Expand Up @@ -1831,8 +1834,7 @@
"datatype": "real",
"units": "nondim",
"value": {
"$OCN_GRID == \"tx0.25v1\"": 0.15,
"$OCN_GRID == \"tx2_3v2\"": 1.0
"$OCN_GRID == \"tx0.25v1\"": 0.15
}
},
"MEKE_ALPHA_EADY": {
Expand All @@ -1844,36 +1846,20 @@
"$OCN_GRID == \"tx2_3v2\"": 1.0
}
},
"MEKE_ALPHA_DEFORM": {
"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",
"datatype": "real",
"units": "nondim",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 1.0
}
},
"MEKE_ALPHA_FRICT": {
"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",
"datatype": "real",
"units": "nondim",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 1.0
}
},
"MEKE_ALPHA_GRID": {
"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",
"MEKE_FRCOEFF": {
"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",
"datatype": "real",
"units": "nondim",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 1.0
"$OCN_GRID == \"tx2_3v2\"": 0.3
}
},
"MEKE_FRCOEFF": {
"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",
"MEKE_CT": {
"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",
"datatype": "real",
"units": "nondim",
"value": {
"$OCN_GRID == \"tx2_3v2\"": 0.3
"$OCN_GRID == \"tx2_3v2\"": 0.0
}
},
"MEKE_POSITIVE": {
Expand Down Expand Up @@ -2173,15 +2159,15 @@
"datatype": "logical",
"units": "Boolean",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
}
},
"CEMP_NL": {
"description": "\"default = 3.6\nEmpirical coefficient of non-local momentum mixing.\"\n",
"datatype": "real",
"units": "nondim",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": 2.0
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": 2.0
}
},
"REENTRANT_X": {
Expand Down Expand Up @@ -2869,57 +2855,57 @@
"description": "\"default = False\nIf true, enables surface wave modules.\"\n",
"datatype": "logical",
"value": {
"$COMP_WAV == \"ww3\"": true
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD != \"none\"": true
}
},
"WAVE_METHOD": {
"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",
"datatype": "string",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID == \"ww3a\"": "EFACTOR",
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": "SURFACE_BANDS"
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"legacy\"": "EFACTOR",
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": "SURFACE_BANDS"
}
},
"SURFBAND_SOURCE": {
"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",
"datatype": "string",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": "COUPLER"
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": "COUPLER"
}
},
"STOKES_DDT": {
"description": "default = False\nFlag to use Stokes d/dt\n",
"datatype": "string",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
}
},
"STOKES_VF": {
"description": "default = False\nFlag to use Stokes vortex force\n",
"datatype": "string",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
}
},
"STOKES_PGF": {
"description": "default = False\nFlag to use Stokes pressure gradient force\n",
"datatype": "string",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
}
},
"STK_BAND_COUPLER": {
"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",
"datatype": "int",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": 3
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": 3
}
},
"SURFBAND_WAVENUMBERS": {
"description": "[rad/m] default = 0.12566\nCentral wavenumbers for surface Stokes drift bands.\n",
"datatype": "string",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": "0.04, 0.11, 0.33"
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": "0.04, 0.11, 0.33"
}
},
"AUTO_MASKTABLE": {
Expand Down Expand Up @@ -2980,15 +2966,15 @@
"datatype": "logical",
"units": "Boolean",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID == \"ww3a\"": true
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"legacy\"": true
}
},
"USE_KPP_LT_VT2": {
"description": "default = False\nFlag for Langmuir turbulence enhancement of Vt2in Bulk Richardson Number.\n",
"datatype": "logical",
"units": "Boolean",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID == \"ww3a\"": true
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"legacy\"": true
}
},
"KPP_LT_K_METHOD": {
Expand All @@ -3009,7 +2995,7 @@
"description": "default = False\nIf True, use Stokes Similarity package.\n",
"datatype": "logical",
"value": {
"$COMP_WAV == \"ww3\" and $WAV_GRID in [\"wtx2_3v2\", \"wgx3v7\"]": true
"$COMP_WAV == \"ww3\" and $MOM6_WW3_CPL_METHOD == \"most\"": true
}
}
}
Expand Down
Loading