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

virtual NekDouble	GetTemperature (const NekDouble &rho, const NekDouble &e)=0
	Calculate the temperature. More...

virtual vec_t	GetTemperature (const vec_t &rho, const vec_t &e)=0

virtual NekDouble	GetPressure (const NekDouble &rho, const NekDouble &e)=0
	Calculate the pressure. More...

virtual vec_t	GetPressure (const vec_t &rho, const vec_t &e)=0

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_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 66 of file EquationOfState.h.

Constructor & Destructor Documentation

◆ ~EquationOfState()

virtual Nektar::EquationOfState::~EquationOfState ( )

inlinevirtual

Definition at line 69 of file EquationOfState.h.

70 {

71 }

◆ EquationOfState() [1/2]

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

protected

Constructor.

Definition at line 47 of file EquationOfState.cpp.

 {
     pSession->LoadParameter("Gamma", m_gamma, 1.4);
     pSession->LoadParameter("GasConstant", m_gasConstant, 287.058);
  
     m_gammaMone          = m_gamma - 1.0;
     m_gammaMoneOgasConst = m_gammaMone / m_gasConstant;
 }

◆ EquationOfState() [2/2]

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

protected

Programmatic Constructor.

Definition at line 57 of file EquationOfState.cpp.

     : m_gamma{gamma}, m_gasConstant{gasConstant}
 {
 }

Member Function Documentation

◆ GetDPDe_rho()

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

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

Definition at line 79 of file EquationOfState.cpp.

 {
     return v_GetDPDe_rho(rho, e);
 }

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
	)

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

Definition at line 74 of file EquationOfState.cpp.

 {
     return v_GetDPDrho_e(rho, e);
 }

References v_GetDPDrho_e().

Referenced by v_GetSoundSpeed().

◆ GetEFromRhoP()

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

Obtain the internal energy from rho and P.

Definition at line 84 of file EquationOfState.cpp.

 {
     return v_GetEFromRhoP(rho, p);
 }

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

◆ GetEntropy()

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

Calculate the entropy.

Definition at line 69 of file EquationOfState.cpp.

 {
     return v_GetEntropy(rho, e);
 }

References v_GetEntropy().

◆ GetPressure() [1/2]

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

pure virtual

Calculate the pressure.

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

Referenced by v_GetSoundSpeed().

◆ GetPressure() [2/2]

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

pure virtual

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

◆ GetRhoFromPT()

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

Obtain the density from P and T.

Definition at line 90 of file EquationOfState.cpp.

 {
     return v_GetRhoFromPT(p, T);
 }

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

◆ GetSoundSpeed()

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

Calculate the sound speed.

Definition at line 63 of file EquationOfState.cpp.

 {
     return v_GetSoundSpeed(rho, e);
 }

References v_GetSoundSpeed().

◆ GetTemperature() [1/2]

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

pure virtual

Calculate the temperature.

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

◆ GetTemperature() [2/2]

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

pure virtual

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

◆ v_GetDPDe_rho()

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

protectedpure virtual

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

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::VanDerWaalsEoS, Nektar::RedlichKwongEoS, Nektar::PengRobinsonEoS, and Nektar::IdealGasEoS.

Referenced by GetDPDrho_e().

◆ v_GetEFromRhoP()

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

protectedpure virtual

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

Referenced by GetEFromRhoP().

◆ v_GetEntropy()

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

protectedpure virtual

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

Referenced by GetEntropy().

◆ v_GetRhoFromPT()

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

protectedpure virtual

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

Referenced by GetRhoFromPT().

◆ v_GetSoundSpeed()

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

protectedvirtual

Reimplemented in Nektar::IdealGasEoS.

Definition at line 97 of file EquationOfState.cpp.

 {
     NekDouble p      = GetPressure(rho, e);
     NekDouble dpde   = GetDPDe_rho(rho, e);
     NekDouble dpdrho = GetDPDrho_e(rho, e);
  
     NekDouble enthalpy = e + p / rho;
  
     NekDouble chi   = dpdrho - e / rho * dpde;
     NekDouble kappa = dpde / rho;
  
     return sqrt(chi + kappa * enthalpy);
 }

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

Referenced by GetSoundSpeed().

Member Data Documentation

◆ m_gamma

NekDouble Nektar::EquationOfState::m_gamma

protected

Definition at line 103 of file EquationOfState.h.

Referenced by Nektar::VanDerWaalsEoS::GetPressureKernel(), Nektar::PengRobinsonEoS::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 105 of file EquationOfState.h.

Referenced by Nektar::IdealGasEoS::GetPressureKernel().

◆ m_gammaMoneOgasConst

NekDouble Nektar::EquationOfState::m_gammaMoneOgasConst

protected

Definition at line 106 of file EquationOfState.h.

Referenced by Nektar::IdealGasEoS::GetTemperatureKernel().

◆ m_gasConstant

NekDouble Nektar::EquationOfState::m_gasConstant

protected

Definition at line 104 of file EquationOfState.h.

Referenced by Nektar::PengRobinsonEoS::GetPressureKernel(), Nektar::PengRobinsonEoS::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().

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~EquationOfState()

◆ EquationOfState() [1/2]

◆ EquationOfState() [2/2]

Member Function Documentation

◆ GetDPDe_rho()

◆ GetDPDrho_e()

◆ GetEFromRhoP()

◆ GetEntropy()

◆ GetPressure() [1/2]

◆ GetPressure() [2/2]

◆ GetRhoFromPT()

◆ GetSoundSpeed()

◆ GetTemperature() [1/2]

◆ GetTemperature() [2/2]

◆ v_GetDPDe_rho()

◆ v_GetDPDrho_e()

◆ v_GetEFromRhoP()

◆ v_GetEntropy()

◆ v_GetRhoFromPT()

◆ v_GetSoundSpeed()

Member Data Documentation

◆ m_gamma

◆ m_gammaMone

◆ m_gammaMoneOgasConst

◆ m_gasConstant