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

Abstract class for a phase. More...

#include <Phase.h>

Inherited by PhaseEuler, PhaseEulerHomogeneous, PhaseEulerKorteweg, PhasePTUEq, PhaseUEq, and PhaseUEqTotEnergy.

Public Member Functions

 Phase ()
 
virtual ~Phase ()
 
void printPhase (std::ofstream &fileStream) const
 Print phase variables in file stream.
 
virtual void allocateAndCopyPhase (Phase **)
 Copy phase attributes in phase.
 
virtual void copyPhase (Phase &)
 Copy phase in phase attributes.
 
virtual void extendedCalculusPhase (const Coord &)
 Compute extra thermodynammical variables.
 
virtual void computeMassFraction (const double &)
 
virtual void localProjection (const Coord &, const Coord &, const Coord &)
 
virtual void reverseProjection (const Coord &, const Coord &, const Coord &)
 
virtual int getNumberScalars () const
 
virtual int getNumberVectors () const
 
virtual double returnScalar (const int &) const
 
virtual Coord returnVector (const int &) const
 
virtual std::string returnNameScalar (const int &) const
 
virtual std::string returnNameVector (const int &) const
 
virtual void setScalar (const int &, const double &)
 
virtual void setVector (const int &, const Coord &)
 
virtual int numberOfTransmittedVariables () const
 
virtual void fillBuffer (double *, int &) const
 
virtual void fillBuffer (std::vector< double > &) const
 
virtual void getBuffer (double *, int &, Eos **)
 
virtual void getBuffer (std::vector< double > &, int &, Eos **)
 
virtual void computeSlopesPhase (const Phase &, const Phase &, const double &)
 
virtual void setToZero ()
 
virtual void setToMax ()
 
virtual void extrapolate (const Phase &, const double &)
 
virtual void limitSlopes (const Phase &, const Phase &, Limiter &, Limiter &)
 
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 int numberOfTransmittedSlopes () const
 
virtual void fillBufferSlopes (double *, int &) const
 
virtual void getBufferSlopes (double *, int &)
 
virtual double getSquareLongitudinalWaveSpeed () const
 
virtual void verifyPhase (const std::string &="") const
 
virtual void verifyAndCorrectPhase ()
 
virtual void verifyAndCorrectDensityMax (const double &)
 
virtual void verifyAndCorrectDensityMax ()
 
virtual const double & getAlpha () const
 
virtual const double & getMassFraction () const
 
virtual const double & getDensity () const
 
virtual const double & getOmega () const
 
virtual const double & getEta () const
 
virtual const double & getPressure () const
 
virtual const double & getY () const
 
virtual const double & getU () const
 
virtual const double & getV () const
 
virtual const double & getW () const
 
virtual CoordgetVelocity ()
 
virtual const CoordgetVelocity () const
 
virtual const double & getVectorPX () const
 
virtual const double & getVectorPY () const
 
virtual const double & getVectorPZ () const
 
virtual CoordgetVectorP ()
 
virtual const CoordgetVectorP () const
 
virtual EosgetEos () 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 TensorgetCobase () const
 
virtual TensorgetCobase ()
 
virtual const double & getEnergyElastic () const
 
virtual const TensorgetStressTensor () const
 
virtual TensorgetStressTensor ()
 
virtual void setAlpha (double)
 
virtual void setDensity (double)
 
virtual void setOmega (const double &)
 
virtual void setEta (const double &)
 
virtual void setPressure (double)
 
virtual void setVelocity (const double &, const double &, const double &)
 
virtual void setVelocity (const Coord &)
 
virtual void setU (const double &)
 
virtual void setV (const double &)
 
virtual void setW (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 setEos (Eos *)
 
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 &)
 
virtual void changeSign ()
 
virtual void multiplyAndAdd (const Phase &, const double &)
 
virtual void divide (const double &)
 

Detailed Description

Abstract class for a phase.

Can not be instanciated, variables depend on the model

Constructor & Destructor Documentation

◆ Phase()

Phase::Phase ( )

◆ ~Phase()

Phase::~Phase ( )
virtual

Member Function Documentation

◆ allocateAndCopyPhase()

virtual void Phase::allocateAndCopyPhase ( Phase **  )
inlinevirtual

Copy phase attributes in phase.

Parameters
vecPhasedestination phase variable

Reimplemented in PhaseEuler, PhaseEulerHomogeneous, PhaseEulerKorteweg, PhaseNonLinearSchrodinger, PhasePTUEq, PhasePUEq, PhaseUEq, and PhaseUEqTotEnergy.

◆ changeSign()

virtual void Phase::changeSign ( )
inlinevirtual

◆ computeGradientLimiter()

virtual void Phase::computeGradientLimiter ( const Limiter ,
const Phase ,
const Phase ,
const Phase ,
const Phase  
)
inlinevirtual

◆ computeMassFraction()

virtual void Phase::computeMassFraction ( const double &  )
inlinevirtual

◆ computeSlopesPhase()

virtual void Phase::computeSlopesPhase ( const Phase ,
const Phase ,
const double &   
)
inlinevirtual

