From 283c4906b366bacda08a401406abe4aad5964ac4 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Tue, 10 Jun 2025 11:59:53 -0600 Subject: [PATCH 01/14] Add Regional Mode Xml Var --- cime_config/config_component.xml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/cime_config/config_component.xml b/cime_config/config_component.xml index 27d22dbd..9e3bab75 100644 --- a/cime_config/config_component.xml +++ b/cime_config/config_component.xml @@ -183,6 +183,16 @@ + + logical + TRUE,FALSE + FALSE + case_comp + env_run.xml + Flag to turn on/off the regional defaults for MOM_input + + + ========================================= MOM6 naming conventions From 56fda89e22b9c28aff41d9693cf7918ee4b611d1 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Wed, 11 Jun 2025 11:12:06 -0600 Subject: [PATCH 02/14] Gustavo MOM Updates w/o file specific updates --- param_templates/MOM_input.yaml | 232 ++++++++++++++++++++++- param_templates/json/MOM_input.json | 282 +++++++++++++++++++++++----- 2 files changed, 459 insertions(+), 55 deletions(-) diff --git a/param_templates/MOM_input.yaml b/param_templates/MOM_input.yaml index d35e9290..035b1673 100644 --- a/param_templates/MOM_input.yaml +++ b/param_templates/MOM_input.yaml @@ -115,6 +115,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": False + $MOM6_REGIONAL_MODE == True: False DIABATIC_FIRST: description: | "[Boolean] default = False @@ -125,6 +126,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True + $MOM6_REGIONAL_MODE == True: True USE_REGRIDDING: description: | "[Boolean] default = False @@ -253,6 +255,8 @@ Global: $OCN_GRID == "tx2_3v2": 3992.0 $OCN_GRID == "tx0.25v1": 3992.0 $OCN_GRID == "MISOMIP": 3974.0 + $MOM6_REGIONAL_MODE == True: 3992.0 + USE_PSURF_IN_EOS: description: | "[Boolean] default = True @@ -270,6 +274,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True SAVE_INITIAL_CONDS: description: | "[Boolean] default = False @@ -301,6 +306,7 @@ Global: $OCN_GRID == "tx2_3v2": -7.75E-08 $OCN_GRID == "tx0.25v1": -7.75E-08 $OCN_GRID == "MISOMIP": -7.53E-08 + $MOM6_REGIONAL_MODE == True: -7.75E-08 USE_IDEAL_AGE_TRACER: description: | "[Boolean] default = False @@ -480,6 +486,7 @@ Global: value: $OCN_GRID == "tx0.25v1": "file" $OCN_GRID == "MISOMIP": "linear" + $MOM6_REGIONAL_MODE == True: "ALE" REMAP_UV_USING_OLD_ALG: description: | "[Boolean] default = True @@ -614,7 +621,11 @@ Global: PQM_IH4IH3 (4th-order accurate) PQM_IH6IH5 (5th-order accurate)" datatype: string - value: "PPM_CW" + value: + $MOM6_REGIONAL_MODE == True: + "PPM_H4" + else: + "PPM_CW" INIT_LAYERS_FROM_Z_FILE: description: | "[Boolean] default = False @@ -675,6 +686,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True RESOLN_SCALED_KH: description: | "[Boolean] default = False @@ -773,6 +785,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True USE_STANLEY_ISO: description: | "[Boolean] default = False @@ -881,6 +894,7 @@ Global: $MOM6_VERTICAL_GRID in ["zstar_65L", "zstar_75L"]: "Z*" $MOM6_VERTICAL_GRID == "hycom1": "HYCOM1" $MOM6_VERTICAL_GRID == "sigma_shelf_zstar": "SIGMA_SHELF_ZSTAR" + $MOM6_REGIONAL_MODE == True: "Z*" ALE_COORDINATE_CONFIG: description: | "default = 'UNIFORM' @@ -1039,6 +1053,7 @@ Global: value: $OCN_GRID == "tx0.25v1": 0.01 $OCN_GRID == "MISOMIP": 0.001 + $MOM6_REGIONAL_MODE == True: 0.01 LEITH_AH: description: | "[Boolean] default = False @@ -1077,6 +1092,7 @@ Global: units: m value: $OCN_GRID == "MISOMIP": 20.0 + $MOM6_REGIONAL_MODE == True: 0.9 else: 0.5 CHANNEL_DRAG: description: | @@ -1109,6 +1125,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 1.0 $OCN_GRID == "tx0.25v1": 1.25 + $MOM6_REGIONAL_MODE == True: 1.25 U_TRUNC_FILE: description: | "default = '' @@ -1279,6 +1296,17 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True + BT_NONLIN_STRESS: + description: | + "[Boolean] default = False + If true, use the full depth of the ocean at the start of the barotropic step + when calculating the surface stress contribution to the barotropic + acclerations. Otherwise use the depth based on bathyT." + datatype: logical + units: Boolean + value: + $MOM6_REGIONAL_MODE == True: True BT_THICK_SCHEME: description: | "default = 'HYBRID' @@ -1333,6 +1361,7 @@ Global: value: $OCN_GRID == "tx0.25v1": -0.9 $OCN_GRID == "MISOMIP": -0.9 + $MOM6_REGIONAL_MODE == True: -0.9 else: -0.95 DEPTH_MIN_DYN_PSURF: description: | @@ -1357,6 +1386,7 @@ Global: units: Pa value: $OCN_GRID == "tx0.25v1": 0.0 + $MOM6_REGIONAL_MODE == True: 0.0 KHTH: description: | "[m2 s-1] default = 0.0 @@ -1378,6 +1408,7 @@ Global: units: nondimensional value: $OCN_GRID == "tx0.25v1": 0.1 + $MOM6_REGIONAL_MODE == True: 0.1 STOCH_EOS: description: "[Boolean] default = False @@ -1461,6 +1492,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 1.0 $OCN_GRID == "tx0.25v1": 1.0 + $MOM6_REGIONAL_MODE == True: 1.0 MLE_FRONT_LENGTH: description: | "[m] default = 0.0 @@ -1473,6 +1505,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 1000.0 $OCN_GRID == "tx0.25v1": 500.0 + $MOM6_REGIONAL_MODE == True: MLE_FRONT_LENGTH MLE_MLD_DECAY_TIME: description: | "[s] default = 0.0 @@ -1485,6 +1518,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 3.45600E+05 $OCN_GRID == "tx0.25v1": 2.592E+06 + $MOM6_REGIONAL_MODE == True: 2.592E+06 USE_STANLEY_ML: description: | "[Boolean] default = False @@ -1504,6 +1538,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True + $MOM6_REGIONAL_MODE == True: True BBL_MIXING_AS_MAX: description: | "[Boolean] default = True @@ -1515,6 +1550,7 @@ Global: value: $OCN_GRID == "tx2_3v2": False $OCN_GRID == "tx0.25v1": False + $MOM6_REGIONAL_MODE == True: False USE_LOTW_BBL_DIFFUSIVITY: description: | "[Boolean] default = False @@ -1559,6 +1595,7 @@ Global: $OCN_GRID == "tx2_3v2": 0.0 $OCN_GRID == "tx0.25v1": 1.5E-05 $OCN_GRID == "MISOMIP": 5.0E-05 + $MOM6_REGIONAL_MODE == True: 1.0E-06 else: 2.0E-05 KDML: description: | @@ -1590,6 +1627,7 @@ Global: units: m2 s-1 value: $OCN_GRID == "tx2_3v2": 2.0E-07 + $MOM6_REGIONAL_MODE == True: 2.0E-07 else: 2.0E-06 INT_TIDE_DECAY_SCALE: description: | @@ -1625,6 +1663,7 @@ Global: units: nondim value: $OCN_GRID == "tx0.25v1": 0.0018 + $MOM6_REGIONAL_MODE == True: 0.0018 USE_RIGID_SEA_ICE: description: | "[Boolean] default = False @@ -1634,6 +1673,7 @@ Global: units: Boolean value: $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True SEA_ICE_RIGID_MASS: description: | "[kg m-2] default = 1000.0 @@ -1643,6 +1683,7 @@ Global: units: kg m-2 value: $OCN_GRID == "tx0.25v1": 100.0 + $MOM6_REGIONAL_MODE == True: 100.0 H2_FILE: description: | "The path to the file containing the sub-grid-scale @@ -1659,6 +1700,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True + $MOM6_REGIONAL_MODE == True: True USE_CVMix_TIDAL: description: | "[Boolean] default = False @@ -1713,6 +1755,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True + $MOM6_REGIONAL_MODE == True: True N_SMOOTH_RI: description: | "default = 0 @@ -1722,6 +1765,7 @@ Global: units: nondim value: $OCN_GRID == "tx2_3v2": 1 + $MOM6_REGIONAL_MODE == True: 1 USE_CVMIX_DDIFF: description: | "[Boolean] default = False @@ -1732,6 +1776,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True + $MOM6_REGIONAL_MODE == True: True MAX_ENT_IT: description: | "default = 5 @@ -1771,6 +1816,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True + $MOM6_REGIONAL_MODE == True: True MSTAR_MODE: description: | "[units=nondim] default = 0 @@ -2002,6 +2048,7 @@ Global: value: $OCN_GRID == "tx0.25v1": 3 $OCN_GRID == "tx2_3v2": 3 + $MOM6_REGIONAL_MODE == True: 3 TRACER_ADVECTION_SCHEME: description: | "default = 'PLM' @@ -2012,6 +2059,7 @@ Global: value: $OCN_GRID == "tx2_3v2": '"PPM:H3"' $OCN_GRID == "tx0.25v1": '"PPM:H3"' + $MOM6_REGIONAL_MODE == True: '"PPM:H3"' KHTR_USE_EBT_STRUCT: description: | "[Boolean] default = False @@ -2055,6 +2103,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True MAX_TR_DIFFUSION_CFL: description: | "[nondim] default = -1.0 @@ -2203,6 +2252,7 @@ Global: $OCN_GRID == "tx2_3v2": 1.0 $OCN_GRID == "tx0.25v1": 0.25 $OCN_GRID == "MISOMIP": 1.0 + $MOM6_REGIONAL_MODE == True: 0.25 ENERGETICS_SFC_PBL: description: | "[Boolean] default = False @@ -2542,6 +2592,7 @@ Global: value: $OCN_GRID == "tx0.25v1": 0.06 $OCN_GRID == "MISOMIP": 0.06 + $MOM6_REGIONAL_MODE == True: 0.015 USE_JACKSON_PARAM: description: | "[Boolean] default = False @@ -2579,6 +2630,7 @@ Global: units: Boolean value: $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True BAD_VAL_SSH_MAX: description: | "[m] default = 20.0 @@ -2588,6 +2640,7 @@ Global: units: m value: $OCN_GRID == "tx0.25v1": 50.0 # TODO + $MOM6_REGIONAL_MODE == True: 50.0 BAD_VAL_SSS_MAX: description: | "default = 45.0 @@ -2606,6 +2659,7 @@ Global: units: deg C value: $OCN_GRID == "tx0.25v1": 65.0 + $MOM6_REGIONAL_MODE == True: 65.0 BAD_VAL_SST_MIN: description: | "default = -2.1 @@ -2616,6 +2670,7 @@ Global: value: $OCN_GRID == "tx2_3v2": -3.0 $OCN_GRID == "tx0.25v1": -3.0 + $MOM6_REGIONAL_MODE == True: -3.0 DEFAULT_ANSWER_DATE: description: | "[Boolean] default = True @@ -2664,6 +2719,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True TOPO_EDITS_FILE: description: | "default = @@ -2680,6 +2736,7 @@ Global: units: Boolean value: $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True # MISOMIP-only variables: @@ -2691,6 +2748,7 @@ Global: units: Boolean value: $OCN_GRID == "MISOMIP": False + $MOM6_REGIONAL_MODE == True: False RHO_0: description: | "[kg m-3] default = 1035.0 @@ -2717,6 +2775,7 @@ Global: datatype: string value: $OCN_GRID == "MISOMIP": "MISOMIP_IC" + $MOM6_REGIONAL_MODE == True: $CASE.mom6.ic TRIMMING_USES_REMAPPING: description: | "[Boolean] default = False @@ -2944,6 +3003,7 @@ Global: units: m value: $OCN_GRID == "MISOMIP": 1.0E-12 + $MOM6_REGIONAL_MODE == True: 1.0E-06 HYCOM1_ONLY_IMPROVES: description: | "[Boolean] default = False @@ -3102,6 +3162,7 @@ Global: units: m2 s-1 value: $OCN_GRID == "tx2_3v2": 0.0 + $MOM6_REGIONAL_MODE == True: 1.0E-06 else: 1.0E-04 KV_BBL_MIN: description: | @@ -3158,6 +3219,7 @@ Global: units: Boolean value: $OCN_GRID == "MISOMIP": True + $MOM6_REGIONAL_MODE == True: True HARMONIC_BL_SCALE: description: | "[nondim] default = 0.0 @@ -3179,6 +3241,7 @@ Global: value: $OCN_GRID == "MISOMIP": True $OCN_GRID == "tx0.25v1": True + $MOM6_REGIONAL_MODE == True: True CORRECT_DENSITY: description: | "[Boolean] default = True @@ -3199,6 +3262,7 @@ Global: units: nondim value: $OCN_GRID == "MISOMIP": 0.0 + $MOM6_REGIONAL_MODE == True : 0.0 IGNORE_FLUXES_OVER_LAND: description: | "[Boolean] default = False @@ -3389,6 +3453,7 @@ Global: units: Boolean value: $OCN_GRID == "MISOMIP": False + $MOM6_REGIONAL_MODE == True: False DATE_STAMPED_STDOUT: description: | "[Boolean] default = True @@ -3417,11 +3482,17 @@ Global: else: "PPM_CW" MLE_USE_PBL_MLD: description: | - "TODO" + "TODO + + [Boolean] default = False + If true, the MLE parameterization will use the mixed-layer depth provided by + the active PBL parameterization. If false, MLE will estimate a MLD based on a + density difference with the surface using the parameter MLE_DENSITY_DIFF." datatype: logical value: $OCN_GRID == "tx0.25v1": True $OCN_GRID == "MISOMIP": True + $MOM6_REGIONAL_MODE == True: True EPBL_IS_ADDITIVE: description: | "[Boolean] default = True @@ -3432,6 +3503,7 @@ Global: units: Boolean value: $OCN_GRID == "tx0.25v1": False + $MOM6_REGIONAL_MODE == True: False GEOTHERMAL_SCALE: description: | "[W m-2 or various] default = 0.0 @@ -3567,7 +3639,157 @@ Global: Fraction of GM work that is added to backscatter rate." datatype: real value: 0.75 - + OBC_FREESLIP_VORTICITY: + description: | + "[Boolean] default = True + If true, sets the normal gradient of tangential velocity to zero in the + relative vorticity on open boundaries. This cannot be true if another + OBC_XXX_VORTICITY option is True. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: False + OBC_COMPUTED_VORTICITY: + description: | + "[Boolean] default = False + If true, uses the external values of tangential velocity in the relative + vorticity on open boundaries. This cannot be true if another OBC_XXX_VORTICITY + option is True. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: True + OBC_FREESLIP_STRAIN: + description: | + "[Boolean] default = True + If true, sets the normal gradient of tangential velocity to zero in the strain + use in the stress tensor on open boundaries. This cannot be true if another + OBC_XXX_STRAIN option is True. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: False + OBC_COMPUTED_STRAIN: + description: | + "[Boolean] default = False + If true, sets the normal gradient of tangential velocity to zero in the strain + use in the stress tensor on open boundaries. This cannot be true if another + OBC_XXX_STRAIN option is True. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: True + OBC_ZERO_BIHARMONIC: + description: | + "[Boolean] default = False + If true, zeros the Laplacian of flow on open boundaries in the biharmonic + viscosity term. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: True + OBC_RAMP_TIMESCALE: + description: | + "[days] default = 1.0 + If RAMP_OBCS is true, this sets the ramping timescale. + " + datatype: real + value: + $MOM6_REGIONAL_MODE == True: 2.0 + OBC_TRACER_RESERVOIR_LENGTH_SCALE_OUT: + description: | + "[m] default = 0.0 + An effective length scale for restoring the tracer concentration at the + boundaries to externally imposed values when the flow is exiting the domain. + " + datatype: real + value: + $MOM6_REGIONAL_MODE == True: 9000.0 + OBC_TRACER_RESERVOIR_LENGTH_SCALE_IN: + description: | + "[m] default = 0.0 + An effective length scale for restoring the tracer concentration at the + boundaries to values from the interior when the flow is entering the domain. + " + datatype: real + value: + $MOM6_REGIONAL_MODE == True: 9000.0 + DEPRESS_INITIAL_SURFACE: + description: | + "[Boolean] default = False + If true, depress the initial surface to avoid huge tsunamis when a large + surface pressure is applied. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: True + CHANNEL_DRAG_MAX_BBL_THICK: + description: | + "[m] default = -1.0 + The maximum bottom boundary layer thickness over which the channel drag is + exerted, or a negative value for no fixed limit, instead basing the BBL + thickness on the bottom stress, rotation and stratification. The default is + proportional to HBBL if USE_JACKSON_PARAM or DRAG_AS_BODY_FORCE is true. + " + datatype: real + value: + $MOM6_REGIONAL_MODE == True: 5.0 + DIRECT_STRESS: + description: | + "[Boolean] default = False + If true, the wind stress is distributed over the topmost HMIX_STRESS of fluid + (like in HYCOM), and an added mixed layer viscosity or a physically based + boundary layer turbulence parameterization is not needed for stability. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: True + SADOURNY: + description: | + "[Boolean] default = True + If true, the Coriolis terms are discretized with the Sadourny (1975) energy + conserving scheme, otherwise the Arakawa & Hsu scheme is used. If the + internal deformation radius is not resolved, the Sadourny scheme should + probably be used. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: False + BT_STRONG_DRAG: + description: | + "[Boolean] default = False + If true, use a stronger estimate of the retarding effects of strong bottom + drag, by making it implicit with the barotropic time-step instead of implicit + with the baroclinic time-step and dividing by the number of barotropic steps. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: True + LINEARIZED_BT_CORIOLIS: + description: | + "[Boolean] default = True + If true use the bottom depth instead of the total water column thickness in + the barotropic Coriolis term calculations. + " + datatype: logical + value: + $MOM6_REGIONAL_MODE == True: False + LATENT_HEAT_FUSION: + description: | + "[J/kg] default = 3.337E+05 + The latent heat of fusion. + " + datatype: real + value: + $MOM6_REGIONAL_MODE == True: 3.34E+05 + LATENT_HEAT_VAPORIZATION: + description: | + "[J/kg] default = 2.501E+06 + The latent heat of fusion. + " + datatype: real + value: + $MOM6_REGIONAL_MODE == True: 2.5E+06 KPP: N_SMOOTH: description: | @@ -3578,6 +3800,7 @@ KPP: datatype: integer value: $OCN_GRID == "tx2_3v2": 3 + $MOM6_REGIONAL_MODE == True: 3 MATCH_TECHNIQUE: description: | "default = 'SimpleShapes' @@ -3590,6 +3813,7 @@ KPP: datatype: string value: $OCN_GRID == "tx2_3v2": "MatchGradient" + $MOM6_REGIONAL_MODE == True: "MatchGradient" INTERP_TYPE2: description: | "Type of interpolation to compute diff and visc at OBL_depth @@ -3606,6 +3830,7 @@ KPP: units: Boolean value: $OCN_GRID == "tx2_3v2": False + $MOM6_REGIONAL_MODE == True: False USE_KPP_LT_K: description: | default = False @@ -3614,6 +3839,7 @@ KPP: units: Boolean value: $COMP_WAV == "ww3" and $WAV_GRID == "ww3a" : True + USE_KPP_LT_VT2: description: | default = False diff --git a/param_templates/json/MOM_input.json b/param_templates/json/MOM_input.json index b5c263f8..fd269364 100644 --- a/param_templates/json/MOM_input.json +++ b/param_templates/json/MOM_input.json @@ -65,7 +65,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": false + "$OCN_GRID == \"tx2_3v2\"": false, + "$MOM6_REGIONAL_MODE == True": false } }, "DIABATIC_FIRST": { @@ -73,7 +74,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": true + "$OCN_GRID == \"tx2_3v2\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "USE_REGRIDDING": { @@ -163,7 +165,8 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": 3992.0, "$OCN_GRID == \"tx0.25v1\"": 3992.0, - "$OCN_GRID == \"MISOMIP\"": 3974.0 + "$OCN_GRID == \"MISOMIP\"": 3974.0, + "$MOM6_REGIONAL_MODE == True": 3992.0 } }, "USE_PSURF_IN_EOS": { @@ -178,7 +181,8 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "SAVE_INITIAL_CONDS": { @@ -203,7 +207,8 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": -7.75e-08, "$OCN_GRID == \"tx0.25v1\"": -7.75e-08, - "$OCN_GRID == \"MISOMIP\"": -7.53e-08 + "$OCN_GRID == \"MISOMIP\"": -7.53e-08, + "$MOM6_REGIONAL_MODE == True": -7.75e-08 } }, "USE_IDEAL_AGE_TRACER": { @@ -369,7 +374,8 @@ "datatype": "string", "value": { "$OCN_GRID == \"tx0.25v1\"": "file", - "$OCN_GRID == \"MISOMIP\"": "linear" + "$OCN_GRID == \"MISOMIP\"": "linear", + "$MOM6_REGIONAL_MODE == True": "ALE" } }, "REMAP_UV_USING_OLD_ALG": { @@ -465,7 +471,10 @@ "REMAPPING_SCHEME": { "description": "\"default = 'PLM'\nThis sets the reconstruction scheme used\nfor vertical remapping for all variables.\nIt can be one of the following schemes:\nPCM (1st-order accurate)\nPLM (2nd-order accurate)\nPPM_H4 (3rd-order accurate)\nPPM_IH4 (3rd-order accurate)\nPQM_IH4IH3 (4th-order accurate)\nPQM_IH6IH5 (5th-order accurate)\"\n", "datatype": "string", - "value": "PPM_CW" + "value": { + "$MOM6_REGIONAL_MODE == True": "PPM_H4", + "else": "PPM_CW" + } }, "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", @@ -511,7 +520,8 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "RESOLN_SCALED_KH": { @@ -593,7 +603,8 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "USE_STANLEY_ISO": { @@ -676,7 +687,8 @@ "value": { "$MOM6_VERTICAL_GRID in [\"zstar_65L\", \"zstar_75L\"]": "Z*", "$MOM6_VERTICAL_GRID == \"hycom1\"": "HYCOM1", - "$MOM6_VERTICAL_GRID == \"sigma_shelf_zstar\"": "SIGMA_SHELF_ZSTAR" + "$MOM6_VERTICAL_GRID == \"sigma_shelf_zstar\"": "SIGMA_SHELF_ZSTAR", + "$MOM6_REGIONAL_MODE == True": "Z*" } }, "ALE_COORDINATE_CONFIG": { @@ -787,7 +799,8 @@ "units": "m s-1", "value": { "$OCN_GRID == \"tx0.25v1\"": 0.01, - "$OCN_GRID == \"MISOMIP\"": 0.001 + "$OCN_GRID == \"MISOMIP\"": 0.001, + "$MOM6_REGIONAL_MODE == True": 0.01 } }, "LEITH_AH": { @@ -818,6 +831,7 @@ "units": "m", "value": { "$OCN_GRID == \"MISOMIP\"": 20.0, + "$MOM6_REGIONAL_MODE == True": 0.9, "else": 0.5 } }, @@ -842,7 +856,8 @@ "units": "nondim", "value": { "$OCN_GRID == \"tx2_3v2\"": 1.0, - "$OCN_GRID == \"tx0.25v1\"": 1.25 + "$OCN_GRID == \"tx0.25v1\"": 1.25, + "$MOM6_REGIONAL_MODE == True": 1.25 } }, "U_TRUNC_FILE": { @@ -962,7 +977,16 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true + } + }, + "BT_NONLIN_STRESS": { + "description": "\"[Boolean] default = False\nIf true, use the full depth of the ocean at the start of the barotropic step\nwhen calculating the surface stress contribution to the barotropic\nacclerations. Otherwise use the depth based on bathyT.\"\n", + "datatype": "logical", + "units": "Boolean", + "value": { + "$MOM6_REGIONAL_MODE == True": true } }, "BT_THICK_SCHEME": { @@ -993,6 +1017,7 @@ "value": { "$OCN_GRID == \"tx0.25v1\"": -0.9, "$OCN_GRID == \"MISOMIP\"": -0.9, + "$MOM6_REGIONAL_MODE == True": -0.9, "else": -0.95 } }, @@ -1009,7 +1034,8 @@ "datatype": "real", "units": "Pa", "value": { - "$OCN_GRID == \"tx0.25v1\"": 0.0 + "$OCN_GRID == \"tx0.25v1\"": 0.0, + "$MOM6_REGIONAL_MODE == True": 0.0 } }, "KHTH": { @@ -1026,7 +1052,8 @@ "datatype": "real", "units": "nondimensional", "value": { - "$OCN_GRID == \"tx0.25v1\"": 0.1 + "$OCN_GRID == \"tx0.25v1\"": 0.1, + "$MOM6_REGIONAL_MODE == True": 0.1 } }, "STOCH_EOS": { @@ -1092,7 +1119,8 @@ "units": "nondim", "value": { "$OCN_GRID == \"tx2_3v2\"": 1.0, - "$OCN_GRID == \"tx0.25v1\"": 1.0 + "$OCN_GRID == \"tx0.25v1\"": 1.0, + "$MOM6_REGIONAL_MODE == True": 1.0 } }, "MLE_FRONT_LENGTH": { @@ -1101,7 +1129,8 @@ "units": "m", "value": { "$OCN_GRID == \"tx2_3v2\"": 1000.0, - "$OCN_GRID == \"tx0.25v1\"": 500.0 + "$OCN_GRID == \"tx0.25v1\"": 500.0, + "$MOM6_REGIONAL_MODE == True": "MLE_FRONT_LENGTH" } }, "MLE_MLD_DECAY_TIME": { @@ -1110,7 +1139,8 @@ "units": "s", "value": { "$OCN_GRID == \"tx2_3v2\"": 345600.0, - "$OCN_GRID == \"tx0.25v1\"": 2592000.0 + "$OCN_GRID == \"tx0.25v1\"": 2592000.0, + "$MOM6_REGIONAL_MODE == True": 2592000.0 } }, "USE_STANLEY_ML": { @@ -1126,7 +1156,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": true + "$OCN_GRID == \"tx2_3v2\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "BBL_MIXING_AS_MAX": { @@ -1135,7 +1166,8 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": false, - "$OCN_GRID == \"tx0.25v1\"": false + "$OCN_GRID == \"tx0.25v1\"": false, + "$MOM6_REGIONAL_MODE == True": false } }, "USE_LOTW_BBL_DIFFUSIVITY": { @@ -1173,6 +1205,7 @@ "$OCN_GRID == \"tx2_3v2\"": 0.0, "$OCN_GRID == \"tx0.25v1\"": 1.5e-05, "$OCN_GRID == \"MISOMIP\"": 5e-05, + "$MOM6_REGIONAL_MODE == True": 1e-06, "else": 2e-05 } }, @@ -1198,6 +1231,7 @@ "units": "m2 s-1", "value": { "$OCN_GRID == \"tx2_3v2\"": 2e-07, + "$MOM6_REGIONAL_MODE == True": 2e-07, "else": 2e-06 } }, @@ -1229,7 +1263,8 @@ "datatype": "real", "units": "nondim", "value": { - "$OCN_GRID == \"tx0.25v1\"": 0.0018 + "$OCN_GRID == \"tx0.25v1\"": 0.0018, + "$MOM6_REGIONAL_MODE == True": 0.0018 } }, "USE_RIGID_SEA_ICE": { @@ -1237,7 +1272,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "SEA_ICE_RIGID_MASS": { @@ -1245,7 +1281,8 @@ "datatype": "real", "units": "kg m-2", "value": { - "$OCN_GRID == \"tx0.25v1\"": 100.0 + "$OCN_GRID == \"tx0.25v1\"": 100.0, + "$MOM6_REGIONAL_MODE == True": 100.0 } }, "H2_FILE": { @@ -1260,7 +1297,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": true + "$OCN_GRID == \"tx2_3v2\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "USE_CVMix_TIDAL": { @@ -1306,7 +1344,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": true + "$OCN_GRID == \"tx2_3v2\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "N_SMOOTH_RI": { @@ -1314,7 +1353,8 @@ "datatype": "integer", "units": "nondim", "value": { - "$OCN_GRID == \"tx2_3v2\"": 1 + "$OCN_GRID == \"tx2_3v2\"": 1, + "$MOM6_REGIONAL_MODE == True": 1 } }, "USE_CVMIX_DDIFF": { @@ -1322,7 +1362,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": true + "$OCN_GRID == \"tx2_3v2\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "MAX_ENT_IT": { @@ -1357,7 +1398,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": true + "$OCN_GRID == \"tx2_3v2\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "MSTAR_MODE": { @@ -1557,7 +1599,8 @@ "datatype": "integer", "value": { "$OCN_GRID == \"tx0.25v1\"": 3, - "$OCN_GRID == \"tx2_3v2\"": 3 + "$OCN_GRID == \"tx2_3v2\"": 3, + "$MOM6_REGIONAL_MODE == True": 3 } }, "TRACER_ADVECTION_SCHEME": { @@ -1565,7 +1608,8 @@ "datatype": "string", "value": { "$OCN_GRID == \"tx2_3v2\"": "\"PPM:H3\"", - "$OCN_GRID == \"tx0.25v1\"": "\"PPM:H3\"" + "$OCN_GRID == \"tx0.25v1\"": "\"PPM:H3\"", + "$MOM6_REGIONAL_MODE == True": "\"PPM:H3\"" } }, "KHTR_USE_EBT_STRUCT": { @@ -1604,7 +1648,8 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "MAX_TR_DIFFUSION_CFL": { @@ -1723,7 +1768,8 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": 1.0, "$OCN_GRID == \"tx0.25v1\"": 0.25, - "$OCN_GRID == \"MISOMIP\"": 1.0 + "$OCN_GRID == \"MISOMIP\"": 1.0, + "$MOM6_REGIONAL_MODE == True": 0.25 } }, "ENERGETICS_SFC_PBL": { @@ -2009,7 +2055,8 @@ "units": "nondim", "value": { "$OCN_GRID == \"tx0.25v1\"": 0.06, - "$OCN_GRID == \"MISOMIP\"": 0.06 + "$OCN_GRID == \"MISOMIP\"": 0.06, + "$MOM6_REGIONAL_MODE == True": 0.015 } }, "USE_JACKSON_PARAM": { @@ -2038,7 +2085,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "BAD_VAL_SSH_MAX": { @@ -2046,7 +2094,8 @@ "datatype": "real", "units": "m", "value": { - "$OCN_GRID == \"tx0.25v1\"": 50.0 + "$OCN_GRID == \"tx0.25v1\"": 50.0, + "$MOM6_REGIONAL_MODE == True": 50.0 } }, "BAD_VAL_SSS_MAX": { @@ -2062,7 +2111,8 @@ "datatype": "real", "units": "deg C", "value": { - "$OCN_GRID == \"tx0.25v1\"": 65.0 + "$OCN_GRID == \"tx0.25v1\"": 65.0, + "$MOM6_REGIONAL_MODE == True": 65.0 } }, "BAD_VAL_SST_MIN": { @@ -2071,7 +2121,8 @@ "units": "degC", "value": { "$OCN_GRID == \"tx2_3v2\"": -3.0, - "$OCN_GRID == \"tx0.25v1\"": -3.0 + "$OCN_GRID == \"tx0.25v1\"": -3.0, + "$MOM6_REGIONAL_MODE == True": -3.0 } }, "DEFAULT_ANSWER_DATE": { @@ -2110,7 +2161,8 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "TOPO_EDITS_FILE": { @@ -2125,7 +2177,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "REENTRANT_X": { @@ -2133,7 +2186,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"MISOMIP\"": false + "$OCN_GRID == \"MISOMIP\"": false, + "$MOM6_REGIONAL_MODE == True": false } }, "RHO_0": { @@ -2156,7 +2210,8 @@ "description": "\"default = 'MOM_IC'\nThe file into which to write the initial conditions.\"\n", "datatype": "string", "value": { - "$OCN_GRID == \"MISOMIP\"": "MISOMIP_IC" + "$OCN_GRID == \"MISOMIP\"": "MISOMIP_IC", + "$MOM6_REGIONAL_MODE == True": "$CASE.mom6.ic" } }, "TRIMMING_USES_REMAPPING": { @@ -2343,7 +2398,8 @@ "datatype": "real", "units": "m", "value": { - "$OCN_GRID == \"MISOMIP\"": 1e-12 + "$OCN_GRID == \"MISOMIP\"": 1e-12, + "$MOM6_REGIONAL_MODE == True": 1e-06 } }, "HYCOM1_ONLY_IMPROVES": { @@ -2482,6 +2538,7 @@ "units": "m2 s-1", "value": { "$OCN_GRID == \"tx2_3v2\"": 0.0, + "$MOM6_REGIONAL_MODE == True": 1e-06, "else": 0.0001 } }, @@ -2522,7 +2579,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"MISOMIP\"": true + "$OCN_GRID == \"MISOMIP\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "HARMONIC_BL_SCALE": { @@ -2539,7 +2597,8 @@ "units": "Boolean", "value": { "$OCN_GRID == \"MISOMIP\"": true, - "$OCN_GRID == \"tx0.25v1\"": true + "$OCN_GRID == \"tx0.25v1\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "CORRECT_DENSITY": { @@ -2555,7 +2614,8 @@ "datatype": "real", "units": "nondim", "value": { - "$OCN_GRID == \"MISOMIP\"": 0.0 + "$OCN_GRID == \"MISOMIP\"": 0.0, + "$MOM6_REGIONAL_MODE == True": 0.0 } }, "IGNORE_FLUXES_OVER_LAND": { @@ -2737,7 +2797,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"MISOMIP\"": false + "$OCN_GRID == \"MISOMIP\"": false, + "$MOM6_REGIONAL_MODE == True": false } }, "DATE_STAMPED_STDOUT": { @@ -2765,11 +2826,12 @@ } }, "MLE_USE_PBL_MLD": { - "description": "\"TODO\"\n", + "description": "\"TODO\n\n[Boolean] default = False\nIf true, the MLE parameterization will use the mixed-layer depth provided by\nthe active PBL parameterization. If false, MLE will estimate a MLD based on a\ndensity difference with the surface using the parameter MLE_DENSITY_DIFF.\"\n", "datatype": "logical", "value": { "$OCN_GRID == \"tx0.25v1\"": true, - "$OCN_GRID == \"MISOMIP\"": true + "$OCN_GRID == \"MISOMIP\"": true, + "$MOM6_REGIONAL_MODE == True": true } }, "EPBL_IS_ADDITIVE": { @@ -2777,7 +2839,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx0.25v1\"": false + "$OCN_GRID == \"tx0.25v1\"": false, + "$MOM6_REGIONAL_MODE == True": false } }, "GEOTHERMAL_SCALE": { @@ -2889,6 +2952,118 @@ "description": "\"[nondim] default = 0.0\nFraction of GM work that is added to backscatter rate.\"\n", "datatype": "real", "value": 0.75 + }, + "OBC_FREESLIP_VORTICITY": { + "description": "\"[Boolean] default = True\n If true, sets the normal gradient of tangential velocity to zero in the\n relative vorticity on open boundaries. This cannot be true if another\n OBC_XXX_VORTICITY option is True.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": false + } + }, + "OBC_COMPUTED_VORTICITY": { + "description": "\"[Boolean] default = False\n If true, uses the external values of tangential velocity in the relative\n vorticity on open boundaries. This cannot be true if another OBC_XXX_VORTICITY\n option is True.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": true + } + }, + "OBC_FREESLIP_STRAIN": { + "description": "\"[Boolean] default = True\n If true, sets the normal gradient of tangential velocity to zero in the strain\n use in the stress tensor on open boundaries. This cannot be true if another\n OBC_XXX_STRAIN option is True.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": false + } + }, + "OBC_COMPUTED_STRAIN": { + "description": "\"[Boolean] default = False\n If true, sets the normal gradient of tangential velocity to zero in the strain\n use in the stress tensor on open boundaries. This cannot be true if another\n OBC_XXX_STRAIN option is True.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": true + } + }, + "OBC_ZERO_BIHARMONIC": { + "description": "\"[Boolean] default = False\n If true, zeros the Laplacian of flow on open boundaries in the biharmonic\n viscosity term.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": true + } + }, + "OBC_RAMP_TIMESCALE": { + "description": "\"[days] default = 1.0\n If RAMP_OBCS is true, this sets the ramping timescale.\n\"\n", + "datatype": "real", + "value": { + "$MOM6_REGIONAL_MODE == True": 2.0 + } + }, + "OBC_TRACER_RESERVOIR_LENGTH_SCALE_OUT": { + "description": "\"[m] default = 0.0\nAn effective length scale for restoring the tracer concentration at the\nboundaries to externally imposed values when the flow is exiting the domain.\n\"\n", + "datatype": "real", + "value": { + "$MOM6_REGIONAL_MODE == True": 9000.0 + } + }, + "OBC_TRACER_RESERVOIR_LENGTH_SCALE_IN": { + "description": "\"[m] default = 0.0\nAn effective length scale for restoring the tracer concentration at the\nboundaries to values from the interior when the flow is entering the domain.\n\"\n", + "datatype": "real", + "value": { + "$MOM6_REGIONAL_MODE == True": 9000.0 + } + }, + "DEPRESS_INITIAL_SURFACE": { + "description": "\"[Boolean] default = False\n If true, depress the initial surface to avoid huge tsunamis when a large\n surface pressure is applied.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": true + } + }, + "CHANNEL_DRAG_MAX_BBL_THICK": { + "description": "\"[m] default = -1.0\n The maximum bottom boundary layer thickness over which the channel drag is\n exerted, or a negative value for no fixed limit, instead basing the BBL\n thickness on the bottom stress, rotation and stratification. The default is\n proportional to HBBL if USE_JACKSON_PARAM or DRAG_AS_BODY_FORCE is true.\n\"\n", + "datatype": "real", + "value": { + "$MOM6_REGIONAL_MODE == True": 5.0 + } + }, + "DIRECT_STRESS": { + "description": "\"[Boolean] default = False\nIf true, the wind stress is distributed over the topmost HMIX_STRESS of fluid\n(like in HYCOM), and an added mixed layer viscosity or a physically based\nboundary layer turbulence parameterization is not needed for stability.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": true + } + }, + "SADOURNY": { + "description": "\"[Boolean] default = True\n If true, the Coriolis terms are discretized with the Sadourny (1975) energy\n conserving scheme, otherwise the Arakawa & Hsu scheme is used. If the\n internal deformation radius is not resolved, the Sadourny scheme should\n probably be used.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": false + } + }, + "BT_STRONG_DRAG": { + "description": "\"[Boolean] default = False\n If true, use a stronger estimate of the retarding effects of strong bottom\n drag, by making it implicit with the barotropic time-step instead of implicit\n with the baroclinic time-step and dividing by the number of barotropic steps.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": true + } + }, + "LINEARIZED_BT_CORIOLIS": { + "description": "\"[Boolean] default = True\nIf true use the bottom depth instead of the total water column thickness in\nthe barotropic Coriolis term calculations.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_REGIONAL_MODE == True": false + } + }, + "LATENT_HEAT_FUSION": { + "description": "\"[J/kg] default = 3.337E+05\n The latent heat of fusion.\n\"\n", + "datatype": "real", + "value": { + "$MOM6_REGIONAL_MODE == True": 334000.0 + } + }, + "LATENT_HEAT_VAPORIZATION": { + "description": "\"[J/kg] default = 2.501E+06\nThe latent heat of fusion.\n\"\n", + "datatype": "real", + "value": { + "$MOM6_REGIONAL_MODE == True": 2500000.0 + } } }, "KPP": { @@ -2896,14 +3071,16 @@ "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", "datatype": "integer", "value": { - "$OCN_GRID == \"tx2_3v2\"": 3 + "$OCN_GRID == \"tx2_3v2\"": 3, + "$MOM6_REGIONAL_MODE == True": 3 } }, "MATCH_TECHNIQUE": { "description": "\"default = 'SimpleShapes'\nCVMix method to set profile function for diffusivity and NLT,\nas well as matching across OBL base. Allowed values are:\nSimpleShapes = sigma*(1-sigma)^2 for both diffusivity and NLT\nMatchGradient = sigma*(1-sigma)^2 for NLT; diffusivity profile from matching\nMatchBoth = match gradient for both diffusivity and NLT\nParabolicNonLocal = sigma*(1-sigma)^2 for diffusivity; (1-sigma)^2 for NLT\"\n", "datatype": "string", "value": { - "$OCN_GRID == \"tx2_3v2\"": "MatchGradient" + "$OCN_GRID == \"tx2_3v2\"": "MatchGradient", + "$MOM6_REGIONAL_MODE == True": "MatchGradient" } }, "INTERP_TYPE2": { @@ -2918,7 +3095,8 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": false + "$OCN_GRID == \"tx2_3v2\"": false, + "$MOM6_REGIONAL_MODE == True": false } }, "USE_KPP_LT_K": { From 8fbfd607191921972c78d0fd03dbc6ade9f646a5 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Wed, 11 Jun 2025 11:33:34 -0600 Subject: [PATCH 03/14] Minor Fix --- param_templates/MOM_input.yaml | 6 +++--- param_templates/json/MOM_input.json | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/param_templates/MOM_input.yaml b/param_templates/MOM_input.yaml index 035b1673..4bbc1810 100644 --- a/param_templates/MOM_input.yaml +++ b/param_templates/MOM_input.yaml @@ -1505,7 +1505,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 1000.0 $OCN_GRID == "tx0.25v1": 500.0 - $MOM6_REGIONAL_MODE == True: MLE_FRONT_LENGTH + $MOM6_REGIONAL_MODE == True: 1500.0 MLE_MLD_DECAY_TIME: description: | "[s] default = 0.0 @@ -2775,7 +2775,7 @@ Global: datatype: string value: $OCN_GRID == "MISOMIP": "MISOMIP_IC" - $MOM6_REGIONAL_MODE == True: $CASE.mom6.ic + $MOM6_REGIONAL_MODE == True: ${CASE}.mom6.ic TRIMMING_USES_REMAPPING: description: | "[Boolean] default = False @@ -3626,7 +3626,7 @@ Global: The file into which to write the ocean geometry. datatype: string value: - $CASE.mom6.h.ocean_geometry.nc + ${CASE}.mom6.h.ocean_geometry.nc SKEB_NPASS: description: | "default = 3 diff --git a/param_templates/json/MOM_input.json b/param_templates/json/MOM_input.json index fd269364..40a572fd 100644 --- a/param_templates/json/MOM_input.json +++ b/param_templates/json/MOM_input.json @@ -1130,7 +1130,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": 1000.0, "$OCN_GRID == \"tx0.25v1\"": 500.0, - "$MOM6_REGIONAL_MODE == True": "MLE_FRONT_LENGTH" + "$MOM6_REGIONAL_MODE == True": 1500.0 } }, "MLE_MLD_DECAY_TIME": { @@ -2211,7 +2211,7 @@ "datatype": "string", "value": { "$OCN_GRID == \"MISOMIP\"": "MISOMIP_IC", - "$MOM6_REGIONAL_MODE == True": "$CASE.mom6.ic" + "$MOM6_REGIONAL_MODE == True": "${CASE}.mom6.ic" } }, "TRIMMING_USES_REMAPPING": { @@ -2941,7 +2941,7 @@ "GEOM_FILE": { "description": "default = ocean_geometry.nc\nThe file into which to write the ocean geometry.\n", "datatype": "string", - "value": "$CASE.mom6.h.ocean_geometry.nc" + "value": "${CASE}.mom6.h.ocean_geometry.nc" }, "SKEB_NPASS": { "description": "\"default = 3\nnumber of passes of a 9-point smoother of the dissipation estimate.\"\n", From 39ec4b3bb75b034352c645e26da04cf3374f9f58 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Wed, 11 Jun 2025 14:05:05 -0600 Subject: [PATCH 04/14] Remove PEN_SW_NBANDS Change --- param_templates/MOM_input.yaml | 1 - param_templates/json/MOM_input.json | 3 +-- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/param_templates/MOM_input.yaml b/param_templates/MOM_input.yaml index 4bbc1810..d8d15995 100644 --- a/param_templates/MOM_input.yaml +++ b/param_templates/MOM_input.yaml @@ -2048,7 +2048,6 @@ Global: value: $OCN_GRID == "tx0.25v1": 3 $OCN_GRID == "tx2_3v2": 3 - $MOM6_REGIONAL_MODE == True: 3 TRACER_ADVECTION_SCHEME: description: | "default = 'PLM' diff --git a/param_templates/json/MOM_input.json b/param_templates/json/MOM_input.json index 40a572fd..f2d503c6 100644 --- a/param_templates/json/MOM_input.json +++ b/param_templates/json/MOM_input.json @@ -1599,8 +1599,7 @@ "datatype": "integer", "value": { "$OCN_GRID == \"tx0.25v1\"": 3, - "$OCN_GRID == \"tx2_3v2\"": 3, - "$MOM6_REGIONAL_MODE == True": 3 + "$OCN_GRID == \"tx2_3v2\"": 3 } }, "TRACER_ADVECTION_SCHEME": { From dfd5e40059fcc41e72d40942b83d7cd558c90f15 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Wed, 16 Jul 2025 15:54:22 -0600 Subject: [PATCH 05/14] Change XML Var Name --- param_templates/MOM_input.yaml | 144 ++++++++++++++-------------- param_templates/json/MOM_input.json | 144 ++++++++++++++-------------- 2 files changed, 144 insertions(+), 144 deletions(-) diff --git a/param_templates/MOM_input.yaml b/param_templates/MOM_input.yaml index d8d15995..356730f8 100644 --- a/param_templates/MOM_input.yaml +++ b/param_templates/MOM_input.yaml @@ -115,7 +115,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": False - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False DIABATIC_FIRST: description: | "[Boolean] default = False @@ -126,7 +126,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True USE_REGRIDDING: description: | "[Boolean] default = False @@ -255,7 +255,7 @@ Global: $OCN_GRID == "tx2_3v2": 3992.0 $OCN_GRID == "tx0.25v1": 3992.0 $OCN_GRID == "MISOMIP": 3974.0 - $MOM6_REGIONAL_MODE == True: 3992.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 3992.0 USE_PSURF_IN_EOS: description: | @@ -274,7 +274,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True SAVE_INITIAL_CONDS: description: | "[Boolean] default = False @@ -306,7 +306,7 @@ Global: $OCN_GRID == "tx2_3v2": -7.75E-08 $OCN_GRID == "tx0.25v1": -7.75E-08 $OCN_GRID == "MISOMIP": -7.53E-08 - $MOM6_REGIONAL_MODE == True: -7.75E-08 + $MOM6_DOMAIN_TYPE == "REGIONAL": -7.75E-08 USE_IDEAL_AGE_TRACER: description: | "[Boolean] default = False @@ -486,7 +486,7 @@ Global: value: $OCN_GRID == "tx0.25v1": "file" $OCN_GRID == "MISOMIP": "linear" - $MOM6_REGIONAL_MODE == True: "ALE" + $MOM6_DOMAIN_TYPE == "REGIONAL": "ALE" REMAP_UV_USING_OLD_ALG: description: | "[Boolean] default = True @@ -622,7 +622,7 @@ Global: PQM_IH6IH5 (5th-order accurate)" datatype: string value: - $MOM6_REGIONAL_MODE == True: + $MOM6_DOMAIN_TYPE == "REGIONAL": "PPM_H4" else: "PPM_CW" @@ -686,7 +686,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True RESOLN_SCALED_KH: description: | "[Boolean] default = False @@ -785,7 +785,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True USE_STANLEY_ISO: description: | "[Boolean] default = False @@ -894,7 +894,7 @@ Global: $MOM6_VERTICAL_GRID in ["zstar_65L", "zstar_75L"]: "Z*" $MOM6_VERTICAL_GRID == "hycom1": "HYCOM1" $MOM6_VERTICAL_GRID == "sigma_shelf_zstar": "SIGMA_SHELF_ZSTAR" - $MOM6_REGIONAL_MODE == True: "Z*" + $MOM6_DOMAIN_TYPE == "REGIONAL": "Z*" ALE_COORDINATE_CONFIG: description: | "default = 'UNIFORM' @@ -1053,7 +1053,7 @@ Global: value: $OCN_GRID == "tx0.25v1": 0.01 $OCN_GRID == "MISOMIP": 0.001 - $MOM6_REGIONAL_MODE == True: 0.01 + $MOM6_DOMAIN_TYPE == "REGIONAL": 0.01 LEITH_AH: description: | "[Boolean] default = False @@ -1092,7 +1092,7 @@ Global: units: m value: $OCN_GRID == "MISOMIP": 20.0 - $MOM6_REGIONAL_MODE == True: 0.9 + $MOM6_DOMAIN_TYPE == "REGIONAL": 0.9 else: 0.5 CHANNEL_DRAG: description: | @@ -1125,7 +1125,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 1.0 $OCN_GRID == "tx0.25v1": 1.25 - $MOM6_REGIONAL_MODE == True: 1.25 + $MOM6_DOMAIN_TYPE == "REGIONAL": 1.25 U_TRUNC_FILE: description: | "default = '' @@ -1296,7 +1296,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True BT_NONLIN_STRESS: description: | "[Boolean] default = False @@ -1306,7 +1306,7 @@ Global: datatype: logical units: Boolean value: - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True BT_THICK_SCHEME: description: | "default = 'HYBRID' @@ -1361,7 +1361,7 @@ Global: value: $OCN_GRID == "tx0.25v1": -0.9 $OCN_GRID == "MISOMIP": -0.9 - $MOM6_REGIONAL_MODE == True: -0.9 + $MOM6_DOMAIN_TYPE == "REGIONAL": -0.9 else: -0.95 DEPTH_MIN_DYN_PSURF: description: | @@ -1386,7 +1386,7 @@ Global: units: Pa value: $OCN_GRID == "tx0.25v1": 0.0 - $MOM6_REGIONAL_MODE == True: 0.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 0.0 KHTH: description: | "[m2 s-1] default = 0.0 @@ -1408,7 +1408,7 @@ Global: units: nondimensional value: $OCN_GRID == "tx0.25v1": 0.1 - $MOM6_REGIONAL_MODE == True: 0.1 + $MOM6_DOMAIN_TYPE == "REGIONAL": 0.1 STOCH_EOS: description: "[Boolean] default = False @@ -1492,7 +1492,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 1.0 $OCN_GRID == "tx0.25v1": 1.0 - $MOM6_REGIONAL_MODE == True: 1.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 1.0 MLE_FRONT_LENGTH: description: | "[m] default = 0.0 @@ -1505,7 +1505,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 1000.0 $OCN_GRID == "tx0.25v1": 500.0 - $MOM6_REGIONAL_MODE == True: 1500.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 1500.0 MLE_MLD_DECAY_TIME: description: | "[s] default = 0.0 @@ -1518,7 +1518,7 @@ Global: value: $OCN_GRID == "tx2_3v2": 3.45600E+05 $OCN_GRID == "tx0.25v1": 2.592E+06 - $MOM6_REGIONAL_MODE == True: 2.592E+06 + $MOM6_DOMAIN_TYPE == "REGIONAL": 2.592E+06 USE_STANLEY_ML: description: | "[Boolean] default = False @@ -1538,7 +1538,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True BBL_MIXING_AS_MAX: description: | "[Boolean] default = True @@ -1550,7 +1550,7 @@ Global: value: $OCN_GRID == "tx2_3v2": False $OCN_GRID == "tx0.25v1": False - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False USE_LOTW_BBL_DIFFUSIVITY: description: | "[Boolean] default = False @@ -1595,7 +1595,7 @@ Global: $OCN_GRID == "tx2_3v2": 0.0 $OCN_GRID == "tx0.25v1": 1.5E-05 $OCN_GRID == "MISOMIP": 5.0E-05 - $MOM6_REGIONAL_MODE == True: 1.0E-06 + $MOM6_DOMAIN_TYPE == "REGIONAL": 1.0E-06 else: 2.0E-05 KDML: description: | @@ -1627,7 +1627,7 @@ Global: units: m2 s-1 value: $OCN_GRID == "tx2_3v2": 2.0E-07 - $MOM6_REGIONAL_MODE == True: 2.0E-07 + $MOM6_DOMAIN_TYPE == "REGIONAL": 2.0E-07 else: 2.0E-06 INT_TIDE_DECAY_SCALE: description: | @@ -1663,7 +1663,7 @@ Global: units: nondim value: $OCN_GRID == "tx0.25v1": 0.0018 - $MOM6_REGIONAL_MODE == True: 0.0018 + $MOM6_DOMAIN_TYPE == "REGIONAL": 0.0018 USE_RIGID_SEA_ICE: description: | "[Boolean] default = False @@ -1673,7 +1673,7 @@ Global: units: Boolean value: $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True SEA_ICE_RIGID_MASS: description: | "[kg m-2] default = 1000.0 @@ -1683,7 +1683,7 @@ Global: units: kg m-2 value: $OCN_GRID == "tx0.25v1": 100.0 - $MOM6_REGIONAL_MODE == True: 100.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 100.0 H2_FILE: description: | "The path to the file containing the sub-grid-scale @@ -1700,7 +1700,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True USE_CVMix_TIDAL: description: | "[Boolean] default = False @@ -1755,7 +1755,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True N_SMOOTH_RI: description: | "default = 0 @@ -1765,7 +1765,7 @@ Global: units: nondim value: $OCN_GRID == "tx2_3v2": 1 - $MOM6_REGIONAL_MODE == True: 1 + $MOM6_DOMAIN_TYPE == "REGIONAL": 1 USE_CVMIX_DDIFF: description: | "[Boolean] default = False @@ -1776,7 +1776,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True MAX_ENT_IT: description: | "default = 5 @@ -1816,7 +1816,7 @@ Global: units: Boolean value: $OCN_GRID == "tx2_3v2": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True MSTAR_MODE: description: | "[units=nondim] default = 0 @@ -2058,7 +2058,7 @@ Global: value: $OCN_GRID == "tx2_3v2": '"PPM:H3"' $OCN_GRID == "tx0.25v1": '"PPM:H3"' - $MOM6_REGIONAL_MODE == True: '"PPM:H3"' + $MOM6_DOMAIN_TYPE == "REGIONAL": '"PPM:H3"' KHTR_USE_EBT_STRUCT: description: | "[Boolean] default = False @@ -2102,7 +2102,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True MAX_TR_DIFFUSION_CFL: description: | "[nondim] default = -1.0 @@ -2251,7 +2251,7 @@ Global: $OCN_GRID == "tx2_3v2": 1.0 $OCN_GRID == "tx0.25v1": 0.25 $OCN_GRID == "MISOMIP": 1.0 - $MOM6_REGIONAL_MODE == True: 0.25 + $MOM6_DOMAIN_TYPE == "REGIONAL": 0.25 ENERGETICS_SFC_PBL: description: | "[Boolean] default = False @@ -2591,7 +2591,7 @@ Global: value: $OCN_GRID == "tx0.25v1": 0.06 $OCN_GRID == "MISOMIP": 0.06 - $MOM6_REGIONAL_MODE == True: 0.015 + $MOM6_DOMAIN_TYPE == "REGIONAL": 0.015 USE_JACKSON_PARAM: description: | "[Boolean] default = False @@ -2629,7 +2629,7 @@ Global: units: Boolean value: $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True BAD_VAL_SSH_MAX: description: | "[m] default = 20.0 @@ -2639,7 +2639,7 @@ Global: units: m value: $OCN_GRID == "tx0.25v1": 50.0 # TODO - $MOM6_REGIONAL_MODE == True: 50.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 50.0 BAD_VAL_SSS_MAX: description: | "default = 45.0 @@ -2658,7 +2658,7 @@ Global: units: deg C value: $OCN_GRID == "tx0.25v1": 65.0 - $MOM6_REGIONAL_MODE == True: 65.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 65.0 BAD_VAL_SST_MIN: description: | "default = -2.1 @@ -2669,7 +2669,7 @@ Global: value: $OCN_GRID == "tx2_3v2": -3.0 $OCN_GRID == "tx0.25v1": -3.0 - $MOM6_REGIONAL_MODE == True: -3.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": -3.0 DEFAULT_ANSWER_DATE: description: | "[Boolean] default = True @@ -2718,7 +2718,7 @@ Global: value: $OCN_GRID == "tx2_3v2": True $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True TOPO_EDITS_FILE: description: | "default = @@ -2735,7 +2735,7 @@ Global: units: Boolean value: $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True # MISOMIP-only variables: @@ -2747,7 +2747,7 @@ Global: units: Boolean value: $OCN_GRID == "MISOMIP": False - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False RHO_0: description: | "[kg m-3] default = 1035.0 @@ -2774,7 +2774,7 @@ Global: datatype: string value: $OCN_GRID == "MISOMIP": "MISOMIP_IC" - $MOM6_REGIONAL_MODE == True: ${CASE}.mom6.ic + $MOM6_DOMAIN_TYPE == "REGIONAL": ${CASE}.mom6.ic TRIMMING_USES_REMAPPING: description: | "[Boolean] default = False @@ -3002,7 +3002,7 @@ Global: units: m value: $OCN_GRID == "MISOMIP": 1.0E-12 - $MOM6_REGIONAL_MODE == True: 1.0E-06 + $MOM6_DOMAIN_TYPE == "REGIONAL": 1.0E-06 HYCOM1_ONLY_IMPROVES: description: | "[Boolean] default = False @@ -3161,7 +3161,7 @@ Global: units: m2 s-1 value: $OCN_GRID == "tx2_3v2": 0.0 - $MOM6_REGIONAL_MODE == True: 1.0E-06 + $MOM6_DOMAIN_TYPE == "REGIONAL": 1.0E-06 else: 1.0E-04 KV_BBL_MIN: description: | @@ -3218,7 +3218,7 @@ Global: units: Boolean value: $OCN_GRID == "MISOMIP": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True HARMONIC_BL_SCALE: description: | "[nondim] default = 0.0 @@ -3240,7 +3240,7 @@ Global: value: $OCN_GRID == "MISOMIP": True $OCN_GRID == "tx0.25v1": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True CORRECT_DENSITY: description: | "[Boolean] default = True @@ -3261,7 +3261,7 @@ Global: units: nondim value: $OCN_GRID == "MISOMIP": 0.0 - $MOM6_REGIONAL_MODE == True : 0.0 + $MOM6_DOMAIN_TYPE == "REGIONAL" : 0.0 IGNORE_FLUXES_OVER_LAND: description: | "[Boolean] default = False @@ -3452,7 +3452,7 @@ Global: units: Boolean value: $OCN_GRID == "MISOMIP": False - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False DATE_STAMPED_STDOUT: description: | "[Boolean] default = True @@ -3491,7 +3491,7 @@ Global: value: $OCN_GRID == "tx0.25v1": True $OCN_GRID == "MISOMIP": True - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True EPBL_IS_ADDITIVE: description: | "[Boolean] default = True @@ -3502,7 +3502,7 @@ Global: units: Boolean value: $OCN_GRID == "tx0.25v1": False - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False GEOTHERMAL_SCALE: description: | "[W m-2 or various] default = 0.0 @@ -3647,7 +3647,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False OBC_COMPUTED_VORTICITY: description: | "[Boolean] default = False @@ -3657,7 +3657,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True OBC_FREESLIP_STRAIN: description: | "[Boolean] default = True @@ -3667,7 +3667,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False OBC_COMPUTED_STRAIN: description: | "[Boolean] default = False @@ -3677,7 +3677,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True OBC_ZERO_BIHARMONIC: description: | "[Boolean] default = False @@ -3686,7 +3686,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True OBC_RAMP_TIMESCALE: description: | "[days] default = 1.0 @@ -3694,7 +3694,7 @@ Global: " datatype: real value: - $MOM6_REGIONAL_MODE == True: 2.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 2.0 OBC_TRACER_RESERVOIR_LENGTH_SCALE_OUT: description: | "[m] default = 0.0 @@ -3703,7 +3703,7 @@ Global: " datatype: real value: - $MOM6_REGIONAL_MODE == True: 9000.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 9000.0 OBC_TRACER_RESERVOIR_LENGTH_SCALE_IN: description: | "[m] default = 0.0 @@ -3712,7 +3712,7 @@ Global: " datatype: real value: - $MOM6_REGIONAL_MODE == True: 9000.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 9000.0 DEPRESS_INITIAL_SURFACE: description: | "[Boolean] default = False @@ -3721,7 +3721,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True CHANNEL_DRAG_MAX_BBL_THICK: description: | "[m] default = -1.0 @@ -3732,7 +3732,7 @@ Global: " datatype: real value: - $MOM6_REGIONAL_MODE == True: 5.0 + $MOM6_DOMAIN_TYPE == "REGIONAL": 5.0 DIRECT_STRESS: description: | "[Boolean] default = False @@ -3742,7 +3742,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True SADOURNY: description: | "[Boolean] default = True @@ -3753,7 +3753,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False BT_STRONG_DRAG: description: | "[Boolean] default = False @@ -3763,7 +3763,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: True + $MOM6_DOMAIN_TYPE == "REGIONAL": True LINEARIZED_BT_CORIOLIS: description: | "[Boolean] default = True @@ -3772,7 +3772,7 @@ Global: " datatype: logical value: - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False LATENT_HEAT_FUSION: description: | "[J/kg] default = 3.337E+05 @@ -3780,7 +3780,7 @@ Global: " datatype: real value: - $MOM6_REGIONAL_MODE == True: 3.34E+05 + $MOM6_DOMAIN_TYPE == "REGIONAL": 3.34E+05 LATENT_HEAT_VAPORIZATION: description: | "[J/kg] default = 2.501E+06 @@ -3788,7 +3788,7 @@ Global: " datatype: real value: - $MOM6_REGIONAL_MODE == True: 2.5E+06 + $MOM6_DOMAIN_TYPE == "REGIONAL": 2.5E+06 KPP: N_SMOOTH: description: | @@ -3799,7 +3799,7 @@ KPP: datatype: integer value: $OCN_GRID == "tx2_3v2": 3 - $MOM6_REGIONAL_MODE == True: 3 + $MOM6_DOMAIN_TYPE == "REGIONAL": 3 MATCH_TECHNIQUE: description: | "default = 'SimpleShapes' @@ -3812,7 +3812,7 @@ KPP: datatype: string value: $OCN_GRID == "tx2_3v2": "MatchGradient" - $MOM6_REGIONAL_MODE == True: "MatchGradient" + $MOM6_DOMAIN_TYPE == "REGIONAL": "MatchGradient" INTERP_TYPE2: description: | "Type of interpolation to compute diff and visc at OBL_depth @@ -3829,7 +3829,7 @@ KPP: units: Boolean value: $OCN_GRID == "tx2_3v2": False - $MOM6_REGIONAL_MODE == True: False + $MOM6_DOMAIN_TYPE == "REGIONAL": False USE_KPP_LT_K: description: | default = False diff --git a/param_templates/json/MOM_input.json b/param_templates/json/MOM_input.json index f2d503c6..d66ae0fd 100644 --- a/param_templates/json/MOM_input.json +++ b/param_templates/json/MOM_input.json @@ -66,7 +66,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": false, - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "DIABATIC_FIRST": { @@ -75,7 +75,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "USE_REGRIDDING": { @@ -166,7 +166,7 @@ "$OCN_GRID == \"tx2_3v2\"": 3992.0, "$OCN_GRID == \"tx0.25v1\"": 3992.0, "$OCN_GRID == \"MISOMIP\"": 3974.0, - "$MOM6_REGIONAL_MODE == True": 3992.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 3992.0 } }, "USE_PSURF_IN_EOS": { @@ -182,7 +182,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": true, "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "SAVE_INITIAL_CONDS": { @@ -208,7 +208,7 @@ "$OCN_GRID == \"tx2_3v2\"": -7.75e-08, "$OCN_GRID == \"tx0.25v1\"": -7.75e-08, "$OCN_GRID == \"MISOMIP\"": -7.53e-08, - "$MOM6_REGIONAL_MODE == True": -7.75e-08 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": -7.75e-08 } }, "USE_IDEAL_AGE_TRACER": { @@ -375,7 +375,7 @@ "value": { "$OCN_GRID == \"tx0.25v1\"": "file", "$OCN_GRID == \"MISOMIP\"": "linear", - "$MOM6_REGIONAL_MODE == True": "ALE" + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": "ALE" } }, "REMAP_UV_USING_OLD_ALG": { @@ -472,7 +472,7 @@ "description": "\"default = 'PLM'\nThis sets the reconstruction scheme used\nfor vertical remapping for all variables.\nIt can be one of the following schemes:\nPCM (1st-order accurate)\nPLM (2nd-order accurate)\nPPM_H4 (3rd-order accurate)\nPPM_IH4 (3rd-order accurate)\nPQM_IH4IH3 (4th-order accurate)\nPQM_IH6IH5 (5th-order accurate)\"\n", "datatype": "string", "value": { - "$MOM6_REGIONAL_MODE == True": "PPM_H4", + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": "PPM_H4", "else": "PPM_CW" } }, @@ -521,7 +521,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": true, "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "RESOLN_SCALED_KH": { @@ -604,7 +604,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": true, "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "USE_STANLEY_ISO": { @@ -688,7 +688,7 @@ "$MOM6_VERTICAL_GRID in [\"zstar_65L\", \"zstar_75L\"]": "Z*", "$MOM6_VERTICAL_GRID == \"hycom1\"": "HYCOM1", "$MOM6_VERTICAL_GRID == \"sigma_shelf_zstar\"": "SIGMA_SHELF_ZSTAR", - "$MOM6_REGIONAL_MODE == True": "Z*" + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": "Z*" } }, "ALE_COORDINATE_CONFIG": { @@ -800,7 +800,7 @@ "value": { "$OCN_GRID == \"tx0.25v1\"": 0.01, "$OCN_GRID == \"MISOMIP\"": 0.001, - "$MOM6_REGIONAL_MODE == True": 0.01 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 0.01 } }, "LEITH_AH": { @@ -831,7 +831,7 @@ "units": "m", "value": { "$OCN_GRID == \"MISOMIP\"": 20.0, - "$MOM6_REGIONAL_MODE == True": 0.9, + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 0.9, "else": 0.5 } }, @@ -857,7 +857,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": 1.0, "$OCN_GRID == \"tx0.25v1\"": 1.25, - "$MOM6_REGIONAL_MODE == True": 1.25 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 1.25 } }, "U_TRUNC_FILE": { @@ -978,7 +978,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": true, "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "BT_NONLIN_STRESS": { @@ -986,7 +986,7 @@ "datatype": "logical", "units": "Boolean", "value": { - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "BT_THICK_SCHEME": { @@ -1017,7 +1017,7 @@ "value": { "$OCN_GRID == \"tx0.25v1\"": -0.9, "$OCN_GRID == \"MISOMIP\"": -0.9, - "$MOM6_REGIONAL_MODE == True": -0.9, + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": -0.9, "else": -0.95 } }, @@ -1035,7 +1035,7 @@ "units": "Pa", "value": { "$OCN_GRID == \"tx0.25v1\"": 0.0, - "$MOM6_REGIONAL_MODE == True": 0.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 0.0 } }, "KHTH": { @@ -1053,7 +1053,7 @@ "units": "nondimensional", "value": { "$OCN_GRID == \"tx0.25v1\"": 0.1, - "$MOM6_REGIONAL_MODE == True": 0.1 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 0.1 } }, "STOCH_EOS": { @@ -1120,7 +1120,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": 1.0, "$OCN_GRID == \"tx0.25v1\"": 1.0, - "$MOM6_REGIONAL_MODE == True": 1.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 1.0 } }, "MLE_FRONT_LENGTH": { @@ -1130,7 +1130,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": 1000.0, "$OCN_GRID == \"tx0.25v1\"": 500.0, - "$MOM6_REGIONAL_MODE == True": 1500.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 1500.0 } }, "MLE_MLD_DECAY_TIME": { @@ -1140,7 +1140,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": 345600.0, "$OCN_GRID == \"tx0.25v1\"": 2592000.0, - "$MOM6_REGIONAL_MODE == True": 2592000.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 2592000.0 } }, "USE_STANLEY_ML": { @@ -1157,7 +1157,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "BBL_MIXING_AS_MAX": { @@ -1167,7 +1167,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": false, "$OCN_GRID == \"tx0.25v1\"": false, - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "USE_LOTW_BBL_DIFFUSIVITY": { @@ -1205,7 +1205,7 @@ "$OCN_GRID == \"tx2_3v2\"": 0.0, "$OCN_GRID == \"tx0.25v1\"": 1.5e-05, "$OCN_GRID == \"MISOMIP\"": 5e-05, - "$MOM6_REGIONAL_MODE == True": 1e-06, + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 1e-06, "else": 2e-05 } }, @@ -1231,7 +1231,7 @@ "units": "m2 s-1", "value": { "$OCN_GRID == \"tx2_3v2\"": 2e-07, - "$MOM6_REGIONAL_MODE == True": 2e-07, + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 2e-07, "else": 2e-06 } }, @@ -1264,7 +1264,7 @@ "units": "nondim", "value": { "$OCN_GRID == \"tx0.25v1\"": 0.0018, - "$MOM6_REGIONAL_MODE == True": 0.0018 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 0.0018 } }, "USE_RIGID_SEA_ICE": { @@ -1273,7 +1273,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "SEA_ICE_RIGID_MASS": { @@ -1282,7 +1282,7 @@ "units": "kg m-2", "value": { "$OCN_GRID == \"tx0.25v1\"": 100.0, - "$MOM6_REGIONAL_MODE == True": 100.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 100.0 } }, "H2_FILE": { @@ -1298,7 +1298,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "USE_CVMix_TIDAL": { @@ -1345,7 +1345,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "N_SMOOTH_RI": { @@ -1354,7 +1354,7 @@ "units": "nondim", "value": { "$OCN_GRID == \"tx2_3v2\"": 1, - "$MOM6_REGIONAL_MODE == True": 1 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 1 } }, "USE_CVMIX_DDIFF": { @@ -1363,7 +1363,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "MAX_ENT_IT": { @@ -1399,7 +1399,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "MSTAR_MODE": { @@ -1608,7 +1608,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": "\"PPM:H3\"", "$OCN_GRID == \"tx0.25v1\"": "\"PPM:H3\"", - "$MOM6_REGIONAL_MODE == True": "\"PPM:H3\"" + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": "\"PPM:H3\"" } }, "KHTR_USE_EBT_STRUCT": { @@ -1648,7 +1648,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": true, "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "MAX_TR_DIFFUSION_CFL": { @@ -1768,7 +1768,7 @@ "$OCN_GRID == \"tx2_3v2\"": 1.0, "$OCN_GRID == \"tx0.25v1\"": 0.25, "$OCN_GRID == \"MISOMIP\"": 1.0, - "$MOM6_REGIONAL_MODE == True": 0.25 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 0.25 } }, "ENERGETICS_SFC_PBL": { @@ -2055,7 +2055,7 @@ "value": { "$OCN_GRID == \"tx0.25v1\"": 0.06, "$OCN_GRID == \"MISOMIP\"": 0.06, - "$MOM6_REGIONAL_MODE == True": 0.015 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 0.015 } }, "USE_JACKSON_PARAM": { @@ -2085,7 +2085,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "BAD_VAL_SSH_MAX": { @@ -2094,7 +2094,7 @@ "units": "m", "value": { "$OCN_GRID == \"tx0.25v1\"": 50.0, - "$MOM6_REGIONAL_MODE == True": 50.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 50.0 } }, "BAD_VAL_SSS_MAX": { @@ -2111,7 +2111,7 @@ "units": "deg C", "value": { "$OCN_GRID == \"tx0.25v1\"": 65.0, - "$MOM6_REGIONAL_MODE == True": 65.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 65.0 } }, "BAD_VAL_SST_MIN": { @@ -2121,7 +2121,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": -3.0, "$OCN_GRID == \"tx0.25v1\"": -3.0, - "$MOM6_REGIONAL_MODE == True": -3.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": -3.0 } }, "DEFAULT_ANSWER_DATE": { @@ -2161,7 +2161,7 @@ "value": { "$OCN_GRID == \"tx2_3v2\"": true, "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "TOPO_EDITS_FILE": { @@ -2177,7 +2177,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "REENTRANT_X": { @@ -2186,7 +2186,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"MISOMIP\"": false, - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "RHO_0": { @@ -2210,7 +2210,7 @@ "datatype": "string", "value": { "$OCN_GRID == \"MISOMIP\"": "MISOMIP_IC", - "$MOM6_REGIONAL_MODE == True": "${CASE}.mom6.ic" + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": "${CASE}.mom6.ic" } }, "TRIMMING_USES_REMAPPING": { @@ -2398,7 +2398,7 @@ "units": "m", "value": { "$OCN_GRID == \"MISOMIP\"": 1e-12, - "$MOM6_REGIONAL_MODE == True": 1e-06 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 1e-06 } }, "HYCOM1_ONLY_IMPROVES": { @@ -2537,7 +2537,7 @@ "units": "m2 s-1", "value": { "$OCN_GRID == \"tx2_3v2\"": 0.0, - "$MOM6_REGIONAL_MODE == True": 1e-06, + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 1e-06, "else": 0.0001 } }, @@ -2579,7 +2579,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"MISOMIP\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "HARMONIC_BL_SCALE": { @@ -2597,7 +2597,7 @@ "value": { "$OCN_GRID == \"MISOMIP\"": true, "$OCN_GRID == \"tx0.25v1\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "CORRECT_DENSITY": { @@ -2614,7 +2614,7 @@ "units": "nondim", "value": { "$OCN_GRID == \"MISOMIP\"": 0.0, - "$MOM6_REGIONAL_MODE == True": 0.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 0.0 } }, "IGNORE_FLUXES_OVER_LAND": { @@ -2797,7 +2797,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"MISOMIP\"": false, - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "DATE_STAMPED_STDOUT": { @@ -2830,7 +2830,7 @@ "value": { "$OCN_GRID == \"tx0.25v1\"": true, "$OCN_GRID == \"MISOMIP\"": true, - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "EPBL_IS_ADDITIVE": { @@ -2839,7 +2839,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx0.25v1\"": false, - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "GEOTHERMAL_SCALE": { @@ -2956,112 +2956,112 @@ "description": "\"[Boolean] default = True\n If true, sets the normal gradient of tangential velocity to zero in the\n relative vorticity on open boundaries. This cannot be true if another\n OBC_XXX_VORTICITY option is True.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "OBC_COMPUTED_VORTICITY": { "description": "\"[Boolean] default = False\n If true, uses the external values of tangential velocity in the relative\n vorticity on open boundaries. This cannot be true if another OBC_XXX_VORTICITY\n option is True.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "OBC_FREESLIP_STRAIN": { "description": "\"[Boolean] default = True\n If true, sets the normal gradient of tangential velocity to zero in the strain\n use in the stress tensor on open boundaries. This cannot be true if another\n OBC_XXX_STRAIN option is True.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "OBC_COMPUTED_STRAIN": { "description": "\"[Boolean] default = False\n If true, sets the normal gradient of tangential velocity to zero in the strain\n use in the stress tensor on open boundaries. This cannot be true if another\n OBC_XXX_STRAIN option is True.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "OBC_ZERO_BIHARMONIC": { "description": "\"[Boolean] default = False\n If true, zeros the Laplacian of flow on open boundaries in the biharmonic\n viscosity term.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "OBC_RAMP_TIMESCALE": { "description": "\"[days] default = 1.0\n If RAMP_OBCS is true, this sets the ramping timescale.\n\"\n", "datatype": "real", "value": { - "$MOM6_REGIONAL_MODE == True": 2.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 2.0 } }, "OBC_TRACER_RESERVOIR_LENGTH_SCALE_OUT": { "description": "\"[m] default = 0.0\nAn effective length scale for restoring the tracer concentration at the\nboundaries to externally imposed values when the flow is exiting the domain.\n\"\n", "datatype": "real", "value": { - "$MOM6_REGIONAL_MODE == True": 9000.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 9000.0 } }, "OBC_TRACER_RESERVOIR_LENGTH_SCALE_IN": { "description": "\"[m] default = 0.0\nAn effective length scale for restoring the tracer concentration at the\nboundaries to values from the interior when the flow is entering the domain.\n\"\n", "datatype": "real", "value": { - "$MOM6_REGIONAL_MODE == True": 9000.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 9000.0 } }, "DEPRESS_INITIAL_SURFACE": { "description": "\"[Boolean] default = False\n If true, depress the initial surface to avoid huge tsunamis when a large\n surface pressure is applied.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "CHANNEL_DRAG_MAX_BBL_THICK": { "description": "\"[m] default = -1.0\n The maximum bottom boundary layer thickness over which the channel drag is\n exerted, or a negative value for no fixed limit, instead basing the BBL\n thickness on the bottom stress, rotation and stratification. The default is\n proportional to HBBL if USE_JACKSON_PARAM or DRAG_AS_BODY_FORCE is true.\n\"\n", "datatype": "real", "value": { - "$MOM6_REGIONAL_MODE == True": 5.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 5.0 } }, "DIRECT_STRESS": { "description": "\"[Boolean] default = False\nIf true, the wind stress is distributed over the topmost HMIX_STRESS of fluid\n(like in HYCOM), and an added mixed layer viscosity or a physically based\nboundary layer turbulence parameterization is not needed for stability.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "SADOURNY": { "description": "\"[Boolean] default = True\n If true, the Coriolis terms are discretized with the Sadourny (1975) energy\n conserving scheme, otherwise the Arakawa & Hsu scheme is used. If the\n internal deformation radius is not resolved, the Sadourny scheme should\n probably be used.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "BT_STRONG_DRAG": { "description": "\"[Boolean] default = False\n If true, use a stronger estimate of the retarding effects of strong bottom\n drag, by making it implicit with the barotropic time-step instead of implicit\n with the baroclinic time-step and dividing by the number of barotropic steps.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": true + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, "LINEARIZED_BT_CORIOLIS": { "description": "\"[Boolean] default = True\nIf true use the bottom depth instead of the total water column thickness in\nthe barotropic Coriolis term calculations.\n\"\n", "datatype": "logical", "value": { - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "LATENT_HEAT_FUSION": { "description": "\"[J/kg] default = 3.337E+05\n The latent heat of fusion.\n\"\n", "datatype": "real", "value": { - "$MOM6_REGIONAL_MODE == True": 334000.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 334000.0 } }, "LATENT_HEAT_VAPORIZATION": { "description": "\"[J/kg] default = 2.501E+06\nThe latent heat of fusion.\n\"\n", "datatype": "real", "value": { - "$MOM6_REGIONAL_MODE == True": 2500000.0 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 2500000.0 } } }, @@ -3071,7 +3071,7 @@ "datatype": "integer", "value": { "$OCN_GRID == \"tx2_3v2\"": 3, - "$MOM6_REGIONAL_MODE == True": 3 + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 3 } }, "MATCH_TECHNIQUE": { @@ -3079,7 +3079,7 @@ "datatype": "string", "value": { "$OCN_GRID == \"tx2_3v2\"": "MatchGradient", - "$MOM6_REGIONAL_MODE == True": "MatchGradient" + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": "MatchGradient" } }, "INTERP_TYPE2": { @@ -3095,7 +3095,7 @@ "units": "Boolean", "value": { "$OCN_GRID == \"tx2_3v2\"": false, - "$MOM6_REGIONAL_MODE == True": false + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": false } }, "USE_KPP_LT_K": { From 40ae31df228a5f0e15382ab7457d02d5d52330e6 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Wed, 16 Jul 2025 16:00:23 -0600 Subject: [PATCH 06/14] Xml --- cime_config/config_component.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/cime_config/config_component.xml b/cime_config/config_component.xml index 9e3bab75..080b0b7e 100644 --- a/cime_config/config_component.xml +++ b/cime_config/config_component.xml @@ -183,13 +183,13 @@ - - logical - TRUE,FALSE - FALSE + + char + REGIONAL,GLOBAL + GLOBAL case_comp env_run.xml - Flag to turn on/off the regional defaults for MOM_input + Flag to turn on/off the regional/global defaults for MOM_input From 8b8189d9d400de5e5aba451a846faa245427ae24 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Fri, 18 Jul 2025 09:18:39 -0600 Subject: [PATCH 07/14] Add generic OBc tides params if tides is turned on --- param_templates/MOM_input.yaml | 16 ++++++++++++++++ param_templates/json/MOM_input.json | 14 ++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/param_templates/MOM_input.yaml b/param_templates/MOM_input.yaml index 356730f8..180cf9cb 100644 --- a/param_templates/MOM_input.yaml +++ b/param_templates/MOM_input.yaml @@ -3713,6 +3713,22 @@ Global: datatype: real value: $MOM6_DOMAIN_TYPE == "REGIONAL": 9000.0 + OBC_TIDE_ADD_EQ_PHASE: + description: | + "[Boolean] default = False + If true, add the equilibrium phase argument to the specified tidal phases. + " + datatype: logical + value: + $MOM6_DOMAIN_TYPE == "REGIONAL": True + OBC_TIDE_ADD_NODAL: + description: | + "[Boolean] default = False + If true, include 18.6 year nodal modulation in the boundary tidal forcing. + " + datatype: logical + value: + $MOM6_DOMAIN_TYPE == "REGIONAL": True DEPRESS_INITIAL_SURFACE: description: | "[Boolean] default = False diff --git a/param_templates/json/MOM_input.json b/param_templates/json/MOM_input.json index d66ae0fd..598c8fa9 100644 --- a/param_templates/json/MOM_input.json +++ b/param_templates/json/MOM_input.json @@ -3008,6 +3008,20 @@ "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": 9000.0 } }, + "OBC_TIDE_ADD_EQ_PHASE": { + "description": "\"[Boolean] default = False\n If true, add the equilibrium phase argument to the specified tidal phases.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true + } + }, + "OBC_TIDE_ADD_NODAL": { + "description": "\"[Boolean] default = False\n If true, include 18.6 year nodal modulation in the boundary tidal forcing.\n\"\n", + "datatype": "logical", + "value": { + "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true + } + }, "DEPRESS_INITIAL_SURFACE": { "description": "\"[Boolean] default = False\n If true, depress the initial surface to avoid huge tsunamis when a large\n surface pressure is applied.\n\"\n", "datatype": "logical", From d8cd2bd4114589882bf22e81746e7b118fb13102 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Tue, 26 Aug 2025 13:17:26 -0600 Subject: [PATCH 08/14] Minor --- param_templates/MOM_input.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/param_templates/MOM_input.yaml b/param_templates/MOM_input.yaml index 47520961..25bb95d1 100644 --- a/param_templates/MOM_input.yaml +++ b/param_templates/MOM_input.yaml @@ -3947,7 +3947,8 @@ Global: " datatype: real value: - $MOM6_DOMAIN_TYPE == "REGIONAL": 2.5E+06 RESTART_CHECKSUMS_REQUIRED: + $MOM6_DOMAIN_TYPE == "REGIONAL": 2.5E+06 + RESTART_CHECKSUMS_REQUIRED: description: | "[Boolean] default = True If true, require the restart checksums to match and error out otherwise. Users From 7370436a7634b7f4f73ab55491336e775e5eca51 Mon Sep 17 00:00:00 2001 From: Manish Venumuddula <80477243+manishvenu@users.noreply.github.com> Date: Tue, 30 Sep 2025 15:59:28 -0400 Subject: [PATCH 09/14] Update MOM_input.yaml --- param_templates/MOM_input.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/param_templates/MOM_input.yaml b/param_templates/MOM_input.yaml index 25bb95d1..486ff7cd 100644 --- a/param_templates/MOM_input.yaml +++ b/param_templates/MOM_input.yaml @@ -125,7 +125,6 @@ Global: datatype: logical units: Boolean value: - $OCN_GRID == "tx2_3v2": True $MOM6_DOMAIN_TYPE == "REGIONAL": True USE_REGRIDDING: description: | From 42866e846cd523b8aa416e6deb3e7de57472b8c8 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Tue, 30 Sep 2025 14:00:46 -0600 Subject: [PATCH 10/14] Bleh --- param_templates/json/MOM_input.json | 1 - 1 file changed, 1 deletion(-) diff --git a/param_templates/json/MOM_input.json b/param_templates/json/MOM_input.json index cdb8ac1b..940913eb 100644 --- a/param_templates/json/MOM_input.json +++ b/param_templates/json/MOM_input.json @@ -74,7 +74,6 @@ "datatype": "logical", "units": "Boolean", "value": { - "$OCN_GRID == \"tx2_3v2\"": true, "$MOM6_DOMAIN_TYPE == \"REGIONAL\"": true } }, From 99c5616c117826a07333a90fc78c54579c09969d Mon Sep 17 00:00:00 2001 From: manishvenu Date: Tue, 30 Sep 2025 14:30:34 -0600 Subject: [PATCH 11/14] BGC Regional INut NML change --- param_templates/input_nml.yaml | 8 ++++++++ param_templates/json/input_nml.json | 12 ++++++++++++ 2 files changed, 20 insertions(+) diff --git a/param_templates/input_nml.yaml b/param_templates/input_nml.yaml index 17c374fa..b9b26ca5 100644 --- a/param_templates/input_nml.yaml +++ b/param_templates/input_nml.yaml @@ -72,4 +72,12 @@ nam_stochy: values: 21600 ISEED_OCNSKEB: values: 20 + +time_interp_external_nml: + max_fields: + values: + $MARBL_CONFIG != "off" and $MOM6_DOMAIN_TYPE == "REGIONAL": 200 + max_files: + values: + $MARBL_CONFIG != "off" and $MOM6_DOMAIN_TYPE == "REGIONAL": 200 ... diff --git a/param_templates/json/input_nml.json b/param_templates/json/input_nml.json index 18882363..a19c26f8 100644 --- a/param_templates/json/input_nml.json +++ b/param_templates/json/input_nml.json @@ -91,5 +91,17 @@ "ISEED_OCNSKEB": { "values": 20 } + }, + "time_interp_external_nml": { + "max_fields": { + "values": { + "$MARBL_CONFIG != \"off\" and $MOM6_DOMAIN_TYPE == \"REGIONAL\"": 200 + } + }, + "max_files": { + "values": { + "$MARBL_CONFIG != \"off\" and $MOM6_DOMAIN_TYPE == \"REGIONAL\"": 200 + } + } } } \ No newline at end of file From 432f98208de5563103c366ffe124bd74dedb94e6 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Fri, 10 Oct 2025 12:09:10 -0600 Subject: [PATCH 12/14] Add Compset Aliases and %regional triggers the MOm6_domain_type --- cime_config/config_component.xml | 3 +++ cime_config/config_compsets.xml | 12 ++++++++++++ 2 files changed, 15 insertions(+) diff --git a/cime_config/config_component.xml b/cime_config/config_component.xml index 699c7c8b..9dbcd39a 100644 --- a/cime_config/config_component.xml +++ b/cime_config/config_component.xml @@ -208,6 +208,9 @@ char REGIONAL,GLOBAL GLOBAL + + REGIONAL + case_comp env_run.xml Flag to turn on/off the regional/global defaults for MOM_input diff --git a/cime_config/config_compsets.xml b/cime_config/config_compsets.xml index 6e5cf63b..bae5364f 100644 --- a/cime_config/config_compsets.xml +++ b/cime_config/config_compsets.xml @@ -73,6 +73,18 @@ 1850_DATM%JRA_SLND_DICE%SSMI_MOM6%MARBL-ABIO_DROF%JRA_SGLC_SWAV + + + + CR_JRA + 1850_DATM%JRA_SLND_SICE_MOM6%REGIONAL_SROF_SGLC_SWAV + + + + CR1850MARBL_JRA + 1850_DATM%JRA_SLND_SICE_MOM6%REGIONAL_SROF_SGLC_SWAV + + From 16e5358f252f4a603c6b413b6617bb9d1869098c Mon Sep 17 00:00:00 2001 From: manishvenu Date: Fri, 10 Oct 2025 12:58:32 -0600 Subject: [PATCH 13/14] Compset --- cime_config/config_compsets.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cime_config/config_compsets.xml b/cime_config/config_compsets.xml index bae5364f..3157be6e 100644 --- a/cime_config/config_compsets.xml +++ b/cime_config/config_compsets.xml @@ -74,7 +74,7 @@ - + CR_JRA 1850_DATM%JRA_SLND_SICE_MOM6%REGIONAL_SROF_SGLC_SWAV @@ -82,7 +82,7 @@ CR1850MARBL_JRA - 1850_DATM%JRA_SLND_SICE_MOM6%REGIONAL_SROF_SGLC_SWAV + 1850_DATM%JRA_SLND_SICE_MOM6%REGIONAL%MARBL-BIO_SROF_SGLC_SWAV From e9a5b561aa437f06c36be0664aa85a9cf16d82c0 Mon Sep 17 00:00:00 2001 From: manishvenu Date: Fri, 10 Oct 2025 13:08:41 -0600 Subject: [PATCH 14/14] Component Changes --- cime_config/config_component.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/cime_config/config_component.xml b/cime_config/config_component.xml index 9dbcd39a..334233d5 100644 --- a/cime_config/config_component.xml +++ b/cime_config/config_component.xml @@ -5,9 +5,10 @@ - MOM6 OCEAN + MOM6 OCEAN MARBL Biogeochemistry Tracer Library base biotic tracers MARBL Biogeochemistry Tracer Library abiotic DIC tracers + Regional