Merge pull request #331 from Hallberg-NOAA/update_tides_025

Update tides_025/MOM_input and MOM_parameter_doc files
NOAA-GFDL · Mar 4, 2021 · 3ff35ef · 3ff35ef
2 parents d63e9ca + ee95e53
commit 3ff35ef
Show file tree

Hide file tree

Showing 25 changed files with 148 additions and 115 deletions.
diff --git a/ocean_only/ISOMIP/layer/MOM_parameter_doc.all b/ocean_only/ISOMIP/layer/MOM_parameter_doc.all
@@ -1520,11 +1520,14 @@ VARIABLE_BUOYFORCE = False      !   [Boolean] default = True
                                 ! If true, the buoyancy forcing varies in time after the initialization of the
                                 ! model.
 BUOY_CONFIG = "NONE"            ! default = "zero"
-                                ! The character string that indicates how buoyancy forcing is specified. Valid
-                                ! options include (file), (zero), (linear), (USER), (BFB) and (NONE).
+                                ! The character string that indicates how buoyancy forcing is specified.  Valid
+                                ! options include (file), (data_override), (zero), (const), (linear), (MESO),
+                                ! (SCM_CVmix_tests), (BFB), (dumbbell), (USER) and (NONE).
 WIND_CONFIG = "zero"            ! default = "zero"
-                                ! The character string that indicates how wind forcing is specified. Valid
-                                ! options include (file), (2gyre), (1gyre), (gyres), (zero), and (USER).
+                                ! The character string that indicates how wind forcing is specified.  Valid
+                                ! options include (file), (data_override), (2gyre), (1gyre), (gyres), (zero),
+                                ! (const), (Neverworld), (scurves), (ideal_hurr), (SCM_ideal_hurr),
+                                ! (SCM_CVmix_tests) and (USER).
 RESTOREBUOY = False             !   [Boolean] default = False
                                 ! If true, the buoyancy fluxes drive the model back toward some specified
                                 ! surface state with a rate given by FLUXCONST.

diff --git a/ocean_only/ISOMIP/layer/MOM_parameter_doc.layout b/ocean_only/ISOMIP/layer/MOM_parameter_doc.layout
@@ -16,8 +16,8 @@ GLOBAL_INDEXING = False         !   [Boolean] default = False
 NONBLOCKING_UPDATES = False     !   [Boolean] default = False
                                 ! If true, non-blocking halo updates may be used.
 THIN_HALO_UPDATES = True        !   [Boolean] default = True
-                                ! If true, optional arguments may be used to specify the the width of the halos
-                                ! that are updated with each call.
+                                ! If true, optional arguments may be used to specify the width of the halos that
+                                ! are updated with each call.
 !STATIC_MEMORY_ = False         !   [Boolean]
                                 ! If STATIC_MEMORY_ is defined, the principle variables will have sizes that are
                                 ! statically determined at compile time.  Otherwise the sizes are not determined
@@ -55,6 +55,11 @@ NIBLOCK = 1                     ! default = 1
 NJBLOCK = 1                     ! default = 1
                                 ! The number of blocks in the y-direction on each processor (for openmp).
 
+! === module MOM_domains min_halo ===
+
+! === module MOM_grid ===
+! Parameters providing information about the lateral grid.
+
 ! === module MOM_barotropic ===
 BT_USE_WIDE_HALOS = True        !   [Boolean] default = True
                                 ! If true, use wide halos and march in during the barotropic time stepping for
@@ -65,8 +70,3 @@ BTHALO = 0                      ! default = 0
                                 ! The barotropic x-halo size that is actually used.
 !BT y-halo = 0                  !
                                 ! The barotropic y-halo size that is actually used.
-
-! === module MOM_domains min_halo ===
-
-! === module MOM_grid ===
-! Parameters providing information about the lateral grid.
diff --git a/ocean_only/ISOMIP/layer/MOM_parameter_doc.short b/ocean_only/ISOMIP/layer/MOM_parameter_doc.short
@@ -429,8 +429,9 @@ VARIABLE_BUOYFORCE = False      !   [Boolean] default = True
                                 ! If true, the buoyancy forcing varies in time after the initialization of the
                                 ! model.
 BUOY_CONFIG = "NONE"            ! default = "zero"
