Skip to content

Commit

Permalink
Cleaning up tides section
Browse files Browse the repository at this point in the history
  • Loading branch information
kshedstrom authored and adcroft committed Jul 26, 2024
1 parent b7fee4d commit 4f1ecf4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
9 changes: 6 additions & 3 deletions docs/parameterizations_lateral.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ See also :ref:`namespacemom__lateral__mixing__coeffs_1section_Resolution_Functio
Tidal forcing
-------------

Astronomical tidal forcings and self-attraction and loading are implement in MOM_tidal_forcing.
Tides can also be added via an open boundary tidal specification,
see `OBC wiki page <https://github.com/NOAA-GFDL/MOM6-examples/wiki/Open-Boundary-Conditions>`_.
Astronomical tidal forcings and self-attraction and loading are implement in

:ref:`namespacetidal__forcing_1section_tides`

The Love numbers are stored internally in MOM_load_love_numbers:

Expand All @@ -71,3 +71,6 @@ while the self attraction and loading is computed in MOM_self_attr_load:
The self attraction and loading needs spherical harmonics, computed in MOM_spherical_harmonics:

:ref:`namespacemom__spherical__harmonics_1section_spherical_harmonics`

Tides can also be added via an open boundary tidal specification,
see `OBC wiki page <https://github.com/NOAA-GFDL/MOM6-examples/wiki/Open-Boundary-Conditions>`_.
12 changes: 7 additions & 5 deletions src/parameterizations/lateral/MOM_tidal_forcing.F90
Original file line number Diff line number Diff line change
Expand Up @@ -744,6 +744,8 @@ end subroutine tidal_forcing_end

!> \namespace tidal_forcing
!!
!! \section section_tides Tidal forcing
!!
!! Code by Robert Hallberg, August 2005, based on C-code by Harper
!! Simmons, February, 2003, in turn based on code by Brian Arbic.
!!
Expand All @@ -762,14 +764,14 @@ end subroutine tidal_forcing_end
!!
!! In addition, approaches to calculate self-attraction and loading
!! due to tides (harmonics of astronomical forcing frequencies)
!! are provided. TIDAL_SAL_FROM_FILE can be set to read the phase and
!! amplitude of the tidal SAL. USE_PREVIOUS_TIDES may be useful in
!! are provided. <code>TIDAL_SAL_FROM_FILE</code> can be set to read the phase and
!! amplitude of the tidal SAL. <code>USE_PREVIOUS_TIDES</code> may be useful in
!! combination with the scalar approximation to iterate the SAL to
!! convergence (for details, see \cite Arbic2004). With
!! TIDAL_SAL_FROM_FILE or USE_PREVIOUS_TIDES, a list of input files
!! must be provided to describe each constituent's properties from
!! <code>TIDAL_SAL_FROM_FILE</code> or <code>USE_PREVIOUS_TIDES</code>, a list of input
!! files must be provided to describe each constituent's properties from
!! a previous solution. The online SAL calculations that are functions
!! of SSH (rather should be bottom pressure anmoaly), either a scalar
!! approximation or with spherical harmonic transforms, are located in
!! MOM_self_attr_load.
!! <code>MOM_self_attr_load</code>.
end module MOM_tidal_forcing

0 comments on commit 4f1ecf4

Please sign in to comment.