SpECTRE Documentation Coverage Report
Current view: top level - NumericalAlgorithms/Spectral - MinimumNumberOfPoints.hpp Hit Total Coverage
Commit: 1e29a35ad8559408f21493dc5db8a49a237bb2f0 Lines: 1 2 50.0 %
Date: 2026-03-31 22:27:51
Legend: Lines: hit not hit

          Line data    Source code
       1           0 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : #pragma once
       5             : 
       6             : #include <cstddef>
       7             : #include <limits>
       8             : 
       9             : #include "NumericalAlgorithms/Spectral/Basis.hpp"
      10             : #include "NumericalAlgorithms/Spectral/Quadrature.hpp"
      11             : 
      12             : namespace Spectral {
      13             : namespace detail {
      14             : constexpr size_t minimum_number_of_points(const Basis /*basis*/,
      15             :                                           const Quadrature quadrature) {
      16             :   // NOLINTNEXTLINE(bugprone-branch-clone)
      17             :   if (quadrature == Quadrature::Gauss) {
      18             :     return 1;
      19             :     // NOLINTNEXTLINE(bugprone-branch-clone)
      20             :   } else if (quadrature == Quadrature::GaussLobatto) {
      21             :     return 2;
      22             :     // NOLINTNEXTLINE(bugprone-branch-clone)
      23             :   } else if (quadrature == Quadrature::GaussRadauUpper) {
      24             :     return 1;
      25             :     // NOLINTNEXTLINE(bugprone-branch-clone)
      26             :   } else if (quadrature == Quadrature::CellCentered) {
      27             :     return 1;
      28             :     // NOLINTNEXTLINE(bugprone-branch-clone)
      29             :   } else if (quadrature == Quadrature::FaceCentered) {
      30             :     return 2;
      31             :     // NOLINTNEXTLINE(bugprone-branch-clone)
      32             :   } else if (quadrature == Quadrature::Equiangular) {
      33             :     return 1;
      34             :     // NOLINTNEXTLINE(bugprone-branch-clone)
      35             :   } else if (quadrature == Quadrature::AxialSymmetry) {
      36             :     return 1;
      37             :   } else if (quadrature == Quadrature::SphericalSymmetry) {
      38             :     return 1;
      39             :   }
      40             :   return std::numeric_limits<size_t>::max();
      41             : }
      42             : }  // namespace detail
      43             : 
      44             : /*!
      45             :  * \brief Minimum number of possible collocation points for a quadrature type.
      46             :  *
      47             :  * \details Since Gauss-Lobatto quadrature has points on the domain boundaries
      48             :  * it must have at least two collocation points. Gauss quadrature can have only
      49             :  * one collocation point.
      50             :  *
      51             :  * \details For `CellCentered` the minimum number of points is 1, while for
      52             :  * `FaceCentered` it is 2.
      53             :  */
      54             : template <Basis basis, Quadrature quadrature>
      55           1 : constexpr size_t minimum_number_of_points =
      56             :     detail::minimum_number_of_points(basis, quadrature);
      57             : }  // namespace Spectral

Generated by: LCOV version 1.14