Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Inciter/Options/Physics.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     Physics options for inciter
       9                 :            :   \details   Physics options for inciter
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef PhysicsOptions_h
      13                 :            : #define PhysicsOptions_h
      14                 :            : 
      15                 :            : #include <brigand/sequences/list.hpp>
      16                 :            : #include <brigand/algorithms/for_each.hpp>
      17                 :            : 
      18                 :            : #include "Toggle.hpp"
      19                 :            : #include "Keywords.hpp"
      20                 :            : #include "PUPUtil.hpp"
      21                 :            : 
      22                 :            : namespace inciter {
      23                 :            : namespace ctr {
      24                 :            : 
      25                 :            : //! Physics types
      26                 :            : enum class PhysicsType : uint8_t { ADVECTION,
      27                 :            :                                    ADVDIFF,
      28                 :            :                                    EULER,
      29                 :            :                                    NAVIERSTOKES,
      30                 :            :                                    VELEQ };
      31                 :            : 
      32                 :            : //! Pack/Unpack PhysicsType: forward overload to generic enum class packer
      33                 :        899 : inline void operator|( PUP::er& p, PhysicsType& e ) { PUP::pup( p, e ); }
      34                 :            : 
      35                 :            : //! \brief Physics options: outsource to base templated on enum type
      36                 :            : class Physics : public tk::Toggle< PhysicsType > {
      37                 :            : 
      38                 :            :   public:
      39                 :            :     //! Valid expected choices to make them also available at compile-time
      40                 :            :     using keywords = brigand::list< kw::advection
      41                 :            :                                   , kw::advdiff
      42                 :            :                                   , kw::euler
      43                 :            :                                   , kw::navierstokes
      44                 :            :                                   , kw::veleq
      45                 :            :                                   >;
      46                 :            : 
      47                 :            :     //! \brief Options constructor
      48                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      49                 :            :     //!    will handle client interactions
      50                 :        340 :     explicit Physics() :
      51                 :            :       tk::Toggle< PhysicsType >(
      52                 :            :         //! Group, i.e., options, name
      53         [ +  - ]:        680 :         kw::physics::name(),
      54                 :            :         //! Enums -> names (if defined, policy codes, if not, name)
      55         [ +  - ]:        340 :         { { PhysicsType::ADVECTION, kw::advection::name() },
      56         [ +  - ]:        680 :           { PhysicsType::ADVDIFF, kw::advdiff::name() },
      57         [ +  - ]:        680 :           { PhysicsType::EULER, kw::euler::name() },
      58         [ +  - ]:        680 :           { PhysicsType::NAVIERSTOKES, kw::navierstokes::name() },
      59         [ +  - ]:        680 :           { PhysicsType::VELEQ, kw::veleq::name() }
      60                 :            :         },
      61                 :            :         //! keywords -> Enums
      62                 :          0 :         { { kw::advection::string(), PhysicsType::ADVECTION },
      63         [ +  - ]:        680 :           { kw::advdiff::string(), PhysicsType::ADVDIFF },
      64         [ +  - ]:        680 :           { kw::euler::string(), PhysicsType::EULER },
      65         [ +  - ]:        680 :           { kw::navierstokes::string(), PhysicsType::NAVIERSTOKES },
      66 [ +  - ][ +  - ]:       7480 :           { kw::veleq::string(), PhysicsType::VELEQ } } )
         [ +  - ][ +  - ]
         [ +  + ][ +  + ]
         [ -  - ][ -  - ]
      67                 :        340 :     {}
      68                 :            : };
      69                 :            : 
      70                 :            : } // ctr::
      71                 :            : } // inciter::
      72                 :            : 
      73                 :            : #endif // PhysicsOptions_h