Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Inciter/Options/Flux.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     Flux function options for inciter
       9                 :            :   \details   Flux function options for inciter
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef FluxOptions_h
      13                 :            : #define FluxOptions_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                 :            : //! Flux types
      25                 :            : enum class FluxType : uint8_t { LaxFriedrichs
      26                 :            :                               , HLLC
      27                 :            :                               , UPWIND
      28                 :            :                               , AUSM
      29                 :            :                               , HLL
      30                 :            :                               , Rusanov
      31                 :            :                               };
      32                 :            : 
      33                 :            : //! Pack/Unpack FluxType: forward overload to generic enum class packer
      34                 :            : inline void operator|( PUP::er& p, FluxType& e ) { PUP::pup( p, e ); }
      35                 :            : 
      36                 :            : //! \brief Flux options: outsource to base templated on enum type
      37                 :         49 : class Flux : public tk::Toggle< FluxType > {
      38                 :            : 
      39                 :            :   public:
      40                 :            :     //! Valid expected choices to make them also available at compile-time
      41                 :            :     using keywords = brigand::list< kw::laxfriedrichs
      42                 :            :                                   , kw::hllc
      43                 :            :                                   , kw::upwind
      44                 :            :                                   , kw::ausm
      45                 :            :                                   , kw::hll
      46                 :            :                                   >;
      47                 :            : 
      48                 :            :     //! \brief Options constructor
      49                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      50                 :            :     //!    will handle client interactions
      51                 :         49 :     explicit Flux() :
      52                 :            :       tk::Toggle< FluxType >(
      53                 :            :         //! Group, i.e., options, name
      54                 :         49 :         kw::flux::name(),
      55                 :            :         //! Enums -> names (if defined, policy codes, if not, name)
      56                 :         49 :         { { FluxType::LaxFriedrichs, kw::laxfriedrichs::name() }
      57 [ -  + ][ -  - ]:         49 :         , { FluxType::HLLC, kw::hllc::name() }
      58 [ -  + ][ -  - ]:         49 :         , { FluxType::UPWIND, kw::upwind::name() }
      59 [ -  + ][ -  - ]:         49 :         , { FluxType::AUSM, kw::ausm::name() }
      60 [ -  + ][ -  - ]:         49 :         , { FluxType::HLL, kw::hll::name() }
      61                 :            :         },
      62                 :            :         //! keywords -> Enums
      63                 :         49 :         { { kw::laxfriedrichs::string(), FluxType::LaxFriedrichs }
      64 [ -  + ][ -  - ]:         49 :         , { kw::hllc::string(), FluxType::HLLC }
      65 [ -  + ][ -  - ]:         49 :         , { kw::upwind::string(), FluxType::UPWIND }
      66 [ -  + ][ -  - ]:         49 :         , { kw::ausm::string(), FluxType::AUSM }
      67 [ -  + ][ -  - ]:         49 :         , { kw::hll::string(), FluxType::HLL }
      68 [ +  - ][ +  - ]:        784 :         } )
         [ +  + ][ -  + ]
         [ -  + ][ +  + ]
         [ -  + ][ -  + ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
      69                 :         49 :     {}
      70                 :            : 
      71                 :            : };
      72                 :            : 
      73                 :            : } // ctr::
      74                 :            : } // inciter::
      75                 :            : 
      76                 :            : #endif // FluxOptions_h