SpECTRE Documentation Coverage Report
Current view: top level - Evolution - Tags.hpp Hit Total Coverage
Commit: d0fc80462417e83e5cddfa1b9901bb4a9b6af4d6 Lines: 2 7 28.6 %
Date: 2024-03-29 00:33:31
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 <string>
       7             : 
       8             : #include "Options/String.hpp"
       9             : 
      10             : namespace evolution {
      11             : namespace OptionTags {
      12             : 
      13             : /*!
      14             :  * \ingroup OptionGroupsGroup
      15             :  * \brief Groups option tags related to the time evolution, e.g. time step and
      16             :  * time stepper.
      17             :  */
      18           1 : struct Group {
      19           0 :   static std::string name() { return "Evolution"; }
      20           0 :   static constexpr Options::String help{"Options for the time evolution"};
      21             : };
      22             : 
      23             : /*!
      24             :  * \ingroup OptionGroupsGroup
      25             :  * \brief Groups option tags related to the evolution system.
      26             :  *
      27             :  * The option tags for the evolution system should be placed in a subgroup that
      28             :  * carries the system name. See e.g. `OptionTags::ValenciaDivCleanGroup`.
      29             :  */
      30           1 : struct SystemGroup {
      31           0 :   static std::string name() { return "EvolutionSystem"; }
      32           0 :   static constexpr Options::String help{"The system of hyperbolic PDEs"};
      33             : };
      34             : 
      35             : }  // namespace OptionTags
      36             : }  // namespace evolution

Generated by: LCOV version 1.14