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

#include <PhaseNonLinearSchrodinger.h>

Public Member Functions
	PhaseNonLinearSchrodinger ()

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

virtual	~PhaseNonLinearSchrodinger ()

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

virtual int	getNumberScalars () const

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 *)

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

virtual void	verifyAndCorrectDensityMax ()

Public Member Functions inherited from PhaseEulerKorteweg
	PhaseEulerKorteweg ()

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

virtual	~PhaseEulerKorteweg ()

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	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 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 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 &)

Additional Inherited Members
Protected Attributes inherited from PhaseEulerKorteweg
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

◆ PhaseNonLinearSchrodinger() [1/2]

PhaseNonLinearSchrodinger::PhaseNonLinearSchrodinger ( )

◆ PhaseNonLinearSchrodinger() [2/2]

PhaseNonLinearSchrodinger::PhaseNonLinearSchrodinger	(	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

◆ ~PhaseNonLinearSchrodinger()

PhaseNonLinearSchrodinger::~PhaseNonLinearSchrodinger ( )

virtual

Member Function Documentation

◆ allocateAndCopyPhase()

void PhaseNonLinearSchrodinger::allocateAndCopyPhase ( Phase ** )

virtual

Copy phase attributes in phase.

Parameters

vecPhase destination phase variable

Reimplemented from PhaseEulerKorteweg.

◆ fillBuffer() [1/2]

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

virtual

Reimplemented from PhaseEulerKorteweg.

◆ fillBuffer() [2/2]

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

virtual

Reimplemented from PhaseEulerKorteweg.

◆ getBuffer() [1/2]

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

virtual

Reimplemented from PhaseEulerKorteweg.

◆ getBuffer() [2/2]

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

virtual

Reimplemented from PhaseEulerKorteweg.

◆ getNumberScalars()

virtual int PhaseNonLinearSchrodinger::getNumberScalars ( ) const

inlinevirtual

Reimplemented from PhaseEulerKorteweg.

◆ numberOfTransmittedVariables()

int PhaseNonLinearSchrodinger::numberOfTransmittedVariables ( ) const

virtual

Reimplemented from PhaseEulerKorteweg.

◆ verifyAndCorrectDensityMax()

virtual void PhaseNonLinearSchrodinger::verifyAndCorrectDensityMax ( )

inlinevirtual

Reimplemented from PhaseEulerKorteweg.

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

/Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Models/NonLinearSchrodinger/PhaseNonLinearSchrodinger.h
/Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Models/NonLinearSchrodinger/PhaseNonLinearSchrodinger.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PhaseNonLinearSchrodinger() [1/2]

◆ PhaseNonLinearSchrodinger() [2/2]

◆ ~PhaseNonLinearSchrodinger()

Member Function Documentation

◆ allocateAndCopyPhase()

◆ fillBuffer() [1/2]

◆ fillBuffer() [2/2]

◆ getBuffer() [1/2]

◆ getBuffer() [2/2]

◆ getNumberScalars()

◆ numberOfTransmittedVariables()

◆ verifyAndCorrectDensityMax()