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

System of conservation Law with an initial discontinuity in it. Two states connected by a left and right state which can be represented constant piecewise function over each cell where shock propagate (a cell face define a discontinuity). More...

#include <dbpp_RiemannProblem.h>

Public Member Functions

 RiemannProblem (Sfx::SCLEquation *aScleq)
 Constructor.
void setUL (const Sfx::StateVector &aLeftState)
 State connected to discontinuity.
void setUR (const Sfx::StateVector &aRightState)
 State connected to discontinuity.
Sfx::StateVector getUL () const
 Left state vector.
Sfx::StateVector getUR () const
 Right state vector.
Sfx::SCLEquation * getMthEquations () const
 System of Conservation LAw.
void setFaceIdx (unsigned int aFaceIx)
 Face index.
auto getFaceIdx () const
 Face index.

Private Attributes

Sfx::SCLEquation * m_sysConsLaws
short m_faceIdx
Sfx::StateVector m_UL
Sfx::StateVector m_UR

Detailed Description

System of conservation Law with an initial discontinuity in it. Two states connected by a left and right state which can be represented constant piecewise function over each cell where shock propagate (a cell face define a discontinuity).

Constructor & Destructor Documentation

◆ RiemannProblem()

dbpp::RiemannProblem::RiemannProblem ( Sfx::SCLEquation * aScleq)
inline

Constructor.

Parameters
aScleqSystem conservation Law

Member Function Documentation

◆ getFaceIdx()

auto dbpp::RiemannProblem::getFaceIdx ( ) const
inline

Face index.

Returns
cell face index

◆ getMthEquations()

Sfx::SCLEquation * dbpp::RiemannProblem::getMthEquations ( ) const
inline

System of Conservation LAw.

Returns
instance of the math equations

◆ getUL()

Sfx::StateVector dbpp::RiemannProblem::getUL ( ) const
inline

Left state vector.

Returns
state vector left state

◆ getUR()

Sfx::StateVector dbpp::RiemannProblem::getUR ( ) const
inline

Right state vector.

Returns
state vector right state

◆ setFaceIdx()

void dbpp::RiemannProblem::setFaceIdx ( unsigned int aFaceIx)
inline

Face index.

Parameters
aFaceIxcell face index

◆ setUL()

void dbpp::RiemannProblem::setUL ( const Sfx::StateVector & aLeftState)
inline

State connected to discontinuity.

Parameters
aLeftStateleft state

◆ setUR()

void dbpp::RiemannProblem::setUR ( const Sfx::StateVector & aRightState)
inline

State connected to discontinuity.

Parameters
aRightStateright state

Member Data Documentation

◆ m_faceIdx

short dbpp::RiemannProblem::m_faceIdx
private

cell face index

◆ m_sysConsLaws

Sfx::SCLEquation* dbpp::RiemannProblem::m_sysConsLaws
private

System of conservation laws

◆ m_UL

Sfx::StateVector dbpp::RiemannProblem::m_UL
private

Left state vector

◆ m_UR

Sfx::StateVector dbpp::RiemannProblem::m_UR
private

Right state vector


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