Skip to content

Commit 0a79b7d

Browse files
authored
Merge pull request #256 from NOAA-GFDL/auto/update-submodules-20260128
Auto-update submodules to latest dev/cefi (auto/update-submodules-20260128)
2 parents 0b4447d + b212679 commit 0a79b7d

5 files changed

Lines changed: 63 additions & 35 deletions

File tree

exps/NEP10.COBALT/MOM_parameter_doc.all

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,9 @@ USE_TRIPOLAR_GEOLONB_BUG = False ! [Boolean] default = False
242242
! along the tripolar fold to be off by 360 degrees.
243243
RAD_EARTH = 6.378E+06 ! [m] default = 6.378E+06
244244
! The radius of the Earth.
245+
READ_MEAN_SEA_LEVEL = False ! [Boolean] default = False
246+
! If true, use a 2D map for time mean sea level, which is used to calculate time
247+
! mean ocean total thickness.
245248
TOPO_CONFIG = "file" !
246249
! This specifies how bathymetry is specified:
247250
! file - read bathymetric information from the file
@@ -377,6 +380,12 @@ OBC_TRACER_RESERVOIR_LENGTH_SCALE_OUT = 9000.0 ! [m] default = 0.0
377380
OBC_TRACER_RESERVOIR_LENGTH_SCALE_IN = 9000.0 ! [m] default = 0.0
378381
! An effective length scale for restoring the tracer concentration at the
379382
! boundaries to values from the interior when the flow is entering the domain.
383+
OBC_THICKNESS_RESERVOIR_LENGTH_SCALE_OUT = 0.0 ! [m] default = 0.0
384+
! An effective length scale for restoring the layer thickness at the boundaries
385+
! to externally imposed values when the flow is exiting the domain.
386+
OBC_THICKNESS_RESERVOIR_LENGTH_SCALE_IN = 0.0 ! [m] default = 0.0
387+
! An effective length scale for restoring the layer thickness at the boundaries
388+
! to values from the interior when the flow is entering the domain.
380389
OBC_REMAPPING_SCHEME = "PPM_H4" ! default = "PPM_H4"
381390
! This sets the reconstruction scheme used for OBC vertical remapping for all
382391
! variables. It can be one of the following schemes:
@@ -914,6 +923,9 @@ MIXING_COEFS_OBC_BUG = True ! [Boolean] default = True
914923
! If false, use only interior data for thickness weighting in lateral mixing
915924
! coefficient calculations and to calculate stratification and other fields at
916925
! open boundary condition faces.
926+
RESOLN_FUNCTION_OBC_BUG = True ! [Boolean] default = True
927+
! If false, use only interior data for calculating the resolution functions at
928+
! open boundary condition faces and vertices.
917929
KD_SMOOTH = 1.0E-06 ! [m2 s-1] default = 1.0E-06
918930
! A diapycnal diffusivity that is used to interpolate more sensible values of T
919931
! & S into thin layers.
@@ -937,6 +949,13 @@ DRAG_AS_BODY_FORCE = False ! [Boolean] default = False
937949
CHANNEL_DRAG = True ! [Boolean] default = False
938950
! If true, the bottom drag is exerted directly on each layer proportional to the
939951
! fraction of the bottom it overlies.
952+
CHANNEL_DRAG_SHELFBREAK_DEPTH = 0.0 ! [m] default = 0.0
953+
! When CHANNEL_DRAG is true, the bathymetric depth interpolated to the vorticity
954+
! point is a combination of the harmonic mean of the adjacent velocity point
955+
! depths below this depth and the arithmetic mean of the depths above it, to
956+
! roughly mimic a continental shelf break profile. Setting this to exceed
957+
! MAXIMUM_DEPTH leads to linear interpolation of the topography between velocity
958+
! points.
940959
LINEAR_DRAG = False ! [Boolean] default = False
941960
! If LINEAR_DRAG and BOTTOMDRAGLAW are defined the drag law is
942961
! cdrag*DRAG_BG_VEL*u.
@@ -951,6 +970,9 @@ HBBL = 10.0 ! [m]
951970
CDRAG = 0.003 ! [nondim] default = 0.003
952971
! CDRAG is the drag coefficient relating the magnitude of the velocity field to
953972
! the bottom stress. CDRAG is only used if BOTTOMDRAGLAW is defined.
973+
CDRAG_MAP = False ! [Boolean] default = False
974+
! If true, apply a spatially varying scaling factor to CDRAG, specified by
975+
! CDRAG_VAR in CDRAG_FILE.
954976
BBL_USE_TIDAL_BG = False ! [Boolean] default = False
955977
! Flag to use the tidal RMS amplitude in place of constant background velocity
956978
! for computing u* in the BBL. This flag is only used when BOTTOMDRAGLAW is true
@@ -1056,6 +1078,8 @@ TIDES = True ! [Boolean] default = False
10561078
! If true, apply tidal momentum forcing.
10571079
CALCULATE_SAL = True ! [Boolean] default = True
10581080
! If true, calculate self-attraction and loading.
1081+
USE_HA = False ! [Boolean] default = False
1082+
! If true, perform inline harmonic analysis.
10591083
BE = 0.6 ! [nondim] default = 0.6
10601084
! If SPLIT is true, BE determines the relative weighting of a 2nd-order
10611085
! Runga-Kutta baroclinic time stepping scheme (0.5) and a backward Euler scheme
@@ -1136,6 +1160,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True
11361160
CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True
11371161
! If true, use the marginal face areas from the continuity solver for use as the
11381162
! weights in the barotropic solver. Otherwise use the transport averaged areas.
1163+
CONT_USE_H_MARG_MIN = False ! [Boolean] default = False
1164+
! If true, the marginal thickness used and returned from continuity is bounded
1165+
! from below by a sub-roundoff value. Otherwise the minimum is 0.
11391166