◆ copyPhase()

virtual void Phase::copyPhase ( Phase )
inlinevirtual

Copy phase in phase attributes.

Parameters
vecPhasesource phase to copy

Reimplemented in PhaseUEq, PhaseUEqTotEnergy, PhaseEuler, PhaseEulerHomogeneous, PhaseEulerKorteweg, and PhasePTUEq.

◆ divide()

virtual void Phase::divide ( const double &  )
inlinevirtual

◆ extendedCalculusPhase()

virtual void Phase::extendedCalculusPhase ( const Coord )
inlinevirtual

Compute extra thermodynammical variables.

Computes from velocity, pressure and density

Parameters
velocityphase velocity

Reimplemented in PhaseEuler, PhaseEulerKorteweg, PhaseUEq, PhaseEulerHomogeneous, PhasePTUEq, and PhaseUEqTotEnergy.

◆ extrapolate()

virtual void Phase::extrapolate ( const Phase ,
const double &   
)
inlinevirtual

◆ fillBuffer() [1/2]

virtual void Phase::fillBuffer ( double *  ,
int &   
) const
inlinevirtual

◆ fillBuffer() [2/2]

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

◆ fillBufferSlopes()

virtual void Phase::fillBufferSlopes ( double *  ,
int &   
) const
inlinevirtual

◆ getAlpha()

virtual const double & Phase::getAlpha ( ) const
inlinevirtual

◆ getBuffer() [1/2]

virtual void Phase::getBuffer ( double *  ,
int &  ,
Eos **   
)
inlinevirtual

◆ getBuffer() [2/2]

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

◆ getBufferSlopes()

virtual void Phase::getBufferSlopes ( double *  ,
int &   
)
inlinevirtual

◆ getCobase() [1/2]

virtual Tensor & Phase::getCobase ( )
inlinevirtual

◆ getCobase() [2/2]

virtual const Tensor & Phase::getCobase ( ) const
inlinevirtual

◆ getDensity()

virtual const double & Phase::getDensity ( ) const
inlinevirtual

◆ getEnergy()

virtual const double & Phase::getEnergy ( ) const
inlinevirtual

◆ getEnergyCompaction()

virtual const double & Phase::getEnergyCompaction ( ) const
inlinevirtual

◆ getEnergyElastic()

virtual const double & Phase::getEnergyElastic ( ) const
inlinevirtual

◆ getEos()

virtual Eos * Phase::getEos ( ) const
inlinevirtual

◆ getEta()

virtual const double & Phase::getEta ( ) const
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ getLambda()

virtual const double & Phase::getLambda ( ) const
inlinevirtual

◆ getMassFraction()

virtual const double & Phase::getMassFraction ( ) const
inlinevirtual

◆ getNumberScalars()

virtual int Phase::getNumberScalars ( ) const
inlinevirtual

◆ getNumberVectors()

virtual int Phase::getNumberVectors ( ) const
inlinevirtual

◆ getOmega()

virtual const double & Phase::getOmega ( ) const
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ getPressure()

virtual const double & Phase::getPressure ( ) const
inlinevirtual

◆ getSoundSpeed()

virtual const double & Phase::getSoundSpeed ( ) const
inlinevirtual

◆ getSquareLongitudinalWaveSpeed()

virtual double Phase::getSquareLongitudinalWaveSpeed ( ) const
inlinevirtual

◆ getStressTensor() [1/2]

virtual Tensor & Phase::getStressTensor ( )
inlinevirtual

◆ getStressTensor() [2/2]

virtual const Tensor & Phase::getStressTensor ( ) const
inlinevirtual

◆ getTemperature()

virtual double Phase::getTemperature ( ) const
inlinevirtual

◆ getTotalEnergy()

virtual const double & Phase::getTotalEnergy ( ) const
inlinevirtual

◆ getU()

virtual const double & Phase::getU ( ) const
inlinevirtual

◆ getV()

virtual const double & Phase::getV ( ) const
inlinevirtual

◆ getVectorP() [1/2]

virtual Coord & Phase::getVectorP ( )
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ getVectorP() [2/2]

virtual const Coord & Phase::getVectorP ( ) const
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ getVectorPX()

virtual const double & Phase::getVectorPX ( ) const
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ getVectorPY()

virtual const double & Phase::getVectorPY ( ) const
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ getVectorPZ()

virtual const double & Phase::getVectorPZ ( ) const
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ getVelocity() [1/2]

virtual Coord & Phase::getVelocity ( )
inlinevirtual

◆ getVelocity() [2/2]

virtual const Coord & Phase::getVelocity ( ) const
inlinevirtual

◆ getW()

virtual const double & Phase::getW ( ) const
inlinevirtual

◆ getY()

virtual const double & Phase::getY ( ) const
inlinevirtual

◆ limitSlopes()

virtual void Phase::limitSlopes ( const Phase ,
const Phase ,
Limiter ,
Limiter  
)
inlinevirtual

◆ localProjection()

virtual void Phase::localProjection ( const Coord ,
const Coord ,
const Coord  
)
inlinevirtual

