Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Inciter/Options/MeshVelocitySmoother.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     Mesh velocity smoother configuration options for inciter
       9                 :            :   \details   Mesh velocity smoother configuration options for inciter.
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef MeshVelocitySmootherOptions_h
      13                 :            : #define MeshVelocitySmootherOptions_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                 :            : //! Mesh velocity smoother configuration option types
      25                 :            : enum class MeshVelocitySmootherType : uint8_t { NONE
      26                 :            :                                               , LAPLACE
      27                 :            :                                               , HELMHOLTZ
      28                 :            :                                               };
      29                 :            : 
      30                 :            : //! \brief Pack/Unpack MeshVelocitySmootherType: forward overload to generic
      31                 :            : //!    enum class packer
      32                 :       1798 : inline void operator|( PUP::er& p, MeshVelocitySmootherType& e )
      33                 :       1798 : { PUP::pup( p, e ); }
      34                 :            : 
      35                 :            : //! \brief Mesh velocity options: outsource to base templated on enum type
      36                 :            : class MeshVelocitySmoother : public tk::Toggle< MeshVelocitySmootherType > {
      37                 :            : 
      38                 :            :   public:
      39                 :            :     //! Valid expected choices to make them also available at compile-time
      40                 :            :     using keywords = brigand::list< kw::none
      41                 :            :                                   , kw::laplace
      42                 :            :                                   , kw::helmholtz
      43                 :            :                                   >;
      44                 :            : 
      45                 :            :     //! \brief Options constructor
      46                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      47                 :            :     //!    will handle client interactions
      48                 :         16 :     explicit MeshVelocitySmoother() :
      49                 :            :       tk::Toggle< MeshVelocitySmootherType >(
      50                 :            :         //! Group, i.e., options, name
      51         [ +  - ]:         32 :         kw::smoother::name(),
      52                 :            :         //! Enums -> names (if defined, policy codes, if not, name)
      53         [ +  - ]:         16 :         { { MeshVelocitySmootherType::NONE, kw::none::name() }
      54         [ +  - ]:         32 :         , { MeshVelocitySmootherType::LAPLACE, kw::laplace::name() }
      55         [ +  - ]:         32 :         , { MeshVelocitySmootherType::HELMHOLTZ, kw::helmholtz::name() }
      56                 :            :         },
      57                 :            :         //! keywords -> Enums
      58                 :          0 :         { { kw::none::string(), MeshVelocitySmootherType::NONE }
      59         [ +  - ]:         32 :         , { kw::laplace::string(), MeshVelocitySmootherType::LAPLACE }
      60         [ +  - ]:         32 :         , { kw::helmholtz::string(), MeshVelocitySmootherType::HELMHOLTZ }
      61 [ +  - ][ +  - ]:        240 :         } )
         [ +  - ][ +  + ]
         [ +  + ][ -  - ]
                 [ -  - ]
      62                 :         16 :     {}
      63                 :            : 
      64                 :            : };
      65                 :            : 
      66                 :            : } // ctr::
      67                 :            : } // inciter::
      68                 :            : 
      69                 :            : #endif // MeshVelocitySmootherOptions_h