11401167
! === module MOM_CoriolisAdv ===
11411168
NOSLIP = False ! [Boolean] default = False
@@ -1296,23 +1323,6 @@ TIDE_ADD_NODAL = True ! [Boolean] default = False
12961323
TIDE_NODAL_REF_DATE = 1993, 7, 2 ! default = 0, 0, 0
12971324
! Fixed reference date to use for nodal modulation of astronomical tidal
12981325
! forcing.
1299-
HA_START_TIME = 0.0 ! [days] default = 0.0
1300-
! Start time of harmonic analysis, in units of days after the start of the
1301-
! current run segment. Must be smaller than HA_END_TIME, otherwise harmonic
1302-
! analysis will not be performed. If negative, |HA_START_TIME| determines the
1303-
! length of harmonic analysis, and harmonic analysis will start |HA_START_TIME|
1304-
! days before HA_END_TIME, or at the beginning of the run segment, whichever
1305-
! occurs later.
1306-
HA_END_TIME = 0.0 ! [days] default = 0.0
1307-
! End time of harmonic analysis, in units of days after the start of the current
1308-
! run segment. Must be positive and smaller than the length of the currnet run
1309-
! segment, otherwise harmonic analysis will not be performed.
1310-
HA_SSH = False ! [Boolean] default = False
1311-
! If true, perform harmonic analysis of sea serface height.
1312-
HA_UBT = False ! [Boolean] default = False
1313-
! If true, perform harmonic analysis of zonal barotropic velocity.
1314-
HA_VBT = False ! [Boolean] default = False
1315-
! If true, perform harmonic analysis of meridional barotropic velocity.
13161326

13171327
! === module MOM_PressureForce ===
13181328
ANALYTIC_FV_PGF = True ! [Boolean] default = True
@@ -1381,6 +1391,7 @@ PRESSURE_RECONSTRUCTION_SCHEME = 1 ! default = 1
13811391
! 0: PCM or no reconstruction.
13821392
! 1: PLM reconstruction.
13831393
! 2: PPM reconstruction.
1394+
! 3: PLM with least squares slope.
13841395
BOUNDARY_EXTRAPOLATION_PRESSURE = True ! [Boolean] default = True
13851396
! If true, the reconstruction of T & S for pressure in boundary cells is
13861397
! extrapolated, rather than using PCM in these cells. If true, the same order

