SubcellSolver.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 
10 /*!
11  * \brief Group holding options for controlling the subcell solver
12  * discretization.
13  *
14  * For example, this would hold the reconstruction scheme or order of the finite
15  * difference derivatives.
16  *
17  * \note The `SubcellSolverGroup` is a subgroup of
18  * `SpatialDiscretization::OptionTags::SpatialDiscretizationGroup`.
19  */
21  static std::string name() noexcept { return "SubcellSolver"; }
22  static constexpr Options::String help{
23  "Options controlling the subcell solver spatial discretization "
24  "of the PDE system.\n\n"
25  "Contains options such as what reconstruction scheme to use or what "
26  "order of finite difference derivatives to apply."};
28 };
29 } // namespace evolution::dg::subcell::OptionTags
evolution::dg::subcell::OptionTags::SubcellSolverGroup
Group holding options for controlling the subcell solver discretization.
Definition: SubcellSolver.hpp:20
std::string
Options.hpp
evolution::dg::subcell::OptionTags
Option tags for the DG-subcell solver.
Definition: SubcellOptions.hpp:13
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