-                                ! The character string that indicates how buoyancy forcing is specified. Valid
-                                ! options include (file), (zero), (linear), (USER), (BFB) and (NONE).
+                                ! The character string that indicates how buoyancy forcing is specified.  Valid
+                                ! options include (file), (data_override), (zero), (const), (linear), (MESO),
+                                ! (SCM_CVmix_tests), (BFB), (dumbbell), (USER) and (NONE).
 GUST_CONST = 0.02               !   [Pa] default = 0.0
                                 ! The background gustiness in the winds.
 

diff --git a/ocean_only/ISOMIP/rho/MOM_parameter_doc.all b/ocean_only/ISOMIP/rho/MOM_parameter_doc.all
@@ -1780,11 +1780,14 @@ VARIABLE_BUOYFORCE = False      !   [Boolean] default = True
                                 ! If true, the buoyancy forcing varies in time after the initialization of the
                                 ! model.
 BUOY_CONFIG = "NONE"            ! default = "zero"
-                                ! The character string that indicates how buoyancy forcing is specified. Valid
-                                ! options include (file), (zero), (linear), (USER), (BFB) and (NONE).
+                                ! The character string that indicates how buoyancy forcing is specified.  Valid
+                                ! options include (file), (data_override), (zero), (const), (linear), (MESO),
+                                ! (SCM_CVmix_tests), (BFB), (dumbbell), (USER) and (NONE).
 WIND_CONFIG = "zero"            ! default = "zero"
-                                ! The character string that indicates how wind forcing is specified. Valid
-                                ! options include (file), (2gyre), (1gyre), (gyres), (zero), and (USER).
+                                ! The character string that indicates how wind forcing is specified.  Valid
+                                ! options include (file), (data_override), (2gyre), (1gyre), (gyres), (zero),
+                                ! (const), (Neverworld), (scurves), (ideal_hurr), (SCM_ideal_hurr),
+                                ! (SCM_CVmix_tests) and (USER).
 RESTOREBUOY = False             !   [Boolean] default = False
                                 ! If true, the buoyancy fluxes drive the model back toward some specified
                                 ! surface state with a rate given by FLUXCONST.

diff --git a/ocean_only/ISOMIP/rho/MOM_parameter_doc.layout b/ocean_only/ISOMIP/rho/MOM_parameter_doc.layout
@@ -16,8 +16,8 @@ GLOBAL_INDEXING = False         !   [Boolean] default = False
 NONBLOCKING_UPDATES = False     !   [Boolean] default = False
                                 ! If true, non-blocking halo updates may be used.
 THIN_HALO_UPDATES = True        !   [Boolean] default = True
-                                ! If true, optional arguments may be used to specify the the width of the halos
-                                ! that are updated with each call.
+                                ! If true, optional arguments may be used to specify the width of the halos that
+                                ! are updated with each call.
 !STATIC_MEMORY_ = False         !   [Boolean]
                                 ! If STATIC_MEMORY_ is defined, the principle variables will have sizes that are
                                 ! statically determined at compile time.  Otherwise the sizes are not determined
@@ -55,6 +55,11 @@ NIBLOCK = 1                     ! default = 1
 NJBLOCK = 1                     ! default = 1
                                 ! The number of blocks in the y-direction on each processor (for openmp).
 
+! === module MOM_domains min_halo ===
+
+! === module MOM_grid ===
+! Parameters providing information about the lateral grid.
+
 ! === module MOM_barotropic ===
 BT_USE_WIDE_HALOS = True        !   [Boolean] default = True
                                 ! If true, use wide halos and march in during the barotropic time stepping for
@@ -65,8 +70,3 @@ BTHALO = 0                      ! default = 0
                                 ! The barotropic x-halo size that is actually used.
 !BT y-halo = 0                  !
                                 ! The barotropic y-halo size that is actually used.