exps/NWA12.COBALT/MOM_parameter_doc.all

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,9 @@ USE_TRIPOLAR_GEOLONB_BUG = False ! [Boolean] default = False
242242
! along the tripolar fold to be off by 360 degrees.
243243
RAD_EARTH = 6.378E+06 ! [m] default = 6.378E+06
244244
! The radius of the Earth.
245+
READ_MEAN_SEA_LEVEL = False ! [Boolean] default = False
246+
! If true, use a 2D map for time mean sea level, which is used to calculate time
247+
! mean ocean total thickness.
245248
TOPO_CONFIG = "file" !
246249
! This specifies how bathymetry is specified:
247250
! file - read bathymetric information from the file
@@ -371,6 +374,12 @@ OBC_TRACER_RESERVOIR_LENGTH_SCALE_OUT = 9000.0 ! [m] default = 0.0
371374
OBC_TRACER_RESERVOIR_LENGTH_SCALE_IN = 9000.0 ! [m] default = 0.0
372375
! An effective length scale for restoring the tracer concentration at the
373376
! boundaries to values from the interior when the flow is entering the domain.
377+
OBC_THICKNESS_RESERVOIR_LENGTH_SCALE_OUT = 0.0 ! [m] default = 0.0
378+
! An effective length scale for restoring the layer thickness at the boundaries
379+
! to externally imposed values when the flow is exiting the domain.
380+
OBC_THICKNESS_RESERVOIR_LENGTH_SCALE_IN = 0.0 ! [m] default = 0.0
381+
! An effective length scale for restoring the layer thickness at the boundaries
382+
! to values from the interior when the flow is entering the domain.
374383
OBC_REMAPPING_SCHEME = "PPM_H4" ! default = "PPM_H4"
375384
! This sets the reconstruction scheme used for OBC vertical remapping for all
376385
! variables. It can be one of the following schemes:
@@ -915,6 +924,9 @@ MIXING_COEFS_OBC_BUG = True ! [Boolean] default = True
915924
! If false, use only interior data for thickness weighting in lateral mixing
916925
! coefficient calculations and to calculate stratification and other fields at
917926
! open boundary condition faces.
927+
RESOLN_FUNCTION_OBC_BUG = True ! [Boolean] default = True
928+
! If false, use only interior data for calculating the resolution functions at
929+
! open boundary condition faces and vertices.
918930
KD_SMOOTH = 1.0E-06 ! [m2 s-1] default = 1.0E-06
919931
! A diapycnal diffusivity that is used to interpolate more sensible values of T
920932
! & S into thin layers.
@@ -949,6 +961,13 @@ DRAG_AS_BODY_FORCE = False ! [Boolean] default = False
949961
CHANNEL_DRAG = True ! [Boolean] default = False
950962
! If true, the bottom drag is exerted directly on each layer proportional to the
951963
! fraction of the bottom it overlies.
964+
CHANNEL_DRAG_SHELFBREAK_DEPTH = 0.0 ! [m] default = 0.0
965+
! When CHANNEL_DRAG is true, the bathymetric depth interpolated to the vorticity
966+
! point is a combination of the harmonic mean of the adjacent velocity point
967+
! depths below this depth and the arithmetic mean of the depths above it, to
968+
! roughly mimic a continental shelf break profile. Setting this to exceed
969+
! MAXIMUM_DEPTH leads to linear interpolation of the topography between velocity
970+
! points.
952971
LINEAR_DRAG = False ! [Boolean] default = False
953972
! If LINEAR_DRAG and BOTTOMDRAGLAW are defined the drag law is
954973
! cdrag*DRAG_BG_VEL*u.
@@ -963,6 +982,9 @@ HBBL = 10.0 ! [m]
963982
CDRAG = 0.003 ! [nondim] default = 0.003
964983
! CDRAG is the drag coefficient relating the magnitude of the velocity field to
965984
! the bottom stress. CDRAG is only used if BOTTOMDRAGLAW is defined.
985+
CDRAG_MAP = False ! [Boolean] default = False
986+
! If true, apply a spatially varying scaling factor to CDRAG, specified by
987+
! CDRAG_VAR in CDRAG_FILE.
966988
BBL_USE_TIDAL_BG = False ! [Boolean] default = False
967989
! Flag to use the tidal RMS amplitude in place of constant background velocity
968990
! for computing u* in the BBL. This flag is only used when BOTTOMDRAGLAW is true
@@ -1068,6 +1090,8 @@ TIDES = True ! [Boolean] default = False
10681090
! If true, apply tidal momentum forcing.
10691091
CALCULATE_SAL = True ! [Boolean] default = True
10701092
! If true, calculate self-attraction and loading.
1093+
USE_HA = False ! [Boolean] default = False
1094+
! If true, perform inline harmonic analysis.
10711095
BE = 0.6 ! [nondim] default = 0.6
10721096
! If SPLIT is true, BE determines the relative weighting of a 2nd-order
10731097
! Runga-Kutta baroclinic time stepping scheme (0.5) and a backward Euler scheme
@@ -1148,6 +1172,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True
11481172
CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True
11491173
! If true, use the marginal face areas from the continuity solver for use as the
11501174
! weights in the barotropic solver. Otherwise use the transport averaged areas.
1175+
CONT_USE_H_MARG_MIN = False ! [Boolean] default = False
1176+
! If true, the marginal thickness used and returned from continuity is bounded
1177+
! from below by a sub-roundoff value. Otherwise the minimum is 0.
11511178

