Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Walker/Options/VelocityVariant.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     Velocity model variants
       9                 :            :   \details   Velocity model variants for walker.
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef VelocityVariantOptions_h
      13                 :            : #define VelocityVariantOptions_h
      14                 :            : 
      15                 :            : #include <brigand/sequences/list.hpp>
      16                 :            : 
      17                 :            : #include "Toggle.hpp"
      18                 :            : #include "Keywords.hpp"
      19                 :            : #include "PUPUtil.hpp"
      20                 :            : 
      21                 :            : namespace walker {
      22                 :            : namespace ctr {
      23                 :            : 
      24                 :            : //! Velocity model variant types
      25                 :            : enum class VelocityVariantType : uint8_t { SLM=0
      26                 :            :                                          , GLM };
      27                 :            : 
      28                 :            : //! \brief Pack/Unpack VelocityVariantType: forward overload to generic enum
      29                 :            : //!    class packer
      30                 :         29 : inline void operator|( PUP::er& p, VelocityVariantType& e )
      31                 :         29 : { PUP::pup( p, e ); }
      32                 :            : 
      33                 :            : //! Velocity model variants: outsource to base templated on enum type
      34                 :            : class VelocityVariant : public tk::Toggle< VelocityVariantType > {
      35                 :            : 
      36                 :            :   public:
      37                 :            :     //! Valid expected choices to make them also available at compile-time
      38                 :            :     using keywords = brigand::list< kw::slm
      39                 :            :                                   , kw::glm
      40                 :            :                                   >;
      41                 :            : 
      42                 :            :     //! \brief Options constructor
      43                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      44                 :            :     //!    will handle client interactions
      45                 :         10 :     explicit VelocityVariant() :
      46                 :            :       tk::Toggle< VelocityVariantType >(
      47                 :            :         //! Group, i.e., options, name
      48                 :            :         "model variant",
      49                 :            :         //! Enums -> names
      50         [ +  - ]:         10 :         { { VelocityVariantType::SLM, kw::slm::name() },
      51         [ +  - ]:         20 :           { VelocityVariantType::GLM, kw::glm::name() } },
      52                 :            :         //! keywords -> Enums
      53                 :          0 :         { { kw::slm::string(), VelocityVariantType::SLM },
      54 [ +  - ][ +  - ]:         80 :           { kw::glm::string(), VelocityVariantType::GLM } } )
         [ +  - ][ +  - ]
         [ +  - ][ +  + ]
         [ +  + ][ -  - ]
                 [ -  - ]
      55                 :         10 :     {}
      56                 :            : };
      57                 :            : 
      58                 :            : } // ctr::
      59                 :            : } // walker::
      60                 :            : 
      61                 :            : #endif // VelocityVariantOptions_h