-
-! === module MOM_domains min_halo ===
-
-! === module MOM_grid ===
-! Parameters providing information about the lateral grid.
diff --git a/ocean_only/ISOMIP/rho/MOM_parameter_doc.short b/ocean_only/ISOMIP/rho/MOM_parameter_doc.short
@@ -476,8 +476,9 @@ VARIABLE_BUOYFORCE = False      !   [Boolean] default = True
                                 ! If true, the buoyancy forcing varies in time after the initialization of the
                                 ! model.
 BUOY_CONFIG = "NONE"            ! default = "zero"
-                                ! The character string that indicates how buoyancy forcing is specified. Valid
-                                ! options include (file), (zero), (linear), (USER), (BFB) and (NONE).
+                                ! The character string that indicates how buoyancy forcing is specified.  Valid
+                                ! options include (file), (data_override), (zero), (const), (linear), (MESO),
+                                ! (SCM_CVmix_tests), (BFB), (dumbbell), (USER) and (NONE).
 GUST_CONST = 0.02               !   [Pa] default = 0.0
                                 ! The background gustiness in the winds.
 

diff --git a/ocean_only/MESO_025_23L/MOM_parameter_doc.all b/ocean_only/MESO_025_23L/MOM_parameter_doc.all
@@ -492,6 +492,8 @@ SPONGE_PTEMP_VAR = "PTEMP"      ! default = "PTEMP"
                                 ! The name of the potential temperature variable in SPONGE_STATE_FILE.
 SPONGE_SALT_VAR = "SALT"        ! default = "SALT"
                                 ! The name of the salinity variable in SPONGE_STATE_FILE.
+SPONGE_UV = False               !   [Boolean] default = False
+                                ! Apply sponges in u and v, in addition to tracers.
 SPONGE_ETA_VAR = "ETA"          ! default = "ETA"
                                 ! The name of the interface height variable in SPONGE_STATE_FILE.
 SPONGE_IDAMP_VAR = "Idamp"      ! default = "Idamp"
@@ -502,25 +504,17 @@ NEW_SPONGES = False             !   [of sponge restoring data.] default = False
 INTERPOLATE_SPONGE_TIME_SPACE = False !   [of sponge restoring data.] default = False
                                 ! Set True if using the newer sponging code which performs on-the-fly regridding
                                 ! in lat-lon-time.
-
-! === module MOM_sponge ===
-SPONGE_UV = False               !   [Boolean] default = False
-                                ! Apply sponges in u and v, in addition to tracers.
-REMAPPING_2018_ANSWERS = False  !   [Boolean] default = False
-                                ! If true, use the order of arithmetic and expressions that recover the answers
-                                ! from the end of 2018.  Otherwise, use updated and more robust forms of the
-                                ! same expressions.
-HOR_REGRID_2018_ANSWERS = False !   [Boolean] default = False
-                                ! If true, use the order of arithmetic for horizonal regridding that recovers
-                                ! the answers from the end of 2018.  Otherwise, use rotationally symmetric forms
-                                ! of the same expressions.
-!Total sponge columns at h points = 19376 !
-                                ! The total number of columns where sponges are applied at h points.
+!Total sponge columns = 19376   !
+                                ! The total number of columns where sponges are applied.
 
 ! === module MOM_diag_mediator ===
 NUM_DIAG_COORDS = 1             ! default = 1
                                 ! The number of diagnostic vertical coordinates to use. For each coordinate, an
                                 ! entry in DIAG_COORDS must be provided.
+REMAPPING_2018_ANSWERS = False  !   [Boolean] default = False
+                                ! If true, use the order of arithmetic and expressions that recover the answers
+                                ! from the end of 2018.  Otherwise, use updated and more robust forms of the
+                                ! same expressions.
 USE_GRID_SPACE_DIAGNOSTIC_AXES = False !   [Boolean] default = False
                                 ! If true, use a grid index coordinate convention for diagnostic axes.
 DIAG_COORDS = "z Z ZSTAR"       ! default = "z Z ZSTAR"
@@ -1570,11 +1564,14 @@ VARIABLE_BUOYFORCE = True       !   [Boolean] default = True
                                 ! If true, the buoyancy forcing varies in time after the initialization of the
                                 ! model.
 BUOY_CONFIG = "MESO"            ! default = "zero"