11521179
! === module MOM_CoriolisAdv ===
11531180
NOSLIP = False ! [Boolean] default = False
@@ -1308,23 +1335,6 @@ TIDE_ADD_NODAL = True ! [Boolean] default = False
13081335
TIDE_NODAL_REF_DATE = 1993, 7, 2 ! default = 0, 0, 0
13091336
! Fixed reference date to use for nodal modulation of astronomical tidal
13101337
! forcing.
1311-
HA_START_TIME = 0.0 ! [days] default = 0.0
1312-
! Start time of harmonic analysis, in units of days after the start of the
1313-
! current run segment. Must be smaller than HA_END_TIME, otherwise harmonic
1314-
! analysis will not be performed. If negative, |HA_START_TIME| determines the
1315-
! length of harmonic analysis, and harmonic analysis will start |HA_START_TIME|
1316-
! days before HA_END_TIME, or at the beginning of the run segment, whichever
1317-
! occurs later.
1318-
HA_END_TIME = 0.0 ! [days] default = 0.0
1319-
! End time of harmonic analysis, in units of days after the start of the current
1320-
! run segment. Must be positive and smaller than the length of the currnet run
1321-
! segment, otherwise harmonic analysis will not be performed.
1322-
HA_SSH = False ! [Boolean] default = False
1323-
! If true, perform harmonic analysis of sea serface height.
1324-
HA_UBT = False ! [Boolean] default = False
1325-
! If true, perform harmonic analysis of zonal barotropic velocity.
1326-
HA_VBT = False ! [Boolean] default = False
1327-
! If true, perform harmonic analysis of meridional barotropic velocity.
13281338

13291339
! === module MOM_PressureForce ===
13301340
ANALYTIC_FV_PGF = True ! [Boolean] default = True
@@ -1393,6 +1403,7 @@ PRESSURE_RECONSTRUCTION_SCHEME = 1 ! default = 1
13931403
! 0: PCM or no reconstruction.
13941404
! 1: PLM reconstruction.
13951405
! 2: PPM reconstruction.
1406+
! 3: PLM with least squares slope.
13961407
BOUNDARY_EXTRAPOLATION_PRESSURE = True ! [Boolean] default = True
13971408
! If true, the reconstruction of T & S for pressure in boundary cells is
13981409
! extrapolated, rather than using PCM in these cells. If true, the same order

exps/NWA12.tidesonly/MOM_parameter_doc.all

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,9 @@ USE_TRIPOLAR_GEOLONB_BUG = False ! [Boolean] default = False
218218
! along the tripolar fold to be off by 360 degrees.
219219
RAD_EARTH = 6.378E+06 ! [m] default = 6.378E+06
220220
! The radius of the Earth.
221+
READ_MEAN_SEA_LEVEL = False ! [Boolean] default = False
222+
! If true, use a 2D map for time mean sea level, which is used to calculate time
223+
! mean ocean total thickness.
221224
TOPO_CONFIG = "file" !
222225
! This specifies how bathymetry is specified:
223226
! file - read bathymetric information from the file

exps/OM4.single_column.COBALT/MOM_parameter_doc.all

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,9 @@ USE_TRIPOLAR_GEOLONB_BUG = False ! [Boolean] default = False
257257
! along the tripolar fold to be off by 360 degrees.
258258
RAD_EARTH = 6.378E+06 ! [m] default = 6.378E+06
259259
! The radius of the Earth.
260+
READ_MEAN_SEA_LEVEL = False ! [Boolean] default = False
261+
! If true, use a 2D map for time mean sea level, which is used to calculate time
262+
! mean ocean total thickness.
260263
TOPO_CONFIG = "file" !
261264
! This specifies how bathymetry is specified:
262265
! file - read bathymetric information from the file

src/MOM6

Submodule MOM6 updated 38 files

0 commit comments

Comments
 (0)