PhaseUEqTotEnergy Class Reference

Phase variables for the velocity-equilibrium system of equations. More...

#include <PhaseUEqTotEnergy.h>

Inherits Phase.

Collaboration diagram for PhaseUEqTotEnergy:

Public Member Functions
	PhaseUEqTotEnergy ()
	PhaseUEqTotEnergy (tinyxml2::XMLElement *material, Eos *eos, std::string fileName)
	Phase constructor from a XML format reading.
	~PhaseUEqTotEnergy () override
void	allocateAndCopyPhase (Phase **vecPhase) override
	Copy phase attributes in phase.
void	copyPhase (Phase &phase) override
	Copy phase in phase attributes.
void	extendedCalculusPhase (const Coord &velocity) override
	Compute extra thermodynammical variables.
void	computeMassFraction (const double &density) override
void	localProjection (const Coord &, const Coord &, const Coord &) override
void	reverseProjection (const Coord &, const Coord &, const Coord &) override
int	getNumberScalars () const override
int	getNumberVectors () const override
double	returnScalar (const int &numVar) const override
Coord	returnVector (const int &) const override
std::string	returnNameScalar (const int &numVar) const override
std::string	returnNameVector (const int &) const override
void	setScalar (const int &numVar, const double &value) override
int	numberOfTransmittedVariables () const override
void	fillBuffer (double *buffer, int &counter) const override
void	fillBuffer (std::vector< double > &dataToSend) const override
void	getBuffer (double *buffer, int &counter, Eos **eos) override
void	getBuffer (std::vector< double > &dataToReceive, int &counter, Eos **eos) override
void	computeSlopesPhase (const Phase &sLeft, const Phase &sRight, const double &distance) override
void	setToZero () override
void	extrapolate (const Phase &slope, const double &distance) override
void	limitSlopes (const Phase &slopeGauche, const Phase &slopeDroite, Limiter &globalLimiter, Limiter &volumeFractionLimiter) override
int	numberOfTransmittedSlopes () const override
void	fillBufferSlopes (double *buffer, int &counter) const override
void	getBufferSlopes (double *buffer, int &counter) override
void	verifyPhase (const std::string &message="") const override
void	verifyAndCorrectPhase () override
void	verifyAndCorrectDensityMax (const double &mass) override
void	verifyAndCorrectDensityMax () override
const double &	getAlpha () const override
const double &	getDensity () const override
const double &	getPressure () const override
const double &	getY () const override
const double &	getU () const override
const double &	getV () const override
const double &	getW () const override
Coord &	getVelocity () override
const Coord &	getVelocity () const override
Eos *	getEos () const override
const double &	getTotalEnergy () const override
const double &	getSoundSpeed () const override
double	getTemperature () const override
void	setAlpha (double alpha) override
void	setDensity (double density) override
void	setPressure (double pressure) override
void	setVelocity (const double &, const double &, const double &) override
void	setVelocity (const Coord &) override
void	setU (const double &) override
void	setV (const double &) override
void	setW (const double &) override
void	setEos (Eos *eos) override
void	setTotalEnergy (double totalEnergy) override
void	setTotalEnergy (const double &energy, const Coord &vel) override
void	setSoundSpeed (double soundSpeed) override
void	changeSign () override
void	multiplyAndAdd (const Phase &slopesPhasesTemp, const double &coeff) override
void	divide (const double &coeff) override
Public Member Functions inherited from Phase
	Phase ()
virtual	~Phase ()
void	printPhase (std::ofstream &fileStream) const
	Print phase variables in file stream.
