DamBreak++ Wave Simulator 0.3
DamBreak++ Simulation Framework
Loading...
Searching...
No Matches
Testvs19::Nujic2StepsIntegrator Class Referencefinal

Numerical integration by two-steps Rungde-Kutta (second-order). More...

#include <Testvs19_Nujic2StepsIntegrator.h>

Inheritance diagram for Testvs19::Nujic2StepsIntegrator:

Public Member Functions

 Nujic2StepsIntegrator (const Sfx::FieldLattice &aU1, const Sfx::FieldLattice &aU2)
 ctor from field lattice values
 Nujic2StepsIntegrator (const Sfx::FieldLattice &aU1, const Sfx::FieldLattice &aU2, Sfx::LDeltaOperator *aLdeltaOp)
 ctor from field lattice values
void initialize () override final
 set inital state of the integrator
void predictor () override final
 predictor step
void corrector () override final
 corrector step
RetRhsTypepreviousState () const override
 Getter.
RetRhsTypecurrentState () const override
 Getter.
pairofield getFinalSolution () const noexcept
 Getter.
void setInitialState (const Sfx::FieldLattice &aU1, const Sfx::FieldLattice &aU2) override final
 set initial condition
void setBCAtBothEnds (const Sfx::EMcNeilBndCnd::pair_node &aBcNodes)
 set physical boundary
void setBCValuesAtBothEnds (const std::pair< Sfx::Object *, Sfx::Object * > &aBcNodes) override final
 set physical boundary
void step ()
 time stepping algorithm

Private Types

using pairofield = std::pair<Sfx::FieldLattice, Sfx::FieldLattice>

Private Attributes

Sfx::LDeltaOperatorm_deltaOp
Sfx::FieldLattice m_midU1
Sfx::FieldLattice m_midU2
Sfx::FieldLattice m_currU1
Sfx::FieldLattice m_currU2
Sfx::Nodal_Value m_upstreamNode
Sfx::Nodal_Value m_downstreamNode

Detailed Description

Numerical integration by two-steps Rungde-Kutta (second-order).

Member Typedef Documentation

◆ pairofield

using Testvs19::Nujic2StepsIntegrator::pairofield = std::pair<Sfx::FieldLattice, Sfx::FieldLattice>
private

Alias

Constructor & Destructor Documentation

◆ Nujic2StepsIntegrator() [1/2]

Testvs19::Nujic2StepsIntegrator::Nujic2StepsIntegrator ( const Sfx::FieldLattice & aU1,
const Sfx::FieldLattice & aU2 )

ctor from field lattice values

Parameters
aU1state variable
aU2state variable

◆ Nujic2StepsIntegrator() [2/2]

Testvs19::Nujic2StepsIntegrator::Nujic2StepsIntegrator ( const Sfx::FieldLattice & aU1,
const Sfx::FieldLattice & aU2,
Sfx::LDeltaOperator * aLdeltaOp )

ctor from field lattice values

Parameters
aU1state variable
aU2state variable
aLdeltaOpRHS (right-hand-side) operator

Member Function Documentation

◆ corrector()

void Testvs19::Nujic2StepsIntegrator::corrector ( )
finaloverride

corrector step

◆ currentState()

RetRhsType * Testvs19::Nujic2StepsIntegrator::currentState ( ) const
inlineoverride

Getter.

Returns
integrator current state
Deprecated

◆ getFinalSolution()

pairofield Testvs19::Nujic2StepsIntegrator::getFinalSolution ( ) const
inlinenoexcept

Getter.

Returns
pair of field lattice

◆ initialize()

void Testvs19::Nujic2StepsIntegrator::initialize ( )
inlinefinaloverride

set inital state of the integrator

◆ predictor()

void Testvs19::Nujic2StepsIntegrator::predictor ( )
finaloverride

predictor step

◆ previousState()

RetRhsType * Testvs19::Nujic2StepsIntegrator::previousState ( ) const
inlineoverride

Getter.

Returns
integrator intermediate state
Deprecated

◆ setBCAtBothEnds()

void Testvs19::Nujic2StepsIntegrator::setBCAtBothEnds ( const Sfx::EMcNeilBndCnd::pair_node & aBcNodes)
inline

set physical boundary

Parameters
aBcNodesnodal values

◆ setBCValuesAtBothEnds()

void Testvs19::Nujic2StepsIntegrator::setBCValuesAtBothEnds ( const std::pair< Sfx::Object *, Sfx::Object * > & aBcNodes)
inlinefinaloverride

set physical boundary

Parameters
aBcNodesnodal values

◆ setInitialState()

void Testvs19::Nujic2StepsIntegrator::setInitialState ( const Sfx::FieldLattice & aU1,
const Sfx::FieldLattice & aU2 )
finaloverride

set initial condition

Parameters
aU1state variable
aU2state variable

◆ step()

void Testvs19::Nujic2StepsIntegrator::step ( )

time stepping algorithm

Member Data Documentation

◆ m_currU1

Sfx::FieldLattice Testvs19::Nujic2StepsIntegrator::m_currU1
private

current state (n+1)

◆ m_currU2

Sfx::FieldLattice Testvs19::Nujic2StepsIntegrator::m_currU2
private

current state (n+1)

◆ m_deltaOp

Sfx::LDeltaOperator* Testvs19::Nujic2StepsIntegrator::m_deltaOp
private

RHS discretization operator

◆ m_downstreamNode

Sfx::Nodal_Value Testvs19::Nujic2StepsIntegrator::m_downstreamNode
private

physical boundary downstream

◆ m_midU1

Sfx::FieldLattice Testvs19::Nujic2StepsIntegrator::m_midU1
private

mid state state (n+1/2)

◆ m_midU2

Sfx::FieldLattice Testvs19::Nujic2StepsIntegrator::m_midU2
private

mid state state (n+1/2)

◆ m_upstreamNode

Sfx::Nodal_Value Testvs19::Nujic2StepsIntegrator::m_upstreamNode
private

physical boundary upstream


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