SourceNum Class Reference

Abstract class for source terms solved by a numerical scheme. More...

#include <SourceNum.h>

Inherits Source.

Inherited by SourceNumAcousticWave, SourceNumGravity, SourceNumHeating, and SourceNumMRF.

Collaboration diagram for SourceNum:

Public Member Functions
	SourceNum (int order, int physicalEntity=0)
	SourceNum constructor depending on integration order and physical entity to apply source.
	~SourceNum () override
void	prepSourceTerms (Cell *, const int &=0) override
	Source terms preparation for integration.
void	integrateSourceTerms (Cell *cell, const double &dt, Prim=vecPhases) override
	Source terms integration on conservative quantities.
void	integrationEuler (Cell *cell, const double &dt)
	Euler explicite integration (order 1).
void	integrationRK2 (Cell *cell, const double &dt)
	Runge-Kutta integration (order 2).
void	integrationRK4 (Cell *cell, const double &dt)
	Runge-Kutta integration (order 4).
void	sourceEvolution (const double &) override
	Allows to modifiy the source term along time.
Coord	computeAbsVelocity (const Coord &, const Coord &) override
	Compute the absolute velocity in the fixed coordinate system.
Public Member Functions inherited from Source
	Source (int physicalEntity=0)
	Source constructor depending on integration order and physical entity to apply source.
virtual	~Source ()
virtual Coord	getOmega ()
virtual bool	getRiemannCoupling ()
virtual int	getPhysicalEntity ()

Protected Attributes
int	m_order
Protected Attributes inherited from Source
int	m_physicalEntity

Detailed Description

Abstract class for source terms solved by a numerical scheme.

Constructor & Destructor Documentation

SourceNum()

SourceNum::SourceNum	(	int	order,
		int	physicalEntity = 0 )

SourceNum constructor depending on integration order and physical entity to apply source.

Parameters

order	integration order (could EULER, RK2 or RK4 scheme)
physicalEntity	the entity to which the source term is applied (default whole domain)

Here is the call graph for this function:

Here is the caller graph for this function:

~SourceNum()

SourceNum::~SourceNum ( )

override

Member Function Documentation

computeAbsVelocity()

Coord SourceNum::computeAbsVelocity ( const Coord & , const Coord &  )

inlineoverridevirtual

Compute the absolute velocity in the fixed coordinate system.

Parameters

relVelocity	velocity in the moving coordinate system
position	position vector in the fixed coordinate system

Reimplemented from Source.

Reimplemented in SourceNumMRF.

Here is the call graph for this function:

integrateSourceTerms()

void SourceNum::integrateSourceTerms ( Cell * cell, const double & dt, Prim = vecPhases )

overridevirtual

Source terms integration on conservative quantities.

Parameters

cell	cell for source term integration
dt	integration time step

Reimplemented from Source.

Here is the call graph for this function:

integrationEuler()

void SourceNum::integrationEuler	(	Cell *	cell,
		const double &	dt )

Euler explicite integration (order 1).

Parameters

cell	cell for source term integration
dt	explicit integration time step

Here is the call graph for this function:

Here is the caller graph for this function:

integrationRK2()

void SourceNum::integrationRK2	(	Cell *	cell,
		const double &	dt )

Runge-Kutta integration (order 2).

Parameters

cell	cell for source term integration
dt	explicit integration time step

Here is the call graph for this function:

Here is the caller graph for this function:

integrationRK4()

void SourceNum::integrationRK4	(	Cell *	cell,
		const double &	dt )

Runge-Kutta integration (order 4).

Parameters

cell	cell for source term integration
dt	explicit integration time step

Here is the call graph for this function:

Here is the caller graph for this function:

prepSourceTerms()

void SourceNum::prepSourceTerms ( Cell * , const int & = 0 )

inlineoverridevirtual

Source terms preparation for integration.

Parameters

cell	cell for source term integration

Reimplemented from Source.

Reimplemented in SourceNumAcousticWavePlaneGaussianPulse, SourceNumAcousticWavePlaneSinusoidalPulse, SourceNumGravity, SourceNumHeating, and SourceNumMRF.

Here is the call graph for this function:

Here is the caller graph for this function:

sourceEvolution()

void SourceNum::sourceEvolution ( const double & )

inlineoverridevirtual

Allows to modifiy the source term along time.

Parameters

time	physical time of the computation

Reimplemented from Source.

Reimplemented in SourceNumMRF.

Member Data Documentation

m_order

int SourceNum::m_order

protected

---

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

• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Sources/SourceNum.h
• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Sources/SourceNum.cpp