OptionsGroup.hpp
1 // 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/Options.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  */
20  static std::string name() noexcept { return "DiscontinuousGalerkin"; }
21  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 flud to use, and which quadrature rule to "
26  "use."};
28 };
29 } // namespace dg::OptionTags
std::string
Options.hpp
SpatialDiscretization::OptionTags::SpatialDiscretizationGroup
Group holding all the options for the spatial discretization of the PDE system.
Definition: OptionTags.hpp:22
Options::String
const char *const String
The string used in option structs.
Definition: Options.hpp:32
dg::OptionTags::DiscontinuousGalerkinGroup
Group holding options for controlling the DG discretization.
Definition: OptionsGroup.hpp:19