Nodal Modulation

Added a few obsolete parameters back for compatibility.
NOAA-GFDL · Dec 16, 2024 · 59211b6 · 59211b6
1 parent 7a64956
commit 59211b6
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/src/core/MOM_open_boundary.F90 b/src/core/MOM_open_boundary.F90
@@ -1194,6 +1194,27 @@ subroutine initialize_obc_tides(OBC, US, param_file)
       "Fixed reference date to use for nodal modulation of boundary tides.", &
       default=0, do_not_log=tides)
 
+  ! The following parameters are to be obsolete in the future
+  call get_param(param_file, mdl, "OBC_TIDE_ADD_EQ_PHASE", OBC%add_eq_phase, &
+      "If true, add the equilibrium phase argument to the specified tidal phases. "//&
+      "This parameter will be obsolete in the future. Instead use TIDE_USE_EQ_PHASE.", &
+      fail_if_missing=.false.)
+
+  call get_param(param_file, mdl, "OBC_TIDE_ADD_NODAL", OBC%add_nodal_terms, &
+      "If true, include 18.6 year nodal modulation in the boundary tidal forcing. "//&
+      "This parameter will be obsolete in the future. Instead use TIDE_ADD_NODAL.", &
+      fail_if_missing=.false.)
+
+  call get_param(param_file, mdl, "OBC_TIDE_REF_DATE", tide_ref_date, &
+      "Reference date to use for tidal calculations and equilibrium phase. "//&
+      "This parameter will be obsolete in the future. Instead use TIDE_REF_DATE.", &
+      fail_if_missing=.false.)
+
+  call get_param(param_file, mdl, "OBC_TIDE_NODAL_REF_DATE", nodal_ref_date, &
+      "Fixed reference date to use for nodal modulation of boundary tides. "//&
+      "This parameter will be obsolete in the future. Instead use TIDE_NODAL_REF_DATE.", &
+      fail_if_missing=.false.)
+
   if (.not. OBC%add_eq_phase) then
     ! If equilibrium phase argument is not added, the input phases
     ! should already be relative to the reference time.

diff --git a/src/diagnostics/MOM_obsolete_params.F90 b/src/diagnostics/MOM_obsolete_params.F90
@@ -155,10 +155,11 @@ subroutine find_obsolete_params(param_file)
   call obsolete_logical(param_file, "USE_GRID_SPACE_DIAGNOSTIC_AXES", &
                         hint="Instead use USE_INDEX_DIAGNOSTIC_AXIS.")
 
-  call obsolete_logical(param_file, "OBC_TIDE_ADD_EQ_PHASE", hint="Instead use TIDE_USE_EQ_PHASE.")
-  call obsolete_logical(param_file, "OBC_TIDE_ADD_NODAL", hint="Instead use TIDE_ADD_NODAL.")
-  call obsolete_int(param_file, "OBC_TIDE_REF_DATE", hint="Instead use TIDE_REF_DATE.")
-  call obsolete_int(param_file, "OBC_TIDE_NODAL_REF_DATE", hint="Instead use TIDE_NODAL_REF_DATE.")
+! These parameters will be obsolete in the future
+!  call obsolete_logical(param_file, "OBC_TIDE_ADD_EQ_PHASE", hint="Instead use TIDE_USE_EQ_PHASE.")
+!  call obsolete_logical(param_file, "OBC_TIDE_ADD_NODAL", hint="Instead use TIDE_ADD_NODAL.")
+!  call obsolete_int(param_file, "OBC_TIDE_REF_DATE", hint="Instead use TIDE_REF_DATE.")
+!  call obsolete_int(param_file, "OBC_TIDE_NODAL_REF_DATE", hint="Instead use TIDE_NODAL_REF_DATE.")
 
   ! Write the file version number to the model log.
   call log_version(param_file, mdl, version)