◆ multiplyAndAdd()

virtual void Phase::multiplyAndAdd ( const Phase ,
const double &   
)
inlinevirtual

◆ numberOfTransmittedSlopes()

virtual int Phase::numberOfTransmittedSlopes ( ) const
inlinevirtual

◆ numberOfTransmittedVariables()

virtual int Phase::numberOfTransmittedVariables ( ) const
inlinevirtual

◆ printPhase()

void Phase::printPhase ( std::ofstream &  fileStream) const

Print phase variables in file stream.

Parameters
fileStreamfile stream to write in

◆ returnNameScalar()

virtual std::string Phase::returnNameScalar ( const int &  ) const
inlinevirtual

◆ returnNameVector()

virtual std::string Phase::returnNameVector ( const int &  ) const
inlinevirtual

◆ returnScalar()

virtual double Phase::returnScalar ( const int &  ) const
inlinevirtual

◆ returnVector()

virtual Coord Phase::returnVector ( const int &  ) const
inlinevirtual

◆ reverseProjection()

virtual void Phase::reverseProjection ( const Coord ,
const Coord ,
const Coord  
)
inlinevirtual

◆ setAlpha()

virtual void Phase::setAlpha ( double  )
inlinevirtual

◆ setCobase()

virtual void Phase::setCobase ( const Tensor )
inlinevirtual

◆ setDensity()

virtual void Phase::setDensity ( double  )
inlinevirtual

◆ setEnergy()

virtual void Phase::setEnergy ( double  )
inlinevirtual

◆ setEnergyCompaction()

virtual void Phase::setEnergyCompaction ( double  )
inlinevirtual

◆ setEnergyElastic()

virtual void Phase::setEnergyElastic ( double  )
inlinevirtual

◆ setEos()

virtual void Phase::setEos ( Eos )
inlinevirtual

◆ setEta()

virtual void Phase::setEta ( const double &  )
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ setLambda()

virtual void Phase::setLambda ( double  )
inlinevirtual

◆ setMax()

virtual void Phase::setMax ( const Phase ,
const Phase  
)
inlinevirtual

◆ setMin()

virtual void Phase::setMin ( const Phase ,
const Phase  
)
inlinevirtual

◆ setOmega()

virtual void Phase::setOmega ( const double &  )
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ setPressure()

virtual void Phase::setPressure ( double  )
inlinevirtual

◆ setScalar()

virtual void Phase::setScalar ( const int &  ,
const double &   
)
inlinevirtual

◆ setSoundSpeed()

virtual void Phase::setSoundSpeed ( double  )
inlinevirtual

◆ setStressTensor()

virtual void Phase::setStressTensor ( const Tensor )
inlinevirtual

◆ setTemperature()

virtual void Phase::setTemperature ( double  )
inlinevirtual

Reimplemented in PhaseEuler.

◆ setToMax()

virtual void Phase::setToMax ( )
inlinevirtual

◆ setTotalEnergy() [1/2]

virtual void Phase::setTotalEnergy ( const double &  ,
const Coord  
)
inlinevirtual

Reimplemented in PhaseUEqTotEnergy.

◆ setTotalEnergy() [2/2]

virtual void Phase::setTotalEnergy ( double  )
inlinevirtual

◆ setToZero()

virtual void Phase::setToZero ( )
inlinevirtual

◆ setU()

virtual void Phase::setU ( const double &  )
inlinevirtual

◆ setV()

virtual void Phase::setV ( const double &  )
inlinevirtual

◆ setVector()

virtual void Phase::setVector ( const int &  ,
const Coord  
)
inlinevirtual

Reimplemented in PhaseEuler, and PhaseEulerKorteweg.

◆ setVectorP() [1/2]

virtual void Phase::setVectorP ( const Coord )
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ setVectorP() [2/2]

virtual void Phase::setVectorP ( const double &  ,
const double &  ,
const double &   
)
inlinevirtual

Reimplemented in PhaseEulerKorteweg.

◆ setVelocity() [1/2]

virtual void Phase::setVelocity ( const Coord )
inlinevirtual

◆ setVelocity() [2/2]

virtual void Phase::setVelocity ( const double &  ,
const double &  ,
const double &   
)
inlinevirtual

◆ setW()

virtual void Phase::setW ( const double &  )
inlinevirtual

◆ setX()

virtual void Phase::setX ( const double &  )
inlinevirtual

◆ setY()

virtual void Phase::setY ( const double &  )
inlinevirtual

◆ setZ()

virtual void Phase::setZ ( const double &  )
inlinevirtual

◆ verifyAndCorrectDensityMax() [1/2]

virtual void Phase::verifyAndCorrectDensityMax ( )
inlinevirtual

◆ verifyAndCorrectDensityMax() [2/2]

virtual void Phase::verifyAndCorrectDensityMax ( const double &  )
inlinevirtual

◆ verifyAndCorrectPhase()

virtual void Phase::verifyAndCorrectPhase ( )
inlinevirtual

◆ verifyPhase()

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

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