dbpp_Gamma.h

Go to the documentation of this file.

#pragma once
 
// C++ include
#include <optional>
 
// SfxBase19 includes
#include "include/BaseMacros.h"
#include "include/Sfx_DefineTypes.h"
 
namespace dbpp 
{
  class Gamma 
  {
    public:
        enum class eBndType
        {
            None = 0,       
            Neumann = 1,     
            Dirichlet = 2,  
            periodic = 3,   
            noncentered = 4 
        };
    public:
        Gamma( eBndType aType = eBndType::None, std::optional<float64> aValue = std::nullopt)
      : m_Type(aType),
            m_Value(aValue.value())
        {
            if( m_Type != eBndType::None)
            {
                SFX_REQUIRE(aValue != std::nullopt,
                    "A value must be supplied for this type"
                    "of boundary condition");
            }
        }

        eBndType type()   const noexcept { return m_Type; }
        float64 value() const noexcept { return m_Value; } // ?? i am not sure
    private:
        eBndType m_Type; 
        float64 m_Value; 
  };
} // End of namespace