Skip to content

Commit

Permalink
Refactor comments in Table class to improve readability and clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
fbriol committed Oct 23, 2024
1 parent 653d3b3 commit 233e427
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions include/fes/wave/table.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -214,43 +214,44 @@ class Table {
/// The harmonic analysis method consists in expressing the ocean tidal
/// variations as a sum of independent constituents accordingly to the tidal
/// potential spectrum. Then the sea surface elevation at a point
/// \f$(x, y)\f$ and time \f(t\f) can be expressed as a linear sum as follow:
/// \f$(x, y)\f$ and time \fs(t\fs) can be expressed as a linear sum as
/// follow:
///
/// \f[
/// S_{ap} = S_{0}(x, y) + \sum_{k=0}^n f_{k}(t)S_{k}(x, y)
/// \times cos [\omega_{k}t + {v}_{k}(t) + u_{k}(t) - G_{k}(x,y)]
/// \f]
///
/// where:
/// * \f(n\f) is the number of constituents,
/// * \f$(n\f$) is the number of constituents,
/// * \f$S_{0}(x, y)\f$ is the mean sea level,
/// * \f$S_{k}(x, y)\f$ is the amplitude of the constituent of index
/// \f(k\f),
/// \f$(k\f$),
/// * \f$G_{k}(x, y)\f$ is the phase lag relative to Greenwich time,
/// * \f$w_{k}\f$ is the angular frequency of the constituent of index
/// \f(k\f),
/// * \f$v_{k}\f$ is the astronomical argument at time \f(t\f),
/// \f$(k\f$),
/// * \f$v_{k}\f$ is the astronomical argument at time \f$(t\f$),
/// * \f$f_{k}(t)\f$ is the nodal correction coefficient applied to
/// the amplitude of the constituent of index \f(k\f),
/// the amplitude of the constituent of index \f$(k\f$),
/// * \f$u_{k}(t)\f$ is the nodal correction coefficient applied to
/// the phase of the constituent of index \f(k\f).
/// the phase of the constituent of index \f$(k\f$).
///
/// The a priori analysis spectrum includes the most important astronomical
/// constituents in the Darwin development, completed by Shureman in 1958,
/// and many non-linear waves. The definition of tidal constants and
/// astronomical arguments is taken from FES2014 tidal prediction software
/// and a complete definition of waves is also available in Shureman (1958).
/// This spectrum is the most commonly used for harmonic analysis due the
/// simplification given by the nodal correction concept (\f(f\f) and
/// \f(u\f) coefficients above) which allows dealing with slow motions of
/// simplification given by the nodal correction concept (\f$(f\f$) and
/// \f$(u\f$) coefficients above) which allows dealing with slow motions of
/// the lunar ascending node and reducing the number of constituents in the
/// tidal spectrum. More details about this harmonic analysis method can be
/// found in Ponchaut et al. 1999.
///
/// @param[in] h Sea level
/// @param[in] f Nodal correction coefficient applied to the
/// amplitude of the constituents analyzed.
/// @param[in] vu Astronomical argument at time \f(t\f) + the
/// @param[in] vu Astronomical argument at time \f$(t\f$) + the
/// nodal correction coefficient applied to the phase of the
/// constituents analyzed.
static auto harmonic_analysis(const Eigen::Ref<const Eigen::VectorXd>& h,
Expand Down

0 comments on commit 233e427

Please sign in to comment.