SpECTRE Documentation Coverage Report
Current view: top level - NumericalAlgorithms/DiscontinuousGalerkin/Tags - OptionsGroup.hpp Hit Total Coverage
Commit: 3528f39684ab2ee5d689cee48331779e729b0a07 Lines: 1 5 20.0 %
Date: 2024-02-27 07:22:14
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 "NumericalAlgorithms/SpatialDiscretization/OptionTags.hpp"
       7             : #include "Options/String.hpp"
       8             : 
       9             : namespace dg::OptionTags {
      10             : /*!
      11             :  * \brief Group holding options for controlling the DG discretization.
      12             :  *
      13             :  * For example, this would hold whether to use the strong or weak form, what
      14             :  * boundary correction/numerical flux to use, and which quadrature rule to use.
      15             :  *
      16             :  * \note The `DiscontinuousGalerkinGroup` is a subgroup of
      17             :  * `SpatialDiscretization::OptionTags::SpatialDiscretizationGroup`.
      18             :  */
      19           1 : struct DiscontinuousGalerkinGroup {
      20           0 :   static std::string name() { return "DiscontinuousGalerkin"; }
      21           0 :   static constexpr Options::String help{
      22             :       "Options controlling the discontinuous Galerkin spatial discretization "
      23             :       "of the PDE system.\n\n"
      24             :       "Contains options such as whether to use the strong or weak form, what "
      25             :       "boundary correction/numerical flux to use, and which quadrature rule to "
      26             :       "use."};
      27           0 :   using group = SpatialDiscretization::OptionTags::SpatialDiscretizationGroup;
      28             : };
      29             : }  // namespace dg::OptionTags

Generated by: LCOV version 1.14