Nektar++
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Nektar::EquationOfState Class Referenceabstract

Encapsulates equations of state allowing us to obtain thermodynamic properties: most relations are in the form X(rho,e) More...

#include <EquationOfState.h>

Inheritance diagram for Nektar::EquationOfState:
[legend]

Public Member Functions

virtual ~EquationOfState ()=default
 
NekDouble GetTemperature (const NekDouble &rho, const NekDouble &e)
 Calculate the temperature. More...
 
vec_t GetTemperature (const vec_t &rho, const vec_t &e)
 
NekDouble GetPressure (const NekDouble &rho, const NekDouble &e)
 Calculate the pressure. More...
 
vec_t GetPressure (const vec_t &rho, const vec_t &e)
 
NekDouble GetSoundSpeed (const NekDouble &rho, const NekDouble &e)
 Calculate the sound speed. More...
 
NekDouble GetEntropy (const NekDouble &rho, const NekDouble &e)
 Calculate the entropy. More...
 
NekDouble GetDPDrho_e (const NekDouble &rho, const NekDouble &e)
 Calculate the partial derivative of P(rho,e) with respect to rho. More...
 
NekDouble GetDPDe_rho (const NekDouble &rho, const NekDouble &e)
 Calculate the partial derivative of P(rho,e) with respect to e. More...
 
NekDouble GetEFromRhoP (const NekDouble &rho, const NekDouble &p)
 Obtain the internal energy from rho and P. More...
 
NekDouble GetRhoFromPT (const NekDouble &p, const NekDouble &T)
 Obtain the density from P and T. More...
 

Protected Member Functions

 EquationOfState (const LibUtilities::SessionReaderSharedPtr &pSession)
 Constructor. More...
 
 EquationOfState (const NekDouble &gamma, const NekDouble &gasConstant)
 Programmatic Constructor. More...
 
virtual NekDouble v_GetTemperature (const NekDouble &rho, const NekDouble &e)=0
 
virtual vec_t v_GetTemperature (const vec_t &rho, const vec_t &e)=0
 
virtual NekDouble v_GetPressure (const NekDouble &rho, const NekDouble &e)=0
 
virtual vec_t v_GetPressure (const vec_t &rho, const vec_t &e)=0
 
virtual NekDouble v_GetSoundSpeed (const NekDouble &rho, const NekDouble &e)
 
virtual NekDouble v_GetEntropy (const NekDouble &rho, const NekDouble &e)=0
 
virtual NekDouble v_GetDPDrho_e (const NekDouble &rho, const NekDouble &e)=0
 
virtual NekDouble v_GetDPDe_rho (const NekDouble &rho, const NekDouble &e)=0
 
virtual NekDouble v_GetEFromRhoP (const NekDouble &rho, const NekDouble &p)=0
 
virtual NekDouble v_GetRhoFromPT (const NekDouble &rho, const NekDouble &p)=0
 

Protected Attributes

NekDouble m_gamma
 
NekDouble m_gasConstant
 
NekDouble m_gammaMone
 
NekDouble m_gammaMoneOgasConst
 

Detailed Description

Encapsulates equations of state allowing us to obtain thermodynamic properties: most relations are in the form X(rho,e)

Definition at line 67 of file EquationOfState.h.

Constructor & Destructor Documentation

◆ ~EquationOfState()

virtual Nektar::EquationOfState::~EquationOfState ( )
virtualdefault

◆ EquationOfState() [1/2]

Nektar::EquationOfState::EquationOfState ( const LibUtilities::SessionReaderSharedPtr &  pSession)
protected

Constructor.

Definition at line 45 of file EquationOfState.cpp.

47{
48 pSession->LoadParameter("Gamma", m_gamma, 1.4);
49 pSession->LoadParameter("GasConstant", m_gasConstant, 287.058);
50
51 m_gammaMone = m_gamma - 1.0;
52 m_gammaMoneOgasConst = m_gammaMone / m_gasConstant;
53}

References m_gamma, m_gammaMone, m_gammaMoneOgasConst, and m_gasConstant.

◆ EquationOfState() [2/2]

Nektar::EquationOfState::EquationOfState ( const NekDouble &  gamma,
const NekDouble &  gasConstant 
)
protected

Programmatic Constructor.

Definition at line 55 of file EquationOfState.cpp.

57 : m_gamma{gamma}, m_gasConstant{gasConstant}
58{
59}

Member Function Documentation

◆ GetDPDe_rho()

NekDouble Nektar::EquationOfState::GetDPDe_rho ( const NekDouble &  rho,
const NekDouble &  e 
)
inline