virtual void	setVector (const int &, const Coord &)
virtual void	setToMax ()
virtual void	setMin (const Phase &, const Phase &)
virtual void	setMax (const Phase &, const Phase &)
virtual void	computeGradientLimiter (const Limiter &, const Phase &, const Phase &, const Phase &, const Phase &)
virtual double	getSquareLongitudinalWaveSpeed () const
virtual const double &	getMassFraction () const
virtual const double &	getOmega () const
virtual const double &	getDensitySurEta () const
virtual const double &	getVectorPX () const
virtual const double &	getVectorPY () const
virtual const double &	getVectorPZ () const
virtual Coord &	getVectorP ()
virtual const Coord &	getVectorP () const
virtual const double &	getEnergy () const
virtual const double &	getEntropy () const
virtual const double &	getSquareSoundSpeed () const
virtual const double &	getLambda () const
virtual const double &	getEnergyCompaction () const
virtual const Tensor &	getCobase () const
virtual Tensor &	getCobase ()
virtual const double &	getEnergyElastic () const
virtual const Tensor &	getStressTensor () const
virtual Tensor &	getStressTensor ()
virtual void	setOmega (const double &)
virtual void	setDensitySurEta (const double &)
virtual void	setVectorP (const double &, const double &, const double &)
virtual void	setVectorP (const Coord &)
virtual void	setX (const double &)
virtual void	setY (const double &)
virtual void	setZ (const double &)
virtual void	setEnergy (double)
virtual void	setEntropy (double)
virtual void	setSquareSoundSpeed (double)
virtual void	setTemperature (double)
virtual void	setLambda (double)
virtual void	setEnergyCompaction (double)
virtual void	setCobase (const Tensor &)
virtual void	setEnergyElastic (double)
virtual void	setStressTensor (const Tensor &)

Protected Attributes
double	m_alpha
	phase volume fraction
double	m_density
	phase specific mass
double	m_pressure
	phase pressure
double	m_Y
	phase mass fraction
double	m_temperature
	phase temperature
Eos *	m_eos
	pointer to phase equation of state
double	m_totEnergy
	phase specific total energy
double	m_soundSpeed
	phase speed of sound

Detailed Description

Phase variables for the velocity-equilibrium system of equations.

Constructor & Destructor Documentation

PhaseUEqTotEnergy() [1/2]

PhaseUEqTotEnergy::PhaseUEqTotEnergy

(

)

Here is the caller graph for this function:

PhaseUEqTotEnergy() [2/2]

PhaseUEqTotEnergy::PhaseUEqTotEnergy	(	tinyxml2::XMLElement *	material,
		Eos *	eos,
		std::string	fileName )

Phase constructor from a XML format reading.

Reading data from XML file under the following format: ex: <dataFluid alpha="0.5" density="1.0" pressure="1.e5">

Parameters

material	XML element to read for phase data
eos	EOS pointer to compute thermodynamic variables
fileName	string name of readed XML file

Here is the call graph for this function:

~PhaseUEqTotEnergy()

PhaseUEqTotEnergy::~PhaseUEqTotEnergy ( )

override

Member Function Documentation

allocateAndCopyPhase()

void PhaseUEqTotEnergy::allocateAndCopyPhase ( Phase ** )

overridevirtual

Copy phase attributes in phase.

Parameters

vecPhase

destination phase variable

Reimplemented from Phase.

Here is the call graph for this function:

changeSign()

void PhaseUEqTotEnergy::changeSign ( )

overridevirtual

Reimplemented from Phase.

computeMassFraction()

void PhaseUEqTotEnergy::computeMassFraction ( const double & density )

overridevirtual

Reimplemented from Phase.

computeSlopesPhase()

void PhaseUEqTotEnergy::computeSlopesPhase ( const Phase & sLeft, const Phase & sRight, const double & distance )

overridevirtual

Reimplemented from Phase.

Here is the call graph for this function:

copyPhase()

void PhaseUEqTotEnergy::copyPhase ( Phase & )

overridevirtual

Copy phase in phase attributes.

Parameters

vecPhase

source phase to copy

Reimplemented from Phase.

Here is the call graph for this function:

divide()

void PhaseUEqTotEnergy::divide ( const double & coeff )

overridevirtual

Reimplemented from Phase.

extendedCalculusPhase()

void PhaseUEqTotEnergy::extendedCalculusPhase ( const Coord & )

overridevirtual

Compute extra thermodynammical variables.

Computes from velocity, pressure and density

Parameters

velocity

phase velocity

Reimplemented from Phase.

Here is the call graph for this function:

extrapolate()

void PhaseUEqTotEnergy::extrapolate ( const Phase & slope, const double & distance )

overridevirtual

Reimplemented from Phase.

Here is the call graph for this function:

fillBuffer() [1/2]

void PhaseUEqTotEnergy::fillBuffer ( double * buffer, int & counter ) const

overridevirtual

Reimplemented from Phase.

fillBuffer() [2/2]

void PhaseUEqTotEnergy::fillBuffer ( std::vector< double > & dataToSend ) const

overridevirtual

Reimplemented from Phase.

fillBufferSlopes()

void PhaseUEqTotEnergy::fillBufferSlopes ( double * buffer, int & counter ) const

overridevirtual

Reimplemented from Phase.

getAlpha()

const double & PhaseUEqTotEnergy::getAlpha ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getBuffer() [1/2]

void PhaseUEqTotEnergy::getBuffer ( double * buffer, int & counter, Eos ** eos )

overridevirtual

Reimplemented from Phase.

getBuffer() [2/2]

void PhaseUEqTotEnergy::getBuffer ( std::vector< double > & dataToReceive, int & counter, Eos ** eos )

overridevirtual

Reimplemented from Phase.

getBufferSlopes()

void PhaseUEqTotEnergy::getBufferSlopes ( double * buffer, int & counter )

overridevirtual

Reimplemented from Phase.

getDensity()

const double & PhaseUEqTotEnergy::getDensity ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getEos()

Eos * PhaseUEqTotEnergy::getEos ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getNumberScalars()

int PhaseUEqTotEnergy::getNumberScalars ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getNumberVectors()

int PhaseUEqTotEnergy::getNumberVectors ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getPressure()

const double & PhaseUEqTotEnergy::getPressure ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getSoundSpeed()

const double & PhaseUEqTotEnergy::getSoundSpeed ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getTemperature()

double PhaseUEqTotEnergy::getTemperature ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getTotalEnergy()

const double & PhaseUEqTotEnergy::getTotalEnergy ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getU()

const double & PhaseUEqTotEnergy::getU ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getV()

const double & PhaseUEqTotEnergy::getV ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getVelocity() [1/2]

const Coord & PhaseUEqTotEnergy::getVelocity ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getVelocity() [2/2]

Coord & PhaseUEqTotEnergy::getVelocity ( )

inlineoverridevirtual

Reimplemented from Phase.

getW()

const double & PhaseUEqTotEnergy::getW ( ) const

inlineoverridevirtual

Reimplemented from Phase.

getY()

const double & PhaseUEqTotEnergy::getY ( ) const

inlineoverridevirtual

Reimplemented from Phase.

limitSlopes()

void PhaseUEqTotEnergy::limitSlopes ( const Phase & slopeGauche, const Phase & slopeDroite, Limiter & globalLimiter, Limiter & volumeFractionLimiter )

overridevirtual

Reimplemented from Phase.

Here is the call graph for this function:

localProjection()

void PhaseUEqTotEnergy::localProjection ( const Coord & , const Coord & , const Coord &  )

inlineoverridevirtual

Reimplemented from Phase.

multiplyAndAdd()

void PhaseUEqTotEnergy::multiplyAndAdd ( const Phase & slopesPhasesTemp, const double & coeff )

overridevirtual

Reimplemented from Phase.

Here is the call graph for this function:

numberOfTransmittedSlopes()

int PhaseUEqTotEnergy::numberOfTransmittedSlopes ( ) const

overridevirtual

Reimplemented from Phase.

numberOfTransmittedVariables()

int PhaseUEqTotEnergy::numberOfTransmittedVariables ( ) const

overridevirtual

Reimplemented from Phase.

returnNameScalar()

std::string PhaseUEqTotEnergy::returnNameScalar ( const int & numVar ) const

overridevirtual

Reimplemented from Phase.

returnNameVector()

std::string PhaseUEqTotEnergy::returnNameVector ( const int & ) const

inlineoverridevirtual

Reimplemented from Phase.

returnScalar()

double PhaseUEqTotEnergy::returnScalar ( const int & numVar ) const

overridevirtual

Reimplemented from Phase.

returnVector()

