Lagrangian Particle Code for The Simulation of 2D/3D Fluid Dynamics
 All Classes Files Functions Variables Typedefs Friends Pages
Public Member Functions | Protected Attributes | List of all members
EOS Class Referenceabstract

An abstract class for the calculation of energy and sound speed based on different EOS models. More...

#include <eos.h>

Inheritance diagram for EOS:
PolytropicGasEOS StiffPolytropicGasEOS

Public Member Functions

virtual ~EOS ()
 Destructor.
 
int getEOSChoice ()
 Getter function of the protected data member m_iEOSChoice.
 
virtual void getParameters (std::vector< double > &params)=0
 Getter function of all the parameters specified in the construtor argument list. More...
 
virtual double getEnergy (double pressure, double density)=0
 Calculates energy based on this EOS and the input pressure and density values. More...
 
virtual double getSoundSpeed (double pressure, double density)=0
 Calculates sound speed based on this EOS and the input pressure and density values. More...
 

Protected Attributes

int m_iEOSChoice
 The eos choice: 1=Polytropic gas; 2=Stiffened Polytropic gas.
 

Detailed Description

An abstract class for the calculation of energy and sound speed based on different EOS models.

Author
Chen, Hsin-Chiang (morri.nosp@m.sche.nosp@m.n2008.nosp@m.@gma.nosp@m.il.co.nosp@m.m)

Co-author: Yu, Kwangmin (yukwa.nosp@m.ngmi.nosp@m.n@gma.nosp@m.il.c.nosp@m.om) on initial interface design

Version
1.0
Date
2014/05/09

Created on: 2014/05/01

Member Function Documentation

virtual double EOS::getEnergy ( double  pressure,
double  density 
)
pure virtual

Calculates energy based on this EOS and the input pressure and density values.

Parameters
[in]pressurethe input pressure value
[in]densitythe input density value
Returns
the calculated energy value

Implemented in StiffPolytropicGasEOS, and PolytropicGasEOS.

virtual void EOS::getParameters ( std::vector< double > &  params)
pure virtual

Getter function of all the parameters specified in the construtor argument list.

Parameters
[out]paramsAll the parameters of this EOS
Returns
None

Implemented in StiffPolytropicGasEOS, and PolytropicGasEOS.

virtual double EOS::getSoundSpeed ( double  pressure,
double  density 
)
pure virtual

Calculates sound speed based on this EOS and the input pressure and density values.

Parameters
[in]pressurethe input pressure value
[in]densitythe input density value
Returns
the calculated sound speed value

Implemented in StiffPolytropicGasEOS, and PolytropicGasEOS.


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