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
PolytropicGasEOS Class Reference

Calculates energy and sound speed based on the Polytropic gas eos model. More...

#include <eos.h>

Inheritance diagram for PolytropicGasEOS:
EOS

Public Member Functions

 PolytropicGasEOS (double gamma)
 Constructor. More...
 
virtual void getParameters (std::vector< double > &params)
 Getter function of all the parameters specified in the construtor argument list. More...
 
virtual double getEnergy (double pressure, double density)
 Calculates energy based on the Polytropic gas eos and the input pressure and density values. More...
 
virtual double getSoundSpeed (double pressure, double density)
 Calculates sound speed based on the Polytropic gas eos and the input pressure and density values. More...
 
- Public Member Functions inherited from EOS
virtual ~EOS ()
 Destructor.
 
int getEOSChoice ()
 Getter function of the protected data member m_iEOSChoice.
 

Protected Attributes

double m_fGamma
 The parameter gamma.
 
- Protected Attributes inherited from EOS
int m_iEOSChoice
 The eos choice: 1=Polytropic gas; 2=Stiffened Polytropic gas.
 

Detailed Description

Calculates energy and sound speed based on the Polytropic gas eos model.

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

Constructor & Destructor Documentation

PolytropicGasEOS::PolytropicGasEOS ( double  gamma)
inline

Constructor.

Parameters
[in]gammaThe parameter gamma

Member Function Documentation

double PolytropicGasEOS::getEnergy ( double  pressure,
double  density 
)
virtual

Calculates energy based on the Polytropic gas eos and the input pressure and density values.

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

Implements EOS.

virtual void PolytropicGasEOS::getParameters ( std::vector< double > &  params)
inlinevirtual

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

Parameters
[out]paramsthe params vector contains m_fGamma
Returns
None

Implements EOS.

double PolytropicGasEOS::getSoundSpeed ( double  pressure,
double  density 
)
virtual

Calculates sound speed based on the Polytropic gas 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

Implements EOS.


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