Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Walker/Options/Depvar.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     Dependent variable options for walker
       9                 :            :   \details   Dependent variable options for walker
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef DepvarOptions_h
      13                 :            : #define DepvarOptions_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                 :            : //! Dependent variable options types
      25                 :            : enum class DepvarType : uint8_t { FULLVAR=0
      26                 :            :                                 , FLUCTUATION
      27                 :            :                                 , PRODUCT
      28                 :            :                                 , FLUCTUATING_MOMENTUM };
      29                 :            : 
      30                 :            : //! Pack/Unpack DepvarType: forward overload to generic enum class packer
      31                 :         73 : inline void operator|( PUP::er& p, DepvarType& e ) { PUP::pup( p, e ); }
      32                 :            : 
      33                 :            : //! Dependent variable options: outsource to base templated on enum type
      34                 :            : class Depvar : public tk::Toggle< DepvarType > {
      35                 :            : 
      36                 :            :   public:
      37                 :            :     //! Valid expected choices to make them also available at compile-time
      38                 :            :     using keywords = brigand::list< kw::fullvar
      39                 :            :                                   , kw::fluctuation
      40                 :            :                                   , kw::product
      41                 :            :                                   , kw::fluctuating_momentum
      42                 :            :                                   >;
      43                 :            : 
      44                 :            :     //! \brief Options constructor
      45                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      46                 :            :     //!    will handle client interactions
      47                 :         31 :     explicit Depvar() :
      48                 :            :       tk::Toggle< DepvarType >(
      49                 :            :         //! Group, i.e., options, name
      50                 :            :         "solve for",
      51                 :            :         //! Enums -> names
      52         [ +  - ]:         31 :         { { DepvarType::FULLVAR, kw::fullvar::name() },
      53         [ +  - ]:         62 :           { DepvarType::FLUCTUATION, kw::fluctuation::name() },
      54         [ +  - ]:         62 :           { DepvarType::PRODUCT, kw::product::name() },
      55         [ +  - ]:         62 :           { DepvarType::FLUCTUATING_MOMENTUM, kw::fluctuating_momentum::name() }
      56                 :            :         },
      57                 :            :         //! keywords -> Enums
      58                 :          0 :         { { kw::fullvar::string(), DepvarType::FULLVAR },
      59         [ +  - ]:         62 :           { kw::fluctuation::string(), DepvarType::FLUCTUATION },
      60         [ +  - ]:         62 :           { kw::product::string(), DepvarType::PRODUCT },
      61         [ +  - ]:         62 :           { kw::fluctuating_momentum::string(),
      62                 :          0 :             DepvarType::FLUCTUATING_MOMENTUM }
      63 [ +  - ][ +  - ]:        527 :         } )
         [ +  - ][ +  - ]
         [ +  + ][ +  + ]
         [ -  - ][ -  - ]
      64                 :         31 :     {}
      65                 :            : };
      66                 :            : 
      67                 :            : } // ctr::
      68                 :            : } // walker::
      69                 :            : 
      70                 :            : #endif // DepvarOptions_h