DamBreak++ Wave Simulator 0.3
DamBreak++ Simulation Framework
Loading...
Searching...
No Matches
dbpp::FluxAlgorithm Class Referenceabstract

Abstract base class for numerical flux algorithm. More...

#include <dbpp_FluxAlgorithm.h>

Inheritance diagram for dbpp::FluxAlgorithm:
dbpp::HLLFluxAlgorithm dbpp::NujicFluxAlgorithm dbpp::Ptr2FLegacyFluxAlgorithm

Public Member Functions

virtual bool useReconstr () const noexcept
 Reconstruction is used.
virtual bool usePhysicalCompleteFlux () const noexcept
 numerical flux based components (both hydrostatic and ... pressure)
virtual bool usePhysicalInCompleteFlux () const noexcept
 numerical flux based components (only hydrostatic term is considered)
virtual void setFluxAlgoPrms ()
 Flux algorithm parameters.
virtual void setReconstrVarOrder (int32 aOrder) noexcept
 cell face variable reconstr order (second-order default)
virtual int32 getReconstrVarOrder () const noexcept
 reconstruction variable
virtual void setReconstrType (eReconstrType aRecnstrType) noexcept=0
 Reconstruction of variables.
virtual eReconstrType getReconstrType () const noexcept=0
 MUSCL as default.
virtual FluxTensor calculFF (const Sfx::cellFaceVariables &aFaceVariables)=0
virtual FluxTensor calculFF (const Sfx::StateVector &aUL, const Sfx::StateVector &aUR, const cellFace &aCellFace)=0
 cell face flux
virtual FluxTensorMap calculFF (const Sfx::scalarField1D &U1, const Sfx::scalarField1D &U2, const Omega &aDomain, const PhysicalBoundaryCnd &aPhysbc)=0
 Face flux Harten-Lax- Levy flux algorithm.
virtual FluxTensorMap calculFF (const Sfx::scalarField1D &aU1, const Sfx::scalarField1D &aU2, const PhysicalBoundaryCnd &aPhysbc)=0
 Numerical Face flux.

Detailed Description

Abstract base class for numerical flux algorithm.

Member Function Documentation

◆ calculFF() [1/4]

virtual FluxTensor dbpp::FluxAlgorithm::calculFF ( const Sfx::cellFaceVariables & aFaceVariables)
pure virtual
Parameters
aFaceVariables

Implemented in dbpp::HLLFluxAlgorithm, dbpp::NujicFluxAlgorithm, and dbpp::Ptr2FLegacyFluxAlgorithm.

◆ calculFF() [2/4]

virtual FluxTensorMap dbpp::FluxAlgorithm::calculFF ( const Sfx::scalarField1D & aU1,
const Sfx::scalarField1D & aU2,
const PhysicalBoundaryCnd & aPhysbc )
pure virtual

Numerical Face flux.

Parameters
aU1first state variable
aU2second state variable
aPhysbcphysical boundary condition
Returns
flux tensor

Implemented in dbpp::HLLFluxAlgorithm, dbpp::NujicFluxAlgorithm, and dbpp::Ptr2FLegacyFluxAlgorithm.

◆ calculFF() [3/4]

virtual FluxTensorMap dbpp::FluxAlgorithm::calculFF ( const Sfx::scalarField1D & U1,
const Sfx::scalarField1D & U2,
const Omega & aDomain,
const PhysicalBoundaryCnd & aPhysbc )
pure virtual

Face flux Harten-Lax- Levy flux algorithm.

Parameters
aU1first state variable
aU2second state variable
aDomainlist cell face
aPhysbcphysical boundary condition
Returns
flux tensor

Implemented in dbpp::HLLFluxAlgorithm, dbpp::NujicFluxAlgorithm, and dbpp::Ptr2FLegacyFluxAlgorithm.

◆ calculFF() [4/4]

virtual FluxTensor dbpp::FluxAlgorithm::calculFF ( const Sfx::StateVector & aUL,
const Sfx::StateVector & aUR,
const cellFace & aCellFace )
pure virtual

cell face flux

Parameters
ULshock left state
URshock right state
aListCellFace@returnflux tensor

Implemented in dbpp::HLLFluxAlgorithm, dbpp::NujicFluxAlgorithm, and dbpp::Ptr2FLegacyFluxAlgorithm.

◆ getReconstrType()

virtual eReconstrType dbpp::FluxAlgorithm::getReconstrType ( ) const
pure virtualnoexcept

MUSCL as default.

Returns
type of reonstruction

Implemented in dbpp::HLLFluxAlgorithm, dbpp::NujicFluxAlgorithm, and dbpp::Ptr2FLegacyFluxAlgorithm.

◆ getReconstrVarOrder()

virtual int32 dbpp::FluxAlgorithm::getReconstrVarOrder ( ) const
inlinevirtualnoexcept

reconstruction variable

Returns
variable order

Reimplemented in dbpp::HLLFluxAlgorithm, and dbpp::Ptr2FLegacyFluxAlgorithm.

◆ setFluxAlgoPrms()

virtual void dbpp::FluxAlgorithm::setFluxAlgoPrms ( )
inlinevirtual

Flux algorithm parameters.

Reimplemented in dbpp::HLLFluxAlgorithm.

◆ setReconstrType()

virtual void dbpp::FluxAlgorithm::setReconstrType ( eReconstrType aRecnstrType)
pure virtualnoexcept

Reconstruction of variables.

Parameters
aRecnstrTypetype of reconstruction

Implemented in dbpp::HLLFluxAlgorithm, dbpp::NujicFluxAlgorithm, and dbpp::Ptr2FLegacyFluxAlgorithm.

◆ setReconstrVarOrder()

virtual void dbpp::FluxAlgorithm::setReconstrVarOrder ( int32 aOrder)
inlinevirtualnoexcept

cell face variable reconstr order (second-order default)

Parameters
aOrdervariable order

Reimplemented in dbpp::HLLFluxAlgorithm.

◆ usePhysicalCompleteFlux()

virtual bool dbpp::FluxAlgorithm::usePhysicalCompleteFlux ( ) const
inlinevirtualnoexcept

numerical flux based components (both hydrostatic and ... pressure)

Returns
true/false

Reimplemented in dbpp::HLLFluxAlgorithm, and dbpp::NujicFluxAlgorithm.

◆ usePhysicalInCompleteFlux()

virtual bool dbpp::FluxAlgorithm::usePhysicalInCompleteFlux ( ) const
inlinevirtualnoexcept

numerical flux based components (only hydrostatic term is considered)

Returns
true/false

Reimplemented in dbpp::Ptr2FLegacyFluxAlgorithm.

◆ useReconstr()

virtual bool dbpp::FluxAlgorithm::useReconstr ( ) const
inlinevirtualnoexcept

Reconstruction is used.

Returns
true/false

Reimplemented in dbpp::HLLFluxAlgorithm, dbpp::NujicFluxAlgorithm, and dbpp::Ptr2FLegacyFluxAlgorithm.


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