OptionTags.hpp
1 // // Distributed under the MIT License.
2 // See LICENSE.txt for details.
3 
4 #pragma once
5 
6 #include <string>
7 
8 #include "Options/Options.hpp"
9 
10 namespace SpatialDiscretization::OptionTags {
11 /*!
12  * \brief Group holding all the options for the spatial discretization of the
13  * PDE system.
14  *
15  * For example, when using a discontinuous Galerkin scheme, options like the
16  * basis function choice are specified within the SpatialDiscretizationGroup.
17  * The boundary correction/numerical flux to use is another example of what
18  * would be specified in the SpatialDiscretizationGroup. In the future,
19  * specifying the domain decomposition should also be done in the spatial
20  * discretization group.
21  */
23  static std::string name() noexcept { return "SpatialDiscretization"; }
24  static constexpr Options::String help{
25  "Options controlling the spatial discretization of the PDE system.\n\n"
26  "In a DG-subcell hybrid scheme subgroups would hold options for the DG "
27  "and FD/FV method used. For example, the choice of basis functions for "
28  "the DG scheme would be specified."};
29 };
30 } // namespace SpatialDiscretization::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
string