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.

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
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
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
71 changes: 28 additions & 43 deletions param_templates/MOM_input.yaml
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 @@ -988,7 +990,9 @@ Global:
If true, use a Laplacian horizontal viscosity."
datatype: logical
units: Boolean
value: True
value:
$OCN_GRID == "tx2_3v2": False
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert LAPLACIAN to True. We will need it for the LEITHY backscatter, which will be introduced in an upcoming PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

else: True
KH:
description: |
"[m2 s-1] default = 0.0
Expand Down Expand Up @@ -2331,7 +2335,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 +2345,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 +2723,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 +3526,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 +3537,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 +3547,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 +3577,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 +3664,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 +3700,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

...
Loading
Loading