Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Member Functions | List of all members
alsfvm::integrator::System Class Referenceabstract

#include <alsfvm/integrator/System.hpp>

Inheritance diagram for alsfvm::integrator::System:
alsfvm::simulator::ConservedSystem

Public Member Functions

virtual void operator() (volume::Volume &conservedVariables, rvec3 &waveSpeed, bool computeWaveSpeed, volume::Volume &output)=0
 operator () computes the right hand side of the ODE. (see class definition) More...
 
virtual size_t getNumberOfGhostCells () const
 
virtual void setCellExchanger (mpi::CellExchangerPtr cellExchanger)
 
virtual ~System ()
 

Detailed Description

Abstract base class right hand side of ODEs.

We model ODEs as

\[\vec{u}'(t)=F(\vec{u}(t)).\]

The system class is responsible for computing $F(\vec{u}(t))$.

Constructor & Destructor Documentation

◆ ~System()

virtual alsfvm::integrator::System::~System ( )
inlinevirtual

Member Function Documentation

◆ getNumberOfGhostCells()

virtual size_t alsfvm::integrator::System::getNumberOfGhostCells ( ) const
inlinevirtual

Returns the number of ghost cells needed. This will take the maximum between the number of ghost cells the numerical flux needs, and the number of ghost cells the diffusion operator needs

Reimplemented in alsfvm::simulator::ConservedSystem.

◆ operator()()

virtual void alsfvm::integrator::System::operator() ( volume::Volume conservedVariables,
rvec3 waveSpeed,
bool  computeWaveSpeed,
volume::Volume output 
)
pure virtual

operator () computes the right hand side of the ODE. (see class definition)

Parameters
[in]conservedVariablesthe current state of the conserved variables corresponds to $\vec{u}$.
[out]waveSpeedat end of invocation, the maximum wavespeed
[in]computeWaveSpeed
[out]outputwill at end of invocation contain the values of $F(\vec{u})$

Implemented in alsfvm::simulator::ConservedSystem.

◆ setCellExchanger()

virtual void alsfvm::integrator::System::setCellExchanger ( mpi::CellExchangerPtr  cellExchanger)
inlinevirtual

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