DamBreak++ Wave Simulator 0.3
DamBreak++ Simulation Framework
Loading...
Searching...
No Matches
dbpp::Gamma Class Reference

Boundary condition. More...

#include <dbpp_Gamma.h>

Public Types

enum class  eBndType {
  None = 0 , Neumann = 1 , Dirichlet = 2 , periodic = 3 ,
  noncentered = 4
}
 Boundary type. More...

Public Member Functions

 Gamma (eBndType aType=eBndType::None, std::optional< float64 > aValue=std::nullopt)
 ctor from b.c. type and a value
eBndType type () const noexcept
 boundary condition type
float64 value () const noexcept
 boundary condition value

Private Attributes

eBndType m_Type
float64 m_Value

Detailed Description

Boundary condition.

Member Enumeration Documentation

◆ eBndType

enum class dbpp::Gamma::eBndType
strong

Boundary type.

Enumerator
None 

no b.c.

Neumann 

Neuman type

Dirichlet 

Dirichlet type

periodic 

periodic

noncentered 

non-centered

Constructor & Destructor Documentation

◆ Gamma()

dbpp::Gamma::Gamma ( eBndType aType = eBndType::None,
std::optional< float64 > aValue = std::nullopt )
inline

ctor from b.c. type and a value

Parameters
aTypeB.C. type
aValueB.C. value

Member Function Documentation

◆ type()

eBndType dbpp::Gamma::type ( ) const
inlinenoexcept

boundary condition type

Returns
type

◆ value()

float64 dbpp::Gamma::value ( ) const
inlinenoexcept

boundary condition value

Returns
float64

Member Data Documentation

◆ m_Type

eBndType dbpp::Gamma::m_Type
private

B.C. type

◆ m_Value

float64 dbpp::Gamma::m_Value
private

B.C. value


The documentation for this class was generated from the following file: