Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Options/PartitioningAlgorithm.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 partitioning algorithm options
       9                 :            :   \details   Mesh partitioning algorithm options
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef InciterPartitioningAlgorithmOptions_h
      13                 :            : #define InciterPartitioningAlgorithmOptions_h
      14                 :            : 
      15                 :            : #include <map>
      16                 :            : 
      17                 :            : #include <brigand/sequences/list.hpp>
      18                 :            : 
      19                 :            : #include "Toggle.hpp"
      20                 :            : #include "Keywords.hpp"
      21                 :            : #include "PUPUtil.hpp"
      22                 :            : 
      23                 :            : namespace tk {
      24                 :            : namespace ctr {
      25                 :            : 
      26                 :            : //! Mesh partitioning algorithm types
      27                 :            : enum class PartitioningAlgorithmType : uint8_t { RCB,
      28                 :            :                                                  RIB,
      29                 :            :                                                  HSFC,
      30                 :            :                                                  MJ,
      31                 :            :                                                  PHG };
      32                 :            : 
      33                 :            : //! \brief Pack/Unpack PartitioningAlgorithmType: forward overload to generic
      34                 :            : //!   enum class packer
      35                 :            : inline void operator|( PUP::er& p, PartitioningAlgorithmType& e )
      36                 :            : { PUP::pup( p, e ); }
      37                 :            : 
      38                 :            : //! \brief PartitioningAlgorithm options: outsource searches to base templated
      39                 :            : //!   on enum type
      40                 :       1012 : class PartitioningAlgorithm : public tk::Toggle< PartitioningAlgorithmType > {
      41                 :            : 
      42                 :            :   public:
      43                 :            :     using ParamType = std::string;
      44                 :            : 
      45                 :            :     //! Valid expected choices to make them also available at compile-time
      46                 :            :     using keywords = brigand::list< kw::rcb
      47                 :            :                                   , kw::rib
      48                 :            :                                   , kw::hsfc
      49                 :            :                                   , kw::mj
      50                 :            :                                   , kw::phg
      51                 :            :                                   >;
      52                 :            : 
      53                 :            :     //! \brief Options constructor
      54                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      55                 :            :     //!    will handle client interactions
      56                 :       1012 :     explicit PartitioningAlgorithm() :
      57                 :            :       tk::Toggle< PartitioningAlgorithmType >(
      58                 :            :         //! Group, i.e., options, name
      59                 :            :         "Mesh partitioning algorithm",
      60                 :            :         //! Enums -> names
      61                 :       1012 :         { { PartitioningAlgorithmType::RCB, kw::rcb::name() },
      62 [ -  + ][ -  - ]:       1012 :           { PartitioningAlgorithmType::RIB, kw::rib::name() },
      63 [ -  + ][ -  - ]:       1012 :           { PartitioningAlgorithmType::HSFC, kw::hsfc::name() },
      64 [ -  + ][ -  - ]:       1012 :           { PartitioningAlgorithmType::MJ, kw::mj::name() },
      65 [ -  + ][ -  - ]:       1012 :           { PartitioningAlgorithmType::PHG, kw::phg::name() } },
      66                 :            :         //! keywords -> Enums
      67                 :       1012 :         { { kw::rcb::string(), PartitioningAlgorithmType::RCB },
      68 [ -  + ][ -  - ]:       1012 :           { kw::rib::string(), PartitioningAlgorithmType::RIB },
      69 [ -  + ][ -  - ]:       1012 :           { kw::hsfc::string(), PartitioningAlgorithmType::HSFC },
      70 [ -  + ][ -  - ]:       1012 :           { kw::mj::string(), PartitioningAlgorithmType::MJ },
      71 [ +  - ][ +  - ]:      22264 :           { kw::phg::string(), PartitioningAlgorithmType::PHG } } ) {}
         [ +  - ][ +  + ]
         [ +  + ][ -  + ]
         [ +  + ][ -  + ]
         [ -  + ][ -  + ]
         [ +  - ][ -  + ]
         [ +  + ][ -  + ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
                 [ -  - ]
      72                 :            : 
      73                 :            :     //! \brief Return parameter based on Enum
      74                 :            :     //! \details Here 'parameter' is the library-specific identifier of the
      75                 :            :     //!    option, i.e., as the library identifies the given option
      76                 :            :     //! \param[in] m Enum value of the option requested
      77                 :            :     //! \return Library-specific parameter of the option
      78                 :            :     const ParamType& param( PartitioningAlgorithmType m ) const {
      79                 :            :       using tk::operator<<;
      80                 :            :       auto it = method.find( m );
      81                 :            :       Assert( it != end(method),
      82                 :            :               std::string("Cannot find parameter for PartitioningAlgorithm \"")
      83                 :            :               << m << "\"" );
      84         [ +  - ]:        666 :       return it->second;
      85                 :            :     }
      86                 :            : 
      87                 :            :     // Return true if partitioning algorithm is geometric
      88                 :            :     //! \param[in] m Enum value of the option requested
      89                 :            :     //! \return True if partitioning algorithm is geometric, false if it is not
      90                 :            :     bool geometric( PartitioningAlgorithmType m ) const {
      91                 :            :       if ( m == PartitioningAlgorithmType::RCB ||
      92                 :            :            m == PartitioningAlgorithmType::RIB ||
      93                 :            :            m == PartitioningAlgorithmType::HSFC ||
      94                 :            :            m == PartitioningAlgorithmType::MJ )
      95                 :            :         return true;
      96                 :            :       else
      97                 :            :        return false;
      98                 :            :     }
      99                 :            : 
     100                 :            :   private:
     101                 :            :     //! Enums -> Zoltan partitioning algorithm parameters
     102                 :            :     std::map< PartitioningAlgorithmType, ParamType > method {
     103                 :            :       { PartitioningAlgorithmType::RCB, "rcb" },
     104                 :            :       { PartitioningAlgorithmType::RIB, "rib" },
     105                 :            :       { PartitioningAlgorithmType::HSFC, "hsfc" },
     106                 :            :       { PartitioningAlgorithmType::MJ, "multijagged" },
     107                 :            :       { PartitioningAlgorithmType::PHG, "phg" }
     108                 :            :     };
     109                 :            : };
     110                 :            : 
     111                 :            : } // ctr::
     112                 :            : } // tk::
     113                 :            : 
     114                 :            : #endif // InciterPartitioningAlgorithmOptions_h