SourceNum Class Reference

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

#include <SourceNum.h>

Inherits Source.

Inherited by SourceNumGravity, SourceNumHeating, and SourceNumMRF.

Public Member Functions
	SourceNum (int order, int physicalEntity=0)
	SourceNum constructor depending on integration order and physical entity to apply source.
virtual	~SourceNum ()
virtual void	prepSourceTerms (Cell *, const int &=0)
	Source terms preparation for integration.
virtual void	integrateSourceTerms (Cell *cell, const double &dt)
	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)
virtual void	sourceEvolution (const double &)
	Allows to modifiy the source term along time.
virtual Coord	computeAbsVelocity (const Coord &, const Coord &)
	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)

~SourceNum()

SourceNum::~SourceNum ( )

virtual

Member Function Documentation

computeAbsVelocity()

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

inlinevirtual

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.

integrateSourceTerms()

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

virtual

Source terms integration on conservative quantities.

Parameters

cell	cell for source term integration
dt	integration time step

Reimplemented from Source.

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

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

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

prepSourceTerms()

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

inlinevirtual

Source terms preparation for integration.

Parameters

cell	cell for source term integration

Reimplemented from Source.

Reimplemented in SourceNumGravity, SourceNumHeating, and SourceNumMRF.

sourceEvolution()

virtual void SourceNum::sourceEvolution ( const double &  )

inlinevirtual

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:

• /Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Sources/SourceNum.h
• /Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Sources/SourceNum.cpp