SourceNumAcousticWavePlaneGaussianPulse Class Reference

Subclass of SourceNumAcousticWave for a plane Gaussian function. More...

#include <SourceNumAcousticWavePlaneGaussianPulse.h>

Inherits SourceNumAcousticWave.

Collaboration diagram for SourceNumAcousticWavePlaneGaussianPulse:

Public Member Functions
	SourceNumAcousticWavePlaneGaussianPulse (tinyxml2::XMLElement *element, int order, int physicalEntity=0, std::string fileName="Unknown file")
	SourceNumAcousticWavePlaneGaussianPulse constructor from a XML format reading.
	~SourceNumAcousticWavePlaneGaussianPulse () override
void	prepSourceTerms (Cell *cell, const int &i=0) override
	Source terms preparation for integration.
double	computeDeltaFunction (const Cell *cell)
	Compute the function delta.
double	computeGFunction ()
	Compute the function g.
Public Member Functions inherited from SourceNumAcousticWave
	SourceNumAcousticWave (int order, int physicalEntity=0)
	SourceNumAcousticWave constructor.
	~SourceNumAcousticWave () override
Public Member Functions inherited from SourceNum
	SourceNum (int order, int physicalEntity=0)
	SourceNum constructor depending on integration order and physical entity to apply source.
	~SourceNum () override
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 ()

Private Attributes
double	m_pulseWidth

Additional Inherited Members
Protected Attributes inherited from SourceNumAcousticWave
double	m_sourceMomentum
double	m_pressureAmplitude
	Source term on the momentum equation.
double	m_delayedTime
	Pressure amplitude of the wave (Pa).
Coord	m_sourceLocation
	Delayed time at which the first pulse starts (s).
Coord	m_pulseDirection
	Location of the source (m).
Protected Attributes inherited from SourceNum
int	m_order
Protected Attributes inherited from Source
int	m_physicalEntity

Detailed Description

Subclass of SourceNumAcousticWave for a plane Gaussian function.

Constructor & Destructor Documentation

SourceNumAcousticWavePlaneGaussianPulse()

SourceNumAcousticWavePlaneGaussianPulse::SourceNumAcousticWavePlaneGaussianPulse	(	tinyxml2::XMLElement *	element,
		int	order,
		int	physicalEntity = 0,
		std::string	fileName = "Unknown file" )

SourceNumAcousticWavePlaneGaussianPulse constructor from a XML format reading.

Reading data from XML file under the following format: ex: <dataHeating q="1.e3">

Parameters

element	XML element to read for source term
order	integration order (could EULER, RK2 or RK4 scheme)
physicalEntity	the entity to which the source term is applied (default whole domain)
fileName	string name of readed XML file

Here is the call graph for this function:

~SourceNumAcousticWavePlaneGaussianPulse()

SourceNumAcousticWavePlaneGaussianPulse::~SourceNumAcousticWavePlaneGaussianPulse ( )

override

Member Function Documentation

computeDeltaFunction()

double SourceNumAcousticWavePlaneGaussianPulse::computeDeltaFunction

(

const Cell *

cell

)

Compute the function delta.

Parameters

cell	current cell

Here is the call graph for this function:

Here is the caller graph for this function:

computeGFunction()

double SourceNumAcousticWavePlaneGaussianPulse::computeGFunction

(

)

Compute the function g.

Here is the caller graph for this function:

prepSourceTerms()

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

overridevirtual

Source terms preparation for integration.

Parameters

cell	cell for source term integration

Reimplemented from SourceNum.

Here is the call graph for this function:

Member Data Documentation

m_pulseWidth

double SourceNumAcousticWavePlaneGaussianPulse::m_pulseWidth

private

---

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

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