-                                ! The character string that indicates how buoyancy forcing is specified. Valid
-                                ! options include (file), (zero), (linear), (USER), (BFB) and (NONE).
+                                ! The character string that indicates how buoyancy forcing is specified.  Valid
+                                ! options include (file), (data_override), (zero), (const), (linear), (MESO),
+                                ! (SCM_CVmix_tests), (BFB), (dumbbell), (USER) and (NONE).
 WIND_CONFIG = "file"            ! default = "zero"
-                                ! The character string that indicates how wind forcing is specified. Valid
-                                ! options include (file), (2gyre), (1gyre), (gyres), (zero), and (USER).
+                                ! The character string that indicates how wind forcing is specified.  Valid
+                                ! options include (file), (data_override), (2gyre), (1gyre), (gyres), (zero),
+                                ! (const), (Neverworld), (scurves), (ideal_hurr), (SCM_ideal_hurr),
+                                ! (SCM_CVmix_tests) and (USER).
 WIND_FILE = "MESO_str_025.nc"   !
                                 ! The file in which the wind stresses are found in variables STRESS_X and
                                 ! STRESS_Y.

diff --git a/ocean_only/MESO_025_23L/MOM_parameter_doc.layout b/ocean_only/MESO_025_23L/MOM_parameter_doc.layout
@@ -16,8 +16,8 @@ GLOBAL_INDEXING = False         !   [Boolean] default = False
 NONBLOCKING_UPDATES = False     !   [Boolean] default = False
                                 ! If true, non-blocking halo updates may be used.
 THIN_HALO_UPDATES = True        !   [Boolean] default = True
-                                ! If true, optional arguments may be used to specify the the width of the halos
-                                ! that are updated with each call.
+                                ! If true, optional arguments may be used to specify the width of the halos that
+                                ! are updated with each call.
 !STATIC_MEMORY_ = False         !   [Boolean]
                                 ! If STATIC_MEMORY_ is defined, the principle variables will have sizes that are
                                 ! statically determined at compile time.  Otherwise the sizes are not determined

diff --git a/ocean_only/MESO_025_23L/MOM_parameter_doc.short b/ocean_only/MESO_025_23L/MOM_parameter_doc.short
@@ -194,8 +194,8 @@ SPONGE_DAMPING_FILE = "MESO_Sponge_025mNG.nc" !
                                 ! The name of the file with the sponge damping rates.
 SPONGE_STATE_FILE = "MESO_025_23L_IC.nc" ! default = "MESO_Sponge_025mNG.nc"
                                 ! The name of the file with the state to damp toward.
-
-! === module MOM_sponge ===
+!Total sponge columns = 19376   !
+                                ! The total number of columns where sponges are applied.
 
 ! === module MOM_diag_mediator ===
 
@@ -408,11 +408,14 @@ ENERGYSAVEDAYS = 0.25           !   [days] default = 1.0
 VARIABLE_WINDS = False          !   [Boolean] default = True
                                 ! If true, the winds vary in time after the initialization.
 BUOY_CONFIG = "MESO"            ! default = "zero"
-                                ! The character string that indicates how buoyancy forcing is specified. Valid
-                                ! options include (file), (zero), (linear), (USER), (BFB) and (NONE).
+                                ! The character string that indicates how buoyancy forcing is specified.  Valid
+                                ! options include (file), (data_override), (zero), (const), (linear), (MESO),
+                                ! (SCM_CVmix_tests), (BFB), (dumbbell), (USER) and (NONE).
 WIND_CONFIG = "file"            ! default = "zero"
-                                ! The character string that indicates how wind forcing is specified. Valid
-                                ! options include (file), (2gyre), (1gyre), (gyres), (zero), and (USER).
+                                ! The character string that indicates how wind forcing is specified.  Valid
+                                ! options include (file), (data_override), (2gyre), (1gyre), (gyres), (zero),
+                                ! (const), (Neverworld), (scurves), (ideal_hurr), (SCM_ideal_hurr),
+                                ! (SCM_CVmix_tests) and (USER).
 WIND_FILE = "MESO_str_025.nc"   !
                                 ! The file in which the wind stresses are found in variables STRESS_X and
                                 ! STRESS_Y.