diff --git a/include/fes/detail/angle/astronomic/frequency.hpp b/include/fes/detail/angle/astronomic/frequency.hpp index 447071f..3947402 100644 --- a/include/fes/detail/angle/astronomic/frequency.hpp +++ b/include/fes/detail/angle/astronomic/frequency.hpp @@ -36,7 +36,7 @@ constexpr auto p() noexcept -> double { return 1.0 / ((15.0 / speed::p()) * 24.0); } -/// @brief N′ +/// @brief \f$N'\f$ /// /// Compute the frequency in degree by hour for the longitude of the moon's /// ascending node. @@ -44,7 +44,7 @@ constexpr auto n() noexcept -> double { return 1.0 / ((15.0 / speed::n()) * 24.0); } -/// @brief p₁ +/// @brief \f$p_1\f$ /// /// Compute the frequency in degree by hour for the longitude of sun's /// perigee. @@ -52,7 +52,7 @@ constexpr auto p1() noexcept -> double { return 1.0 / ((15.0 / speed::p1()) * 24.0); } -/// @brief τ +/// @brief \f$\tau\f$ /// /// Compute the frequency in degree by hour for the local mean lunar time. constexpr auto tau() noexcept -> double { diff --git a/include/fes/detail/angle/astronomic/speed.hpp b/include/fes/detail/angle/astronomic/speed.hpp index 9cc0a7b..b8356e6 100644 --- a/include/fes/detail/angle/astronomic/speed.hpp +++ b/include/fes/detail/angle/astronomic/speed.hpp @@ -36,7 +36,7 @@ constexpr auto p() noexcept -> double { return (((11.0 * 360.0 + 109.032) / kJulianCentury)) * 3600.0; } -/// @brief N′ +/// @brief \f$N'\f$ /// /// Compute the speed in degree by hour for the longitude of moon's ascending /// node. @@ -44,7 +44,7 @@ constexpr auto n() noexcept -> double { return (((-5.0 * 360.0 - 134.142) / kJulianCentury)) * 3600.0; } -/// @brief p₁ +/// @brief \f$p_1\f$ /// /// Compute the speed in degree by hour for the longitude of sun's /// perigee. @@ -52,7 +52,7 @@ constexpr auto p1() noexcept -> double { return ((1.719 / kJulianCentury)) * 3600; } -/// @brief τ +/// @brief \f$\tau\f$ /// /// Compute the speed in degree by hour for the local mean lunar time. constexpr auto tau() noexcept -> double { return 15.0 - s() + h(); } diff --git a/include/fes/detail/math.hpp b/include/fes/detail/math.hpp index 8582b63..cadc215 100644 --- a/include/fes/detail/math.hpp +++ b/include/fes/detail/math.hpp @@ -26,39 +26,39 @@ namespace fes { namespace detail { namespace math { -/// π +/// \f$\pi\f$ /// /// @tparam T The type of the result. -/// @return π +/// @return \f$\pi\f$ template constexpr auto pi() noexcept -> T { return std::atan2(T(0), T(-1)); } -/// π/2 +/// \f$\pi/2\f$ /// /// @tparam T The type of the result. -/// @return π/2 +/// @return \f$\pi/2\f$ template constexpr auto pi_2() noexcept -> T { return 0.5 * pi(); } -/// 2π +/// \f$2\pi\f$ /// /// @tparam T The type of the result. -/// @return 2π +/// @return \f$2\pi\f$ template constexpr auto two_pi() noexcept -> T { return T(2) * pi(); } -/// @brief Evaluate x^n +/// @brief Evaluate \f$x^n\f$ /// @tparam T The type of the number. /// @tparam N The power to raise the number to. template struct Power { - /// @brief Evaluate x^n + /// @brief Evaluate \f$x^n\f$ /// /// @param[in] x The number to raise to the power. /// @return The result of raising the number to the power. diff --git a/include/fes/geometry/triangle.hpp b/include/fes/geometry/triangle.hpp index 63ffc98..a4dc4ea 100644 --- a/include/fes/geometry/triangle.hpp +++ b/include/fes/geometry/triangle.hpp @@ -125,11 +125,11 @@ class Triangle : public triangle_t { return boost::geometry::equals(*this, other); } - /// Compute the angles ξ and η of the reference right-angled triangle in the - /// Cartesian space. + /// Compute the angles \f$\xi\$f and \f$\eta\$f of the reference right-angled + /// triangle in the Cartesian space. /// /// @param[in] point The point. - /// @return A tuple containing the angles ξ and η. + /// @return A tuple containing the angles \f$\xi\$f and \f$\eta\$f. /// @warning The given point must be inside the triangle otherwise the result /// is undefined. auto reference_right_angled(const Point &point) const diff --git a/include/fes/wave.hpp b/include/fes/wave.hpp index 89497eb..752f026 100644 --- a/include/fes/wave.hpp +++ b/include/fes/wave.hpp @@ -183,7 +183,8 @@ class Wave : public std::enable_shared_from_this { /// Tide value. std::complex c_; - /// Harmonic constituents (T, s, h, p, N′, p_1, shift, \xi, \nu, \nu′, \nu″) + /// Harmonic constituents + /// \f$(T, s, h, p, N', p_1, shift, \xi, \nu, \nu', \nu'')\f$ std::array argument_; /// Computes the wave frequency from the doodson arguments @@ -307,7 +308,7 @@ class Sa : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - 4s + h + 2p + 90°@f$
@f$T - 4s + h + 2p + 90^{\circ}@f$@f$+2\xi - \nu@f$@f$f(O_1)@f$
@@ -323,7 +324,7 @@ class _2Q1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - 4s + 3h + 90°@f$
@f$T - 4s + 3h + 90^{\circ}@f$@f$+2\xi - \nu@f$@f$f(O_1)@f$
@@ -339,7 +340,7 @@ class Sigma1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - 3s + h + p + 90°@f$
@f$T - 3s + h + p + 90^{\circ}@f$@f$+2\xi - \nu@f$@f$f(O_1)@f$
@@ -355,7 +356,7 @@ class Q1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - 3s + 3h - p + 90°@f$
@f$T - 3s + 3h - p + 90^{\circ}@f$@f$+2\xi - \nu@f$@f$f(O_1)@f$
@@ -371,7 +372,7 @@ class Rho1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - 2s + h + 90°@f$
@f$T - 2s + h + 90^{\circ}@f$@f$+2\xi - \nu@f$@f$f(O_1)@f$
@@ -387,7 +388,7 @@ class O1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - 2s + 3h - 90°@f$
@f$T - 2s + 3h - 90^{\circ}@f$@f$-\nu@f$@f$f(J_1)@f$
@@ -403,7 +404,7 @@ class MP1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - s + h - p - 90°@f$
@f$T - s + h - p - 90^{\circ}@f$@f$+2\xi - \nu@f$@f$f(O_1)@f$
@@ -443,7 +444,7 @@ class M13 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - s + h + p - 90°@f$
@f$T - s + h + p - 90^{\circ}@f$@f$-\nu@f$@f$f(J_1)@f$
@@ -459,7 +460,7 @@ class M11 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - s + 3h - p - 90°@f$
@f$T - s + 3h - p - 90^{\circ}@f$@f$-\nu@f$@f$f(J_1)@f$
@@ -475,7 +476,7 @@ class Chi1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - 2h + p1 + 90°@f$
@f$T - 2h + p1 + 90^{\circ}@f$@f$0@f$@f$1@f$
@@ -491,7 +492,7 @@ class Pi1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T - h + 90°@f$
@f$T - h + 90^{\circ}@f$@f$0@f$@f$1@f$
@@ -523,7 +524,7 @@ class S1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T + h - 90°@f$
@f$T + h - 90^{\circ}@f$@f$- \nu@f$@f$f(K_1)@f$
@@ -539,7 +540,7 @@ class K1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T + 2h - p1 - 90°@f$
@f$T + 2h - p1 - 90^{\circ}@f$@f$0@f$@f$1@f$
@@ -555,7 +556,7 @@ class Psi1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T + 3h - 90°@f$
@f$T + 3h - 90^{\circ}@f$@f$0@f$@f$1@f$
@@ -571,7 +572,7 @@ class Phi1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T + s - h + p - 90°@f$
@f$T + s - h + p - 90^{\circ}@f$@f$-\nu@f$@f$f(J_1)@f$
@@ -587,7 +588,7 @@ class Theta1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T + s + h - p - 90°@f$
@f$T + s + h - p - 90^{\circ}@f$@f$-\nu@f$@f$f(J_1)@f$
@@ -603,7 +604,7 @@ class J1 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$T + 2s + h - 90°@f$
@f$T + 2s + h - 90^{\circ}@f$@f$-2\xi - \nu@f$@f$f(OO_1)@f$
@@ -747,7 +748,7 @@ class M2 : public Wave { /// VuFactor-f /// @f$2T - 2s + 4h@f$ /// @f$+2\xi - 2\nu -2\nu^{\prime \prime}@f$ -/// @f$f(M_2) × f(K_2)@f$ +/// @f$f(M_2) ^times f(K_2)@f$ /// class MKS2 : public Wave { public: @@ -760,7 +761,7 @@ class MKS2 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$2T - s + p + 180°@f$
@f$2T - s + p + 180^{\circ}@f$@f$+2\xi - 2\nu@f$@f$f(M_2)@f$
@@ -776,7 +777,7 @@ class Lambda2 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$2T - s + 2h - p + 180°@f$
@f$2T - s + 2h - p + 180^{\circ}@f$@f$+2\xi - 2\nu - R@f$@f$f(L_2)@f$
@@ -800,7 +801,7 @@ class L2 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$2T - s + 2h - p + 180°@f$
@f$2T - s + 2h - p + 180^{\circ}@f$@f$+2\xi - 2\nu@f$@f$f(M_2)^3@f$
@@ -847,7 +848,7 @@ class S2 : public Wave { /// /// /// -/// +/// /// /// ///
VuFactor-f
@f$2T + h - p1 + 180°@f$
@f$2T + h - p1 + 180^{\circ}@f$@f$0@f$@f$1@f$
@@ -925,9 +926,9 @@ class _2SM2 : public Wave { /// /// /// -/// +/// /// -/// +/// ///
VuFactor-f
@f$3T - 4s + 3h + 90°@f$
@f$3T - 4s + 3h + 90^{\circ}@f$@f$4\xi - 3\nu@f$@f$f(M_2) × f(O_1)@f$
@f$f(M_2) ^times f(O_1)@f$
class MO3 : public Wave { public: @@ -940,9 +941,9 @@ class MO3 : public Wave { /// /// /// -/// +/// /// -/// +/// ///
VuFactor-f
@f$3T - 4s + 3h + 90°@f$
@f$3T - 4s + 3h + 90^{\circ}@f$@f$4\xi - 4\nu + \nu^{\prime}@f$@f$f(M_2)² × f(K_1)@f$
@f$f(M_2)^2 ^times f(K_1)@f$
class _2MK3 : public Wave { public: @@ -971,9 +972,9 @@ class M3 : public Wave { /// /// /// -/// +/// /// -/// +/// ///
VuFactor-f
@f$3T - 2s + 3h - 90°@f$
@f$3T - 2s + 3h - 90^{\circ}@f$@f$2\xi - 2\nu - \nu^{\prime}@f$@f$f(M_2) × f(K_1)@f$
@f$f(M_2) ^times f(K_1)@f$
class MK3 : public Wave { public: @@ -1183,7 +1184,7 @@ class _2MS6 : public Wave { /// VuFactor-f /// @f$6T - 4s + 6h@f$ /// @f$4\xi - 4\nu - 2\nu^{\prime \prime}@f$ -/// @f$f(M_2)² × f(K_2)@f$ +/// @f$f(M_2)^2 ^times f(K_2)@f$ /// class _2MK6 : public Wave { public: @@ -1213,7 +1214,7 @@ class _2SM6 : public Wave { /// VuFactor-f /// @f$6T - 2s + 4h@f$ /// @f$2\xi - 2\nu - 2\nu^{\prime}@f$ -/// @f$f(M_2) × f(K_2)@f$ +/// @f$f(M_2) ^times f(K_2)@f$ /// class MSK6 : public Wave { public: