Phase variables for Augmented Euler–Korteweg equations (single phase) More...

#include <PhaseEulerKorteweg.h>

Inherits Phase.

Public Member Functions
	PhaseEulerKorteweg ()

	PhaseEulerKorteweg (tinyxml2::XMLElement material, Eos eos, std::string fileName)
	Phase constructor from a XML format reading.

virtual	~PhaseEulerKorteweg ()

virtual void	allocateAndCopyPhase (Phase **vecPhase)
	Copy phase attributes in phase.

virtual void	copyPhase (Phase &vecPhase)
	Copy phase in phase attributes.

virtual void	extendedCalculusPhase (const Coord &)
	Compute extra thermodynammical variables.

virtual void	localProjection (const Coord &normal, const Coord &tangent, const Coord &binormal)

virtual void	reverseProjection (const Coord &normal, const Coord &tangent, const Coord &binormal)

virtual int	getNumberScalars () const

virtual int	getNumberVectors () const

virtual double	returnScalar (const int &numVar) const

virtual Coord	returnVector (const int &numVar) const

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

virtual std::string	returnNameVector (const int &numVar) const

virtual void	setScalar (const int &numVar, const double &value)

virtual void	setVector (const int &numVar, const Coord &value)

virtual int	numberOfTransmittedVariables () const

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

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

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

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

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

virtual void	setToZero ()

virtual void	extrapolate (const Phase &slope, const double &distance)

virtual void	limitSlopes (const Phase &slopeGauche, const Phase &slopeDroite, Limiter &globalLimiter, Limiter &)

virtual int	numberOfTransmittedSlopes () const

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

virtual void	getBufferSlopes (double *buffer, int &counter)

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

virtual void	verifyAndCorrectPhase ()

virtual void	verifyAndCorrectDensityMax ()

virtual const double &	getAlpha () const

virtual const double &	getDensity () const

virtual const double &	getOmega () const

virtual const double &	getEta () const

virtual const double &	getPressure () const

virtual const double &	getU () const

virtual const double &	getV () const

virtual const double &	getW () const

virtual Coord &	getVelocity ()

virtual const Coord &	getVelocity () 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 Eos *	getEos () const

virtual void	setDensity (double density)

virtual void	setOmega (const double &omega)

virtual void	setEta (const double &eta)

virtual void	setPressure (double pressure)

virtual void	setVelocity (const double &u, const double &v, const double &w)

virtual void	setVelocity (const Coord &vit)

virtual void	setU (const double &u)

virtual void	setV (const double &v)

virtual void	setW (const double &w)

virtual void	setVectorP (const double &Px, const double &Py, const double &Pz)

virtual void	setVectorP (const Coord &vecP)

virtual void	setVectorPX (const double &Px)

virtual void	setVectorPY (const double &Py)

virtual void	setVectorPZ (const double &Pz)

virtual void	setEos (Eos *eos)

virtual void	changeSign ()

virtual void	multiplyAndAdd (const Phase &slopesPhasesTemp, const double &coeff)

virtual void	divide (const double &coeff)

Public Member Functions inherited from Phase
	Phase ()

virtual	~Phase ()

void	printPhase (std::ofstream &fileStream) const
	Print phase variables in file stream.

virtual void	computeMassFraction (const double &)

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 void	verifyAndCorrectDensityMax (const double &)

virtual const double &	getMassFraction () const

virtual const double &	getY () const

virtual const double &	getEnergy () const

virtual const double &	getSoundSpeed () const

virtual const double &	getTotalEnergy () const

virtual double	getTemperature () 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	setAlpha (double)

virtual void	setX (const double &)

virtual void	setY (const double &)

virtual void	setZ (const double &)

virtual void	setEnergy (double)

virtual void	setSoundSpeed (double)

virtual void	setTotalEnergy (double)

virtual void	setTotalEnergy (const double &, const Coord &)

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_density
	Specific mass.

double	m_omega
	Time derivative of eta.

double	m_eta
	Analogue of density.

