Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Inciter/Options/Limiter.hpp
       4                 :            :   \copyright 2012-2015 J. Bakosi,
       5                 :            :              2016-2018 Los Alamos National Security, LLC.,
       6                 :            :              2019-2021 Triad National Security, LLC.
       7                 :            :              All rights reserved. See the LICENSE file for details.
       8                 :            :   \brief     Limiter options for DG
       9                 :            :   \details   Limiter options for DG
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef LimiterOptions_h
      13                 :            : #define LimiterOptions_h
      14                 :            : 
      15                 :            : #include <brigand/sequences/list.hpp>
      16                 :            : 
      17                 :            : #include "Toggle.hpp"
      18                 :            : #include "Keywords.hpp"
      19                 :            : #include "PUPUtil.hpp"
      20                 :            : 
      21                 :            : namespace inciter {
      22                 :            : namespace ctr {
      23                 :            : 
      24                 :            : //! Limiter types
      25                 :            : enum class LimiterType : uint8_t { NOLIMITER
      26                 :            :                                  , WENOP1
      27                 :            :                                  , SUPERBEEP1
      28                 :            :                                  , VERTEXBASEDP1 };
      29                 :            : 
      30                 :            : //! Pack/Unpack LimiterType: forward overload to generic enum class packer
      31                 :            : inline void operator|( PUP::er& p, LimiterType& e ) { PUP::pup( p, e ); }
      32                 :            : 
      33                 :            : //! \brief Limiter options: outsource to base templated on enum type
      34                 :        124 : class Limiter : public tk::Toggle< LimiterType > {
      35                 :            : 
      36                 :            :   public:
      37                 :            :     //! Valid expected choices to make them also available at compile-time
      38                 :            :     using keywords = brigand::list< kw::nolimiter
      39                 :            :                                   , kw::wenop1
      40                 :            :                                   , kw::superbeep1
      41                 :            :                                   , kw::vertexbasedp1
      42                 :            :                                   >;
      43                 :            : 
      44                 :            :     //! \brief Options constructor
      45                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      46                 :            :     //!    will handle client interactions
      47                 :        124 :     explicit Limiter() :
      48                 :            :       tk::Toggle< LimiterType >(
      49                 :            :         //! Group, i.e., options, name
      50                 :        124 :         kw::limiter::name(),
      51                 :            :         //! Enums -> names (if defined, policy codes, if not, name)
      52                 :        124 :         { { LimiterType::NOLIMITER, kw::nolimiter::name() },
      53 [ -  + ][ -  - ]:        124 :           { LimiterType::WENOP1, kw::wenop1::name() },
      54 [ -  + ][ -  - ]:        124 :           { LimiterType::SUPERBEEP1, kw::superbeep1::name() },
      55 [ -  + ][ -  - ]:        124 :           { LimiterType::VERTEXBASEDP1, kw::vertexbasedp1::name() } },
      56                 :            :         //! keywords -> Enums
      57                 :        124 :         { { kw::nolimiter::string(), LimiterType::NOLIMITER },
      58 [ -  + ][ -  - ]:        124 :           { kw::wenop1::string(), LimiterType::WENOP1 },
      59 [ -  + ][ -  - ]:        124 :           { kw::superbeep1::string(), LimiterType::SUPERBEEP1 },
      60 [ +  - ][ +  - ]:       1736 :           { kw::vertexbasedp1::string(), LimiterType::VERTEXBASEDP1 } } )
         [ +  + ][ -  + ]
         [ -  + ][ +  + ]
         [ -  + ][ -  + ]
         [ -  + ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
      61                 :        124 :     {}
      62                 :            : 
      63                 :            : };
      64                 :            : 
      65                 :            : } // ctr::
      66                 :            : } // inciter::
      67                 :            : 
      68                 :            : #endif // LimiterOptions_h