TransFlow  0.1.0
A transient pipeline flow simulation library
BoundaryConditions::SingleCondition Class Reference

The SingleCondition class is used to store a single boundary condition (like flow, pressure or temperature), and also contains information on whether the condition is "active", meaning if it is meant to be a constrain when solving the governing equations. More...

#include <boundaryconditions.hpp>

Public Member Functions

 SingleCondition (const double value, const bool active)
 Construct from value and isActive bool. More...
 
 operator double () const
 User-defined conversion to double, which allows implicit conversion.
 
 operator double ()
 User-defined conversion to double, which allows implicit conversion.
 
double value () const
 Get the value.
 
double value ()
 Get the value.
 
bool isActive () const
 If the condition is active or not.
 
bool isActive ()
 If the condition is active or not.
 

Private Member Functions

void setActive (const bool active)
 Set the active state of the condition.
 

Private Attributes

double m_value
 The value at the boundary.
 
bool m_isActive
 If the condition is active or not.
 

Friends

class BoundaryConditions
 

Detailed Description

The SingleCondition class is used to store a single boundary condition (like flow, pressure or temperature), and also contains information on whether the condition is "active", meaning if it is meant to be a constrain when solving the governing equations.

Constructor & Destructor Documentation

◆ SingleCondition()

BoundaryConditions::SingleCondition::SingleCondition ( const double  value,
const bool  active 
)
inline

Construct from value and isActive bool.

Parameters
valueValue at boundary
activeIf the condition is active

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