double	m_pressure
	Pressure, so far it is only for information.

Coord	m_velocity
	Velocity.

Coord	m_vectorP
	Gradient of eta.

Eos *	m_eos
	Pointer to equation of state.

Detailed Description

Phase variables for Augmented Euler–Korteweg equations (single phase)

Constructor & Destructor Documentation

◆ PhaseEulerKorteweg() [1/2]

PhaseEulerKorteweg::PhaseEulerKorteweg ( )

◆ PhaseEulerKorteweg() [2/2]

PhaseEulerKorteweg::PhaseEulerKorteweg	(	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 density = "10.0"> <velocity x = "1000." y = "1000." z = "0." / > </dataFluid>

Parameters

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

◆ ~PhaseEulerKorteweg()

PhaseEulerKorteweg::~PhaseEulerKorteweg ( )

virtual

Member Function Documentation

◆ allocateAndCopyPhase()

void PhaseEulerKorteweg::allocateAndCopyPhase ( Phase ** )

virtual

Copy phase attributes in phase.

Parameters

vecPhase destination phase variable

Reimplemented from Phase.

Reimplemented in PhaseNonLinearSchrodinger.

◆ changeSign()

void PhaseEulerKorteweg::changeSign ( )

virtual

Reimplemented from Phase.

◆ computeSlopesPhase()

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

virtual

Reimplemented from Phase.

◆ copyPhase()

void PhaseEulerKorteweg::copyPhase ( Phase & )

virtual

Copy phase in phase attributes.

Parameters

vecPhase source phase to copy

Reimplemented from Phase.

◆ divide()

void PhaseEulerKorteweg::divide ( const double & coeff )

virtual

Reimplemented from Phase.

◆ extendedCalculusPhase()

virtual void PhaseEulerKorteweg::extendedCalculusPhase ( const Coord & )

inlinevirtual

Compute extra thermodynammical variables.

Computes from velocity, pressure and density

Parameters

velocity phase velocity

Reimplemented from Phase.

◆ extrapolate()

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

virtual

Reimplemented from Phase.

◆ fillBuffer() [1/2]

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

virtual

Reimplemented from Phase.

Reimplemented in PhaseNonLinearSchrodinger.

◆ fillBuffer() [2/2]

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

virtual

Reimplemented from Phase.

Reimplemented in PhaseNonLinearSchrodinger.

◆ fillBufferSlopes()

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

virtual

Reimplemented from Phase.

◆ getAlpha()

virtual const double & PhaseEulerKorteweg::getAlpha ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getBuffer() [1/2]

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

virtual

Reimplemented from Phase.

Reimplemented in PhaseNonLinearSchrodinger.

◆ getBuffer() [2/2]

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

virtual

Reimplemented from Phase.

Reimplemented in PhaseNonLinearSchrodinger.

◆ getBufferSlopes()

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

virtual

Reimplemented from Phase.

◆ getDensity()

virtual const double & PhaseEulerKorteweg::getDensity ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getEos()

virtual Eos * PhaseEulerKorteweg::getEos ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getEta()

virtual const double & PhaseEulerKorteweg::getEta ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getNumberScalars()

virtual int PhaseEulerKorteweg::getNumberScalars ( ) const

inlinevirtual

Reimplemented from Phase.

Reimplemented in PhaseNonLinearSchrodinger.

◆ getNumberVectors()

virtual int PhaseEulerKorteweg::getNumberVectors ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getOmega()

virtual const double & PhaseEulerKorteweg::getOmega ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getPressure()

virtual const double & PhaseEulerKorteweg::getPressure ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getU()

virtual const double & PhaseEulerKorteweg::getU ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getV()

virtual const double & PhaseEulerKorteweg::getV ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getVectorP() [1/2]

virtual Coord & PhaseEulerKorteweg::getVectorP ( )

inlinevirtual

Reimplemented from Phase.

◆ getVectorP() [2/2]

virtual const Coord & PhaseEulerKorteweg::getVectorP ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getVectorPX()

virtual const double & PhaseEulerKorteweg::getVectorPX ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getVectorPY()

virtual const double & PhaseEulerKorteweg::getVectorPY ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getVectorPZ()

virtual const double & PhaseEulerKorteweg::getVectorPZ ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getVelocity() [1/2]

virtual Coord & PhaseEulerKorteweg::getVelocity ( )

inlinevirtual

Reimplemented from Phase.

◆ getVelocity() [2/2]

virtual const Coord & PhaseEulerKorteweg::getVelocity ( ) const

inlinevirtual

Reimplemented from Phase.

◆ getW()

virtual const double & PhaseEulerKorteweg::getW ( ) const

inlinevirtual

Reimplemented from Phase.

◆ limitSlopes()

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

virtual

Reimplemented from Phase.

◆ localProjection()

void PhaseEulerKorteweg::localProjection	(	const Coord &	normal,
		const Coord &	tangent,
		const Coord &	binormal
	)

virtual

Reimplemented from Phase.

◆ multiplyAndAdd()

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

virtual

Reimplemented from Phase.

◆ numberOfTransmittedSlopes()

int PhaseEulerKorteweg::numberOfTransmittedSlopes ( ) const

virtual

Reimplemented from Phase.

◆ numberOfTransmittedVariables()

int PhaseEulerKorteweg::numberOfTransmittedVariables ( ) const

virtual

Reimplemented from Phase.

Reimplemented in PhaseNonLinearSchrodinger.

◆ returnNameScalar()

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

virtual

Reimplemented from Phase.

◆ returnNameVector()

std::string PhaseEulerKorteweg::returnNameVector ( const int & numVar ) const

virtual

Reimplemented from Phase.

◆ returnScalar()

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

virtual

Reimplemented from Phase.

◆ returnVector()

Coord PhaseEulerKorteweg::returnVector ( const int & numVar ) const

virtual

Reimplemented from Phase.

◆ reverseProjection()

void PhaseEulerKorteweg::reverseProjection	(	const Coord &	normal,
		const Coord &	tangent,
		const Coord &	binormal
	)

virtual

Reimplemented from Phase.

◆ setDensity()

void PhaseEulerKorteweg::setDensity ( double density )

virtual

Reimplemented from Phase.

◆ setEos()

void PhaseEulerKorteweg::setEos ( Eos * eos )

virtual

Reimplemented from Phase.

◆ setEta()

void PhaseEulerKorteweg::setEta ( const double & eta )

virtual

Reimplemented from Phase.

◆ setOmega()

void PhaseEulerKorteweg::setOmega ( const double & omega )

virtual

Reimplemented from Phase.

◆ setPressure()

void PhaseEulerKorteweg::setPressure ( double pressure )

virtual

Reimplemented from Phase.

◆ setScalar()

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

virtual

Reimplemented from Phase.

◆ setToZero()

void PhaseEulerKorteweg::setToZero ( )

virtual

Reimplemented from Phase.

◆ setU()

void PhaseEulerKorteweg::setU ( const double & u )

virtual

Reimplemented from Phase.

◆ setV()

void PhaseEulerKorteweg::setV ( const double & v )

virtual

Reimplemented from Phase.

◆ setVector()

void PhaseEulerKorteweg::setVector	(	const int &	numVar,
		const Coord &	value
	)

virtual

Reimplemented from Phase.

◆ setVectorP() [1/2]

void PhaseEulerKorteweg::setVectorP ( const Coord & vecP )

virtual

Reimplemented from Phase.

◆ setVectorP() [2/2]

void PhaseEulerKorteweg::setVectorP	(	const double &	Px,
		const double &	Py,
		const double &	Pz
	)

virtual

Reimplemented from Phase.

◆ setVectorPX()

void PhaseEulerKorteweg::setVectorPX ( const double & Px )

virtual

◆ setVectorPY()

void PhaseEulerKorteweg::setVectorPY ( const double & Py )

virtual

◆ setVectorPZ()

void PhaseEulerKorteweg::setVectorPZ ( const double & Pz )

virtual

◆ setVelocity() [1/2]

void PhaseEulerKorteweg::setVelocity ( const Coord & vit )

virtual

Reimplemented from Phase.

◆ setVelocity() [2/2]

void PhaseEulerKorteweg::setVelocity	(	const double &	u,
		const double &	v,
		const double &	w
	)

virtual

Reimplemented from Phase.

◆ setW()

void PhaseEulerKorteweg::setW ( const double & w )

virtual

Reimplemented from Phase.

◆ verifyAndCorrectDensityMax()

void PhaseEulerKorteweg::verifyAndCorrectDensityMax ( )

virtual

Reimplemented from Phase.

Reimplemented in PhaseNonLinearSchrodinger.

◆ verifyAndCorrectPhase()

void PhaseEulerKorteweg::verifyAndCorrectPhase ( )

virtual

Reimplemented from Phase.

◆ verifyPhase()

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

virtual

Reimplemented from Phase.

Member Data Documentation

◆ m_density

double PhaseEulerKorteweg::m_density

protected

Specific mass.

◆ m_eos

Eos* PhaseEulerKorteweg::m_eos

protected

Pointer to equation of state.

◆ m_eta

double PhaseEulerKorteweg::m_eta

protected

Analogue of density.

◆ m_omega

double PhaseEulerKorteweg::m_omega

protected

Time derivative of eta.

◆ m_pressure

double PhaseEulerKorteweg::m_pressure

protected

Pressure, so far it is only for information.

◆ m_vectorP

Coord PhaseEulerKorteweg::m_vectorP

protected

Gradient of eta.

◆ m_velocity

Coord PhaseEulerKorteweg::m_velocity

protected

Velocity.

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

/Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Models/EulerKorteweg/PhaseEulerKorteweg.h
/Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Models/EulerKorteweg/PhaseEulerKorteweg.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PhaseEulerKorteweg() [1/2]

◆ PhaseEulerKorteweg() [2/2]

◆ ~PhaseEulerKorteweg()

Member Function Documentation

◆ allocateAndCopyPhase()

◆ changeSign()

◆ computeSlopesPhase()

◆ copyPhase()

◆ divide()

◆ extendedCalculusPhase()

◆ extrapolate()

◆ fillBuffer() [1/2]

◆ fillBuffer() [2/2]

◆ fillBufferSlopes()

◆ getAlpha()

◆ getBuffer() [1/2]

◆ getBuffer() [2/2]

◆ getBufferSlopes()

◆ getDensity()

◆ getEos()

◆ getEta()

◆ getNumberScalars()

◆ getNumberVectors()

◆ getOmega()

◆ getPressure()

◆ getU()

◆ getV()

◆ getVectorP() [1/2]

◆ getVectorP() [2/2]

◆ getVectorPX()

◆ getVectorPY()

◆ getVectorPZ()

◆ getVelocity() [1/2]

◆ getVelocity() [2/2]

◆ getW()

◆ limitSlopes()

◆ localProjection()

◆ multiplyAndAdd()

◆ numberOfTransmittedSlopes()

◆ numberOfTransmittedVariables()

◆ returnNameScalar()

◆ returnNameVector()

◆ returnScalar()

◆ returnVector()

◆ reverseProjection()

◆ setDensity()

◆ setEos()

◆ setEta()

◆ setOmega()

◆ setPressure()

◆ setScalar()

◆ setToZero()

◆ setU()

◆ setV()

◆ setVector()

◆ setVectorP() [1/2]

◆ setVectorP() [2/2]

◆ setVectorPX()

◆ setVectorPY()

◆ setVectorPZ()

◆ setVelocity() [1/2]

◆ setVelocity() [2/2]

◆ setW()

◆ verifyAndCorrectDensityMax()

◆ verifyAndCorrectPhase()

◆ verifyPhase()

Member Data Documentation

◆ m_density

◆ m_eos

◆ m_eta

◆ m_omega

◆ m_pressure

◆ m_vectorP

◆ m_velocity