Coord PhaseUEqTotEnergy::returnVector ( const int & ) const

inlineoverridevirtual

Reimplemented from Phase.

reverseProjection()

void PhaseUEqTotEnergy::reverseProjection ( const Coord & , const Coord & , const Coord &  )

inlineoverridevirtual

Reimplemented from Phase.

setAlpha()

void PhaseUEqTotEnergy::setAlpha ( double alpha )

overridevirtual

Reimplemented from Phase.

setDensity()

void PhaseUEqTotEnergy::setDensity ( double density )

overridevirtual

Reimplemented from Phase.

setEos()

void PhaseUEqTotEnergy::setEos ( Eos * eos )

overridevirtual

Reimplemented from Phase.

setPressure()

void PhaseUEqTotEnergy::setPressure ( double pressure )

overridevirtual

Reimplemented from Phase.

setScalar()

void PhaseUEqTotEnergy::setScalar ( const int & numVar, const double & value )

overridevirtual

Reimplemented from Phase.

Here is the call graph for this function:

setSoundSpeed()

void PhaseUEqTotEnergy::setSoundSpeed ( double soundSpeed )

overridevirtual

Reimplemented from Phase.

setTotalEnergy() [1/2]

void PhaseUEqTotEnergy::setTotalEnergy ( const double & energy, const Coord & vel )

overridevirtual

Reimplemented from Phase.

Here is the call graph for this function:

setTotalEnergy() [2/2]

void PhaseUEqTotEnergy::setTotalEnergy ( double totalEnergy )

overridevirtual

Reimplemented from Phase.

setToZero()

void PhaseUEqTotEnergy::setToZero ( )

overridevirtual

Reimplemented from Phase.

setU()

void PhaseUEqTotEnergy::setU ( const double & )

inlineoverridevirtual

Reimplemented from Phase.

setV()

void PhaseUEqTotEnergy::setV ( const double & )

inlineoverridevirtual

Reimplemented from Phase.

setVelocity() [1/2]

void PhaseUEqTotEnergy::setVelocity ( const Coord & )

inlineoverridevirtual

Reimplemented from Phase.

setVelocity() [2/2]

void PhaseUEqTotEnergy::setVelocity ( const double & , const double & , const double &  )

inlineoverridevirtual

Reimplemented from Phase.

setW()

void PhaseUEqTotEnergy::setW ( const double & )

inlineoverridevirtual

Reimplemented from Phase.

verifyAndCorrectDensityMax() [1/2]

void PhaseUEqTotEnergy::verifyAndCorrectDensityMax ( )

overridevirtual

Reimplemented from Phase.

verifyAndCorrectDensityMax() [2/2]

void PhaseUEqTotEnergy::verifyAndCorrectDensityMax ( const double & mass )

overridevirtual

Reimplemented from Phase.

verifyAndCorrectPhase()

void PhaseUEqTotEnergy::verifyAndCorrectPhase ( )

overridevirtual

Reimplemented from Phase.

verifyPhase()

void PhaseUEqTotEnergy::verifyPhase ( const std::string & message = "" ) const

overridevirtual

Reimplemented from Phase.

Member Data Documentation

m_alpha

double PhaseUEqTotEnergy::m_alpha

protected

phase volume fraction

m_density

double PhaseUEqTotEnergy::m_density

protected

phase specific mass

m_eos

Eos* PhaseUEqTotEnergy::m_eos

protected

pointer to phase equation of state

m_pressure

double PhaseUEqTotEnergy::m_pressure

protected

phase pressure

m_soundSpeed

double PhaseUEqTotEnergy::m_soundSpeed

protected

phase speed of sound

m_temperature

double PhaseUEqTotEnergy::m_temperature

protected

phase temperature

m_totEnergy

double PhaseUEqTotEnergy::m_totEnergy

protected

phase specific total energy

m_Y

double PhaseUEqTotEnergy::m_Y

protected

phase mass fraction

---

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

• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Models/UEqTotEnergy/PhaseUEqTotEnergy.h
• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Models/UEqTotEnergy/PhaseUEqTotEnergy.cpp