DamBreak++ Wave Simulator 0.3
DamBreak++ Simulation Framework
Loading...
Searching...
No Matches
Testvs19::BaseRhsPhysicsAlgorithm Class Reference

Base RHS terms algoritm (support legacy code). More...

#include <Testvs19_BaseRhsPhysicsAlgorithm.h>

Inheritance diagram for Testvs19::BaseRhsPhysicsAlgorithm:
Sfx::PhysicalAlgorithm

Public Types

enum class  eFluxType { HLL =0 , NujicI =1 }

Public Member Functions

 BaseRhsPhysicsAlgorithm (std::string aName, eFluxType aFFalgo=eFluxType::HLL)
 constructor
 ~BaseRhsPhysicsAlgorithm ()
 destructor
void calculate (dbpp::PhysicalSystem *aPhysys, const std::shared_ptr< dbpp::FiniteVolumeDiscretization > &aGblDiscr, Sfx::Simulation *aSim) override
 Main algorithm of the SCL (numerical)
void setPressureTerm (bool aUseP) noexcept
 name of pointer-to-function
bool usePressureTerm () const noexcept
 flag to set if pressure is taken into account
Public Member Functions inherited from Sfx::PhysicalAlgorithm
virtual ~PhysicalAlgorithm ()=default
 dtor
virtual bool isTimeDependent () const noexcept
 time dependent algorihm

Private Attributes

std::string m_name
uint32 m_varOrder
bool m_usePressure
std::shared_ptr< dbpp::FluxAlgorithmm_calculFF
Sfx::DbgLoggerm_dbgLog

Detailed Description

Base RHS terms algoritm (support legacy code).

Member Enumeration Documentation

◆ eFluxType

A enum type Numerical flux face type

Enumerator
HLL 

Harten-Lax-van Leer Algorithm

NujicI 

Nujic ENO (simplified version) Algorithm

Constructor & Destructor Documentation

◆ BaseRhsPhysicsAlgorithm()

Testvs19::BaseRhsPhysicsAlgorithm::BaseRhsPhysicsAlgorithm ( std::string aName,
eFluxType aFFalgo = eFluxType::HLL )

constructor

Parameters
aPtr2FuncNamename of pointer-to-function
aPtr2Funcpointer-to-function flux algorithm
usePressureflag for RHS pressure term

◆ ~BaseRhsPhysicsAlgorithm()

Testvs19::BaseRhsPhysicsAlgorithm::~BaseRhsPhysicsAlgorithm ( )

destructor

Member Function Documentation

◆ calculate()

void Testvs19::BaseRhsPhysicsAlgorithm::calculate ( dbpp::PhysicalSystem * aPhysys,
const std::shared_ptr< dbpp::FiniteVolumeDiscretization > & aGblDiscr,
Sfx::Simulation * aSim )
overridevirtual

Main algorithm of the SCL (numerical)

Parameters
aPhysysphysical system
aGblDiscrFinite Volume discretization
aSimSimulation beam

Implements Sfx::PhysicalAlgorithm.

◆ setPressureTerm()

void Testvs19::BaseRhsPhysicsAlgorithm::setPressureTerm ( bool aUseP)
inlinenoexcept

name of pointer-to-function

Returns
string

...

◆ usePressureTerm()

bool Testvs19::BaseRhsPhysicsAlgorithm::usePressureTerm ( ) const
inlinenoexcept

flag to set if pressure is taken into account

Returns
true/false

Member Data Documentation

◆ m_calculFF

std::shared_ptr<dbpp::FluxAlgorithm> Testvs19::BaseRhsPhysicsAlgorithm::m_calculFF
private

pointer to function type

◆ m_dbgLog

Sfx::DbgLogger* Testvs19::BaseRhsPhysicsAlgorithm::m_dbgLog
private

logger

◆ m_name

std::string Testvs19::BaseRhsPhysicsAlgorithm::m_name
private

name

◆ m_usePressure

bool Testvs19::BaseRhsPhysicsAlgorithm::m_usePressure
private

flag

◆ m_varOrder

uint32 Testvs19::BaseRhsPhysicsAlgorithm::m_varOrder
private

order


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