Calculate the partial derivative of P(rho,e) with respect to e.

Definition at line 113 of file EquationOfState.h.

114 {
115 return v_GetDPDe_rho(rho, e);
116 }
Nektar::EquationOfState::v_GetDPDe_rho
virtual NekDouble v_GetDPDe_rho(const NekDouble &rho, const NekDouble &e)=0

References v_GetDPDe_rho().

Referenced by Nektar::PengRobinsonEoS::v_GetDPDrho_e(), Nektar::RedlichKwongEoS::v_GetDPDrho_e(), and v_GetSoundSpeed().

◆ GetDPDrho_e()

NekDouble Nektar::EquationOfState::GetDPDrho_e ( const NekDouble &  rho,
const NekDouble &  e 
)
inline

Calculate the partial derivative of P(rho,e) with respect to rho.

Definition at line 107 of file EquationOfState.h.

108 {
109 return v_GetDPDrho_e(rho, e);
110 }
Nektar::EquationOfState::v_GetDPDrho_e
virtual NekDouble v_GetDPDrho_e(const NekDouble &rho, const NekDouble &e)=0

References v_GetDPDrho_e().

Referenced by v_GetSoundSpeed().

◆ GetEFromRhoP()

NekDouble Nektar::EquationOfState::GetEFromRhoP ( const NekDouble &  rho,
const NekDouble &  p 
)
inline

Obtain the internal energy from rho and P.

Definition at line 119 of file EquationOfState.h.

120 {
121 return v_GetEFromRhoP(rho, p);
122 }
Nektar::EquationOfState::v_GetEFromRhoP
virtual NekDouble v_GetEFromRhoP(const NekDouble &rho, const NekDouble &p)=0
CellMLToNektar.cellml_metadata.p
p
Definition: cellml_metadata.py:350

References CellMLToNektar.cellml_metadata::p, and v_GetEFromRhoP().

◆ GetEntropy()

NekDouble Nektar::EquationOfState::GetEntropy ( const NekDouble &  rho,
const NekDouble &  e 
)
inline

Calculate the entropy.

Definition at line 101 of file EquationOfState.h.

102 {
103 return v_GetEntropy(rho, e);
104 }
Nektar::EquationOfState::v_GetEntropy
virtual NekDouble v_GetEntropy(const NekDouble &rho, const NekDouble &e)=0

References v_GetEntropy().

◆ GetPressure() [1/2]

NekDouble Nektar::EquationOfState::GetPressure ( const NekDouble &  rho,
const NekDouble &  e 
)
inline

Calculate the pressure.

Definition at line 84 of file EquationOfState.h.

85 {
86 return v_GetPressure(rho, e);
87 }
Nektar::EquationOfState::v_GetPressure
virtual NekDouble v_GetPressure(const NekDouble &rho, const NekDouble &e)=0

References v_GetPressure().

Referenced by v_GetSoundSpeed().

◆ GetPressure() [2/2]

vec_t Nektar::EquationOfState::GetPressure ( const vec_t &  rho,
const vec_t &  e 
)
inline

Definition at line 89 of file EquationOfState.h.

90 {
91 return v_GetPressure(rho, e);
92 }

References v_GetPressure().

◆ GetRhoFromPT()

NekDouble Nektar::EquationOfState::GetRhoFromPT ( const NekDouble &  p,
const NekDouble &  T 
)
inline

Obtain the density from P and T.

Definition at line 125 of file EquationOfState.h.

126 {
127 return v_GetRhoFromPT(p, T);
128 }
Nektar::EquationOfState::v_GetRhoFromPT
virtual NekDouble v_GetRhoFromPT(const NekDouble &rho, const NekDouble &p)=0

References CellMLToNektar.cellml_metadata::p, and v_GetRhoFromPT().

◆ GetSoundSpeed()

NekDouble Nektar::EquationOfState::GetSoundSpeed ( const NekDouble &  rho,
const NekDouble &  e 
)
inline

Calculate the sound speed.

Definition at line 95 of file EquationOfState.h.

96 {
97 return v_GetSoundSpeed(rho, e);
98 }
Nektar::EquationOfState::v_GetSoundSpeed
virtual NekDouble v_GetSoundSpeed(const NekDouble &rho, const NekDouble &e)
Definition: EquationOfState.cpp:63

References v_GetSoundSpeed().

◆ GetTemperature() [1/2]

NekDouble Nektar::EquationOfState::GetTemperature ( const NekDouble &  rho,
const NekDouble &  e 
)
inline

Calculate the temperature.

