Skip to content

Commit

Permalink
MOM6: turn off tidal momentum forcing
Browse files Browse the repository at this point in the history 
Update MOM_parameter_docs
  • Loading branch information
@dougiesquire
dougiesquire committed Feb 20, 2025
1 parent a706052 commit b7947cf
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 107 deletions.
9 changes: 0 additions & 9 deletions MOM_input
View file
Original file line number Diff line number Diff line change
Expand Up @@ -378,8 +378,6 @@ USE_KH_IN_MEKE = True ! [Boolean] default = False
! If true, uses the thickness diffusivity calculated here to diffuse MEKE.

! === module MOM_dynamics_split_RK2 ===
TIDES = True ! [Boolean] default = False
! If true, apply tidal momentum forcing.
VISC_REM_BUG = False ! [Boolean] default = True
! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted
! for in two places. This parameter controls the defaults of two individual
Expand All @@ -404,13 +402,6 @@ BOUND_CORIOLIS = True ! [Boolean] default = False
! option would have no effect on the SADOURNY Coriolis scheme if it were
! possible to use centered difference thickness fluxes.

! === module MOM_self_attr_load ===

! === module MOM_tidal_forcing ===
TIDE_M2 = True ! [Boolean] default = False
! If true, apply tidal momentum forcing at the M2 frequency. This is only used
! if TIDES is true.

! === module MOM_PressureForce ===

! === module MOM_PressureForce_FV ===
Expand Down
91 changes: 2 additions & 89 deletions docs/MOM_parameter_doc.all
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1129,9 +1129,9 @@ STANLEY_COEFF = -1.0 ! [nondim] default = -1.0
! Coefficient correlating the temperature gradient and SGS T variance.

! === module MOM_dynamics_split_RK2 ===
TIDES = True ! [Boolean] default = False
TIDES = False ! [Boolean] default = False
! If true, apply tidal momentum forcing.
CALCULATE_SAL = True ! [Boolean] default = True
CALCULATE_SAL = False ! [Boolean] default = False
! If true, calculate self-attraction and loading.
BE = 0.6 ! [nondim] default = 0.6
! If SPLIT is true, BE determines the relative weighting of a 2nd-order
Expand Down Expand Up @@ -1239,88 +1239,6 @@ PV_ADV_SCHEME = "PV_ADV_CENTERED" ! default = "PV_ADV_CENTERED"
! PV_ADV_CENTERED - centered (aka Sadourny, 75)
! PV_ADV_UPWIND1 - upwind, first order

! === module MOM_self_attr_load ===
SAL_SCALAR_APPROX = True ! [Boolean] default = True
! If true, use the scalar approximation to calculate self-attraction and
! loading.
SAL_SCALAR_VALUE = 0.0 ! [m m-1] default = 0.0
! The constant of proportionality between sea surface height (really it should
! be bottom pressure) anomalies and bottom geopotential anomalies. This is only
! used if USE_SAL_SCALAR is true or USE_PREVIOUS_TIDES is true.
SAL_HARMONICS = False ! [Boolean] default = False
! If true, use the online spherical harmonics method to calculate
! self-attraction and loading.

