Skip to content

Commit

Permalink
still cleaning the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kshedstrom committed Jul 25, 2024
1 parent 687422e commit ccfb798
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 15 deletions.
5 changes: 1 addition & 4 deletions docs/parameterizations_lateral.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,6 @@ While the self attraction and loading is computed in MOM_self_attr_load:

:ref:`namespaceself__attr__load_1section_SAL`

Spherical Harmonics
-------------------

The model needs spherical, computed in MOM_spherical_harmonics:
The self attraction and loading needs spherical harmonics, computed in MOM_spherical_harmonics:

:ref:`namespacemom__spherical__harmonics_1section_spherical_harmonics`
15 changes: 8 additions & 7 deletions src/parameterizations/lateral/MOM_self_attr_load.F90
Original file line number Diff line number Diff line change
Expand Up @@ -251,14 +251,15 @@ end subroutine SAL_end
!! (rather, it should be bottom pressure anomaly). SAL is primarily used for fast evolving processes like tides or
!! storm surges, but the effect applies to all motions.
!!
!! If SAL_SCALAR_APPROX is true, a scalar approximation is applied [\cite Accad1978] and the SAL is simply
!! a fraction (set by SAL_SCALAR_VALUE, usually around 10% for global tides) of local SSH . For tides, the scalar
!! approximation can also be used to iterate the SAL to convergence [see USE_PREVIOUS_TIDES in MOM_tidal_forcing,
!! \cite Arbic2004].
!! If <code>SAL_SCALAR_APPROX</code> is true, a scalar approximation is applied (\cite Accad1978) and the SAL is simply
!! a fraction (set by <code>SAL_SCALAR_VALUE</code>, usually around 10% for global tides) of local SSH.
!! For tides, the scalar approximation can also be used to iterate the SAL to convergence [see
!! <code>USE_PREVIOUS_TIDES</code> in MOM_tidal_forcing, \cite Arbic2004].
!!
!! If SAL_HARMONICS is true, a more accurate online spherical harmonic transforms are used to calculate SAL.
!! Subroutines in module MOM_spherical_harmonics are called and the degree of spherical harmonic transforms is set by
!! SAL_HARMONICS_DEGREE. The algorithm is based on SAL calculation in Model for Prediction Across Scales (MPAS)-Ocean
!! If <code>SAL_HARMONICS</code> is true, a more accurate online spherical harmonic transforms are used to calculate
!! SAL. Subroutines in module MOM_spherical_harmonics are called and the degree of spherical harmonic transforms is
!! set by <code>SAL_HARMONICS_DEGREE</code>. The algorithm is based on SAL calculation in Model for Prediction Across
!! Scales (MPAS)-Ocean
!! developed by Los Alamos National Laboratory and University of Michigan [\cite Barton2022 and \cite Brus2023].
!!
!! References:
Expand Down
8 changes: 4 additions & 4 deletions src/parameterizations/lateral/MOM_spherical_harmonics.F90
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ end function order2index
!! \f[
!! f^m_n = \sum^{Nj}_{0}\sum^{Ni}_{0}f(i,j)Y^m_n(i,j)A(i,j)/r_e^2
!! \f]
!! where $A$ is the area of the cell and $r_e$ is the radius of the Earth.
!! where \f$A\f$ is the area of the cell and \f$r_e\f$ is the radius of the Earth.
!!
!! In inverse transform, the first N degree spherical harmonic coefficients are used to reconstruct a two-dimensional
!! physical field:
Expand All @@ -374,10 +374,10 @@ end function order2index
!! array vectorization.
!!
!! The maximum degree of the spherical harmonics is a runtime parameter and the maximum used by all SHT applications.
!! At the moment, it is only decided by SAL_HARMONICS_DEGREE.
!! At the moment, it is only decided by <code>SAL_HARMONICS_DEGREE</code>.
!!
!! The forward transforms involve a global summation. Runtime flag SHT_REPRODUCING_SUM controls whether this is done
!! in a bit-wise reproducing way or not.
!! The forward transforms involve a global summation. Runtime flag <code>SHT_REPRODUCING_SUM</code> controls
!! whether this is done in a bit-wise reproducing way or not.
!!
!! References:
!!
Expand Down

0 comments on commit ccfb798

Please sign in to comment.