Definition at line 73 of file EquationOfState.h.

74 {
75 return v_GetTemperature(rho, e);
76 }
Nektar::EquationOfState::v_GetTemperature
virtual NekDouble v_GetTemperature(const NekDouble &rho, const NekDouble &e)=0

References v_GetTemperature().

Referenced by Nektar::PengRobinsonEoS::v_GetDPDe_rho(), Nektar::RedlichKwongEoS::v_GetDPDe_rho(), Nektar::PengRobinsonEoS::v_GetDPDrho_e(), Nektar::RedlichKwongEoS::v_GetDPDrho_e(), Nektar::IdealGasEoS::v_GetEntropy(), Nektar::PengRobinsonEoS::v_GetEntropy(), Nektar::RedlichKwongEoS::v_GetEntropy(), Nektar::VanDerWaalsEoS::v_GetEntropy(), and Nektar::IdealGasEoS::v_GetSoundSpeed().

◆ GetTemperature() [2/2]

vec_t Nektar::EquationOfState::GetTemperature ( const vec_t &  rho,
const vec_t &  e 
)
inline

Definition at line 78 of file EquationOfState.h.

79 {
80 return v_GetTemperature(rho, e);
81 }

References v_GetTemperature().

◆ v_GetDPDe_rho()

virtual NekDouble Nektar::EquationOfState::v_GetDPDe_rho ( const NekDouble &  rho,
const NekDouble &  e 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

Referenced by GetDPDe_rho().

◆ v_GetDPDrho_e()

virtual NekDouble Nektar::EquationOfState::v_GetDPDrho_e ( const NekDouble &  rho,
const NekDouble &  e 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

Referenced by GetDPDrho_e().

◆ v_GetEFromRhoP()

virtual NekDouble Nektar::EquationOfState::v_GetEFromRhoP ( const NekDouble &  rho,
const NekDouble &  p 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

Referenced by GetEFromRhoP().

◆ v_GetEntropy()

virtual NekDouble Nektar::EquationOfState::v_GetEntropy ( const NekDouble &  rho,
const NekDouble &  e 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

Referenced by GetEntropy().

◆ v_GetPressure() [1/2]

virtual NekDouble Nektar::EquationOfState::v_GetPressure ( const NekDouble &  rho,
const NekDouble &  e 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

Referenced by GetPressure().

◆ v_GetPressure() [2/2]

virtual vec_t Nektar::EquationOfState::v_GetPressure ( const vec_t &  rho,
const vec_t &  e 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

◆ v_GetRhoFromPT()

virtual NekDouble Nektar::EquationOfState::v_GetRhoFromPT ( const NekDouble &  rho,
const NekDouble &  p 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

Referenced by GetRhoFromPT().

◆ v_GetSoundSpeed()

NekDouble Nektar::EquationOfState::v_GetSoundSpeed ( const NekDouble &  rho,
const NekDouble &  e 
)
protectedvirtual

Reimplemented in Nektar::IdealGasEoS.

Definition at line 63 of file EquationOfState.cpp.

65{
66 NekDouble p = GetPressure(rho, e);
67 NekDouble dpde = GetDPDe_rho(rho, e);
68 NekDouble dpdrho = GetDPDrho_e(rho, e);
69
70 NekDouble enthalpy = e + p / rho;
71
72 NekDouble chi = dpdrho - e / rho * dpde;
73 NekDouble kappa = dpde / rho;
74
75 return std::sqrt(chi + kappa * enthalpy);
76}
Nektar::EquationOfState::GetPressure
NekDouble GetPressure(const NekDouble &rho, const NekDouble &e)
Calculate the pressure.
Definition: EquationOfState.h:84
Nektar::EquationOfState::GetDPDrho_e
NekDouble GetDPDrho_e(const NekDouble &rho, const NekDouble &e)
Calculate the partial derivative of P(rho,e) with respect to rho.
Definition: EquationOfState.h:107
Nektar::EquationOfState::GetDPDe_rho
NekDouble GetDPDe_rho(const NekDouble &rho, const NekDouble &e)
Calculate the partial derivative of P(rho,e) with respect to e.
Definition: EquationOfState.h:113
Nektar::NekDouble
double NekDouble
Definition: NektarUnivTypeDefs.hpp:43
tinysimd::sqrt
scalarT< T > sqrt(scalarT< T > in)
Definition: scalar.hpp:285

References GetDPDe_rho(), GetDPDrho_e(), GetPressure(), CellMLToNektar.cellml_metadata::p, and tinysimd::sqrt().

Referenced by GetSoundSpeed().

◆ v_GetTemperature() [1/2]

virtual NekDouble Nektar::EquationOfState::v_GetTemperature ( const NekDouble &  rho,
const NekDouble &  e 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

Referenced by GetTemperature().

◆ v_GetTemperature() [2/2]

virtual vec_t Nektar::EquationOfState::v_GetTemperature ( const vec_t &  rho,
const vec_t &  e 
)
protectedpure virtual

Implemented in Nektar::IdealGasEoS, Nektar::PengRobinsonEoS, Nektar::RedlichKwongEoS, and Nektar::VanDerWaalsEoS.

Member Data Documentation

◆ m_gamma

NekDouble Nektar::EquationOfState::m_gamma
protected

Definition at line 131 of file EquationOfState.h.

Referenced by EquationOfState(), Nektar::VanDerWaalsEoS::GetPressureKernel(), Nektar::PengRobinsonEoS::GetTemperatureKernel(), Nektar::RedlichKwongEoS::GetTemperatureKernel(), Nektar::VanDerWaalsEoS::GetTemperatureKernel(), Nektar::IdealGasEoS::v_GetDPDe_rho(), Nektar::PengRobinsonEoS::v_GetDPDe_rho(), Nektar::RedlichKwongEoS::v_GetDPDe_rho(), Nektar::VanDerWaalsEoS::v_GetDPDe_rho(), Nektar::IdealGasEoS::v_GetDPDrho_e(), Nektar::VanDerWaalsEoS::v_GetDPDrho_e(), Nektar::IdealGasEoS::v_GetEFromRhoP(), Nektar::PengRobinsonEoS::v_GetEFromRhoP(), Nektar::RedlichKwongEoS::v_GetEFromRhoP(), Nektar::VanDerWaalsEoS::v_GetEFromRhoP(), Nektar::IdealGasEoS::v_GetEntropy(), Nektar::PengRobinsonEoS::v_GetEntropy(), Nektar::RedlichKwongEoS::v_GetEntropy(), Nektar::VanDerWaalsEoS::v_GetEntropy(), and Nektar::IdealGasEoS::v_GetSoundSpeed().

◆ m_gammaMone

NekDouble Nektar::EquationOfState::m_gammaMone
protected

Definition at line 133 of file EquationOfState.h.

Referenced by EquationOfState(), and Nektar::IdealGasEoS::GetPressureKernel().

◆ m_gammaMoneOgasConst

NekDouble Nektar::EquationOfState::m_gammaMoneOgasConst
protected

Definition at line 134 of file EquationOfState.h.

Referenced by EquationOfState(), and Nektar::IdealGasEoS::GetTemperatureKernel().

◆ m_gasConstant

NekDouble Nektar::EquationOfState::m_gasConstant
protected

Definition at line 132 of file EquationOfState.h.

Referenced by EquationOfState(), Nektar::PengRobinsonEoS::GetPressureKernel(), Nektar::RedlichKwongEoS::GetPressureKernel(), Nektar::PengRobinsonEoS::GetTemperatureKernel(), Nektar::RedlichKwongEoS::GetTemperatureKernel(), Nektar::VanDerWaalsEoS::GetTemperatureKernel(), Nektar::PengRobinsonEoS::PengRobinsonEoS(), Nektar::RedlichKwongEoS::RedlichKwongEoS(), Nektar::PengRobinsonEoS::v_GetDPDe_rho(), Nektar::RedlichKwongEoS::v_GetDPDe_rho(), Nektar::PengRobinsonEoS::v_GetDPDrho_e(), Nektar::RedlichKwongEoS::v_GetDPDrho_e(), Nektar::PengRobinsonEoS::v_GetEFromRhoP(), Nektar::RedlichKwongEoS::v_GetEFromRhoP(), Nektar::IdealGasEoS::v_GetEntropy(), Nektar::PengRobinsonEoS::v_GetEntropy(), Nektar::RedlichKwongEoS::v_GetEntropy(), Nektar::VanDerWaalsEoS::v_GetEntropy(), Nektar::IdealGasEoS::v_GetRhoFromPT(), Nektar::PengRobinsonEoS::v_GetRhoFromPT(), Nektar::RedlichKwongEoS::v_GetRhoFromPT(), Nektar::VanDerWaalsEoS::v_GetRhoFromPT(), Nektar::IdealGasEoS::v_GetSoundSpeed(), and Nektar::VanDerWaalsEoS::VanDerWaalsEoS().

Generated on Wed May 28 2025 19:03:44 for Nektar++ by doxygen 1.9.4