ECOGEN 6.0
Evolutive, Compressible, Open, Genuine, Easy, N-phase
Loading...
Searching...
No Matches
Source Class Reference

Abstract class for source terms. More...

#include <Source.h>

Inherited by SourceExact, and SourceNum.

Public Member Functions

 Source (int physicalEntity=0)
 Source constructor depending on integration order and physical entity to apply source.
virtual ~Source ()
virtual void prepSourceTerms (Cell *, const int &=0)
 Source terms preparation for integration.
virtual void integrateSourceTerms (Cell *, const double &, Prim=vecPhases)
 Source terms integration on conservative quantities.
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.
virtual Coord getOmega ()
virtual bool getRiemannCoupling ()
virtual int getPhysicalEntity ()

Protected Attributes

int m_physicalEntity

Detailed Description

Abstract class for source terms.

Constructor & Destructor Documentation

◆ Source()

Source::Source ( int physicalEntity = 0)

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

Parameters
physicalEntitythe entity to which the source term is applied (default whole domain)
Here is the caller graph for this function:

◆ ~Source()

Source::~Source ( )
virtual

Member Function Documentation

◆ computeAbsVelocity()

virtual Coord Source::computeAbsVelocity ( const Coord & ,
const Coord &  )
inlinevirtual

Compute the absolute velocity in the fixed coordinate system.

Parameters
relVelocityvelocity in the moving coordinate system
positionposition vector in the fixed coordinate system

Reimplemented in SourceNum, and SourceNumMRF.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getOmega()

virtual Coord Source::getOmega ( )
inlinevirtual

Reimplemented in SourceNumMRF.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getPhysicalEntity()

virtual int Source::getPhysicalEntity ( )
inlinevirtual
Here is the caller graph for this function:

◆ getRiemannCoupling()

virtual bool Source::getRiemannCoupling ( )
inlinevirtual

Reimplemented in SourceNumMRF.

Here is the call graph for this function:

◆ integrateSourceTerms()

virtual void Source::integrateSourceTerms ( Cell * ,
const double & ,
Prim = vecPhases )
inlinevirtual

Source terms integration on conservative quantities.

Parameters
cellcell for source term integration
dtintegration time step

Reimplemented in SourceExact, and SourceNum.

Here is the call graph for this function:

◆ prepSourceTerms()

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

Source terms preparation for integration.

Parameters
cellcell for source term integration

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

Here is the call graph for this function:

◆ sourceEvolution()

virtual void Source::sourceEvolution ( const double & )
inlinevirtual

Allows to modifiy the source term along time.

Parameters
timephysical time of the computation

Reimplemented in SourceNum, and SourceNumMRF.

Member Data Documentation

◆ m_physicalEntity

int Source::m_physicalEntity
protected

The documentation for this class was generated from the following files:
  • /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Sources/Source.h
  • /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Sources/Source.cpp