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

#include <alsfvm/init/InitialData.hpp>

Inheritance diagram for alsfvm::init::InitialData:
alsfvm::init::PythonInitialData

Public Member Functions

virtual ~InitialData ()
 
virtual void setInitialData (volume::Volume &conservedVolume, volume::Volume &primitiveVolume, equation::CellComputer &cellComputer, grid::Grid &grid)=0
 setInitialData sets the initial data More...
 
virtual void setParameters (const Parameters &parameters)=0
 
virtual boost::property_tree::ptree getDescription () const =0
 

Constructor & Destructor Documentation

◆ ~InitialData()

virtual alsfvm::init::InitialData::~InitialData ( )
inlinevirtual

Member Function Documentation

◆ getDescription()

virtual boost::property_tree::ptree alsfvm::init::InitialData::getDescription ( ) const
pure virtual

Should provide a description of the initial data (eg the python script used for the initial data). Does not need to be machine parseable in any way, this is for "human readable reproducability" and extra debugging information.

Implemented in alsfvm::init::PythonInitialData.

◆ setInitialData()

virtual void alsfvm::init::InitialData::setInitialData ( volume::Volume conservedVolume,
volume::Volume primitiveVolume,
equation::CellComputer cellComputer,
grid::Grid grid 
)
pure virtual

setInitialData sets the initial data

Parameters
conservedVolumeconserved volume to fill
cellComputeran instance of the cell computer for the equation
primitiveVolumean instance of the primtive volume for the equation
gridunderlying grid.
Note
All volumes need to have the correct size. All volumes will at the end be written to.
This is not an efficient implementation, so it should really only be used for initial data!

Implemented in alsfvm::init::PythonInitialData.

◆ setParameters()

virtual void alsfvm::init::InitialData::setParameters ( const Parameters parameters)
pure virtual

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