! === module MOM_tidal_forcing ===
TIDE_M2 = True ! [Boolean] default = False
! If true, apply tidal momentum forcing at the M2 frequency. This is only used
! if TIDES is true.
TIDE_S2 = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the S2 frequency. This is only used
! if TIDES is true.
TIDE_N2 = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the N2 frequency. This is only used
! if TIDES is true.
TIDE_K2 = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the K2 frequency. This is only used
! if TIDES is true.
TIDE_K1 = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the K1 frequency. This is only used
! if TIDES is true.
TIDE_O1 = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the O1 frequency. This is only used
! if TIDES is true.
TIDE_P1 = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the P1 frequency. This is only used
! if TIDES is true.
TIDE_Q1 = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the Q1 frequency. This is only used
! if TIDES is true.
TIDE_MF = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the MF frequency. This is only used
! if TIDES is true.
TIDE_MM = False ! [Boolean] default = False
! If true, apply tidal momentum forcing at the MM frequency. This is only used
! if TIDES is true.
TIDAL_SAL_FROM_FILE = False ! [Boolean] default = False
! If true, read the tidal self-attraction and loading from input files,
! specified by TIDAL_INPUT_FILE. This is only used if TIDES is true.
USE_PREVIOUS_TIDES = False ! [Boolean] default = False
! If true, use the SAL from the previous iteration of the tides to facilitate
! convergent iteration. This is only used if TIDES is true.
TIDE_REF_DATE = 0, 0, 0 ! default = 0
! Year,month,day to use as reference date for tidal forcing. If not specified,
! defaults to 0.
TIDE_USE_EQ_PHASE = False ! [Boolean] default = False
! Correct phases by calculating equilibrium phase arguments for TIDE_REF_DATE.
TIDE_M2_FREQ = 1.405189E-04 ! [s-1] default = 1.405189E-04
! Frequency of the M2 tidal constituent. This is only used if TIDES and TIDE_M2
! are true, or if OBC_TIDE_N_CONSTITUENTS > 0 and M2 is in
! OBC_TIDE_CONSTITUENTS.
TIDE_M2_AMP = 0.242334 ! [m] default = 0.242334
! Amplitude of the M2 tidal constituent. This is only used if TIDES and TIDE_M2
! are true.
TIDE_M2_PHASE_T0 = 0.0 ! [radians] default = 0.0
! Phase of the M2 tidal constituent at time 0. This is only used if TIDES and
! TIDE_M2 are true.
HA_START_TIME = 0.0 ! [days] default = 0.0
! Start time of harmonic analysis, in units of days after the start of the
! current run segment. Must be smaller than HA_END_TIME, otherwise harmonic
! analysis will not be performed. If negative, |HA_START_TIME| determines the
! length of harmonic analysis, and harmonic analysis will start |HA_START_TIME|
! days before HA_END_TIME, or at the beginning of the run segment, whichever
! occurs later.
HA_END_TIME = 0.0 ! [days] default = 0.0
! End time of harmonic analysis, in units of days after the start of the current
! run segment. Must be positive and smaller than the length of the currnet run
! segment, otherwise harmonic analysis will not be performed.
HA_SSH = False ! [Boolean] default = False
! If true, perform harmonic analysis of sea serface height.
HA_UBT = False ! [Boolean] default = False
! If true, perform harmonic analysis of zonal barotropic velocity.
HA_VBT = False ! [Boolean] default = False
! If true, perform harmonic analysis of meridional barotropic velocity.

! === module MOM_PressureForce ===
ANALYTIC_FV_PGF = True ! [Boolean] default = True
! If true the pressure gradient forces are calculated with a finite volume form
Expand All @@ -1333,11 +1251,6 @@ RHO_PGF_REF = 1035.0 ! [kg m-3] default = 1035.0
! The reference density that is subtracted off when calculating pressure
! gradient forces. Its inverse is subtracted off of specific volumes when in
! non-Boussinesq mode. The default is RHO_0.
TIDES_ANSWER_DATE = 20230630 ! default = 20230630
! The vintage of self-attraction and loading (SAL) and tidal forcing
! calculations in Boussinesq mode. Values below 20230701 recover the old answers
! in which the SAL is part of the tidal forcing calculation. The change is due
! to a reordered summation and the difference is only at bit level.
SSH_IN_EOS_PRESSURE_FOR_PGF = False ! [Boolean] default = False
! If true, include contributions from the sea surface height in the height-based
! pressure used in the equation of state calculations for the Boussinesq
Expand Down
9 changes: 0 additions & 9 deletions docs/MOM_parameter_doc.short
View file
Original file line number Diff line number Diff line change
Expand Up @@ -354,8 +354,6 @@ USE_KH_IN_MEKE = True ! [Boolean] default = False
! If true, uses the thickness diffusivity calculated here to diffuse MEKE.

! === module MOM_dynamics_split_RK2 ===
TIDES = True ! [Boolean] default = False
! If true, apply tidal momentum forcing.
VISC_REM_BUG = False ! [Boolean] default = True
! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted
! for in two places. This parameter controls the defaults of two individual
Expand All @@ -380,13 +378,6 @@ BOUND_CORIOLIS = True ! [Boolean] default = False
! option would have no effect on the SADOURNY Coriolis scheme if it were
! possible to use centered difference thickness fluxes.

! === module MOM_self_attr_load ===

! === module MOM_tidal_forcing ===
TIDE_M2 = True ! [Boolean] default = False
! If true, apply tidal momentum forcing at the M2 frequency. This is only used
! if TIDES is true.

! === module MOM_PressureForce ===

! === module MOM_PressureForce_FV ===
Expand Down

0 comments on commit b7947cf

Please sign in to comment.