Ideal gas equation of state: p = rho * R * T. More...

#include <IdealGasEoS.h>

Inheritance diagram for Nektar::IdealGasEoS:

Static Public Member Functions
static EquationOfStateSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of the class. More...

Protected Member Functions
virtual NekDouble	v_GetTemperature (const NekDouble &rho, const NekDouble &e) override final

virtual vec_t	v_GetTemperature (const vec_t &rho, const vec_t &e) override final

virtual NekDouble	v_GetPressure (const NekDouble &rho, const NekDouble &e) override final

virtual vec_t	v_GetPressure (const vec_t &rho, const vec_t &e) override final

virtual NekDouble	v_GetSoundSpeed (const NekDouble &rho, const NekDouble &e) override final

virtual NekDouble	v_GetEntropy (const NekDouble &rho, const NekDouble &e) override final

virtual NekDouble	v_GetDPDrho_e (const NekDouble &rho, const NekDouble &e) override final

virtual NekDouble	v_GetDPDe_rho (const NekDouble &rho, const NekDouble &e) override final

virtual NekDouble	v_GetEFromRhoP (const NekDouble &rho, const NekDouble &p) override final

virtual NekDouble	v_GetRhoFromPT (const NekDouble &rho, const NekDouble &p) override final

Protected Member Functions inherited from Nektar::EquationOfState
	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

Private Member Functions
	IdealGasEoS (const LibUtilities::SessionReaderSharedPtr &pSession)

	~IdealGasEoS (void)

template<class T , typename = typename std::enable_if< std::is_floating_point<T>::value \|\| tinysimd::is_vector_floating_point<T>::value>::type>
T	GetTemperatureKernel (const T &e)

template<class T , typename = typename std::enable_if< std::is_floating_point<T>::value \|\| tinysimd::is_vector_floating_point<T>::value>::type>
T	GetPressureKernel (const T &rho, const T &e)

Friends
class	MemoryManager< IdealGasEoS >

Additional Inherited Members
Public Member Functions inherited from Nektar::EquationOfState
virtual	~EquationOfState ()

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 Attributes inherited from Nektar::EquationOfState
NekDouble	m_gamma

NekDouble	m_gasConstant

NekDouble	m_gammaMone

NekDouble	m_gammaMoneOgasConst

Detailed Description

Ideal gas equation of state: p = rho * R * T.

Definition at line 47 of file IdealGasEoS.h.

Constructor & Destructor Documentation

◆ IdealGasEoS()

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

private

Definition at line 48 of file IdealGasEoS.cpp.

    : EquationOfState(pSession)
{
}

◆ ~IdealGasEoS()

Nektar::IdealGasEoS::~IdealGasEoS ( void )

inlineprivate

Definition at line 98 of file IdealGasEoS.h.

98{};

Member Function Documentation

◆ create()

static EquationOfStateSharedPtr Nektar::IdealGasEoS::create ( const LibUtilities::SessionReaderSharedPtr & pSession )

inlinestatic

Creates an instance of this class.

Definition at line 53 of file IdealGasEoS.h.

    {
        EquationOfStateSharedPtr p =
            MemoryManager<IdealGasEoS>::AllocateSharedPtr(pSession);
        return p;
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

◆ GetPressureKernel()

template<class T , typename = typename std::enable_if< std::is_floating_point<T>::value || tinysimd::is_vector_floating_point<T>::value>::type>

T Nektar::IdealGasEoS::GetPressureKernel	(	const T &	rho,
		const T &	e
	)

inlineprivate

Definition at line 112 of file IdealGasEoS.h.

    {
        return rho * e * m_gammaMone;
    }

References Nektar::EquationOfState::m_gammaMone.

Referenced by v_GetPressure().

◆ GetTemperatureKernel()

template<class T , typename = typename std::enable_if< std::is_floating_point<T>::value || tinysimd::is_vector_floating_point<T>::value>::type>

T Nektar::IdealGasEoS::GetTemperatureKernel ( const T & e )

inlineprivate

Definition at line 104 of file IdealGasEoS.h.

    {
        return e * m_gammaMoneOgasConst;
    }

References Nektar::EquationOfState::m_gammaMoneOgasConst.

Referenced by v_GetTemperature().

◆ v_GetDPDe_rho()

NekDouble Nektar::IdealGasEoS::v_GetDPDe_rho	(	const NekDouble &	rho,
		const NekDouble &	e
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 94 of file IdealGasEoS.cpp.

{
    boost::ignore_unused(e);
    return rho * (m_gamma - 1);
}

References Nektar::EquationOfState::m_gamma.

◆ v_GetDPDrho_e()

NekDouble Nektar::IdealGasEoS::v_GetDPDrho_e	(	const NekDouble &	rho,
		const NekDouble &	e
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 88 of file IdealGasEoS.cpp.

{
    boost::ignore_unused(rho);
    return e * (m_gamma - 1);
}

References Nektar::EquationOfState::m_gamma.

◆ v_GetEFromRhoP()

NekDouble Nektar::IdealGasEoS::v_GetEFromRhoP	(	const NekDouble &	rho,
		const NekDouble &	p
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 100 of file IdealGasEoS.cpp.

{
    return p / (rho * (m_gamma - 1));
}

References Nektar::EquationOfState::m_gamma, and CellMLToNektar.cellml_metadata::p.

◆ v_GetEntropy()

NekDouble Nektar::IdealGasEoS::v_GetEntropy	(	const NekDouble &	rho,
		const NekDouble &	e
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 82 of file IdealGasEoS.cpp.

{
    NekDouble T = GetTemperature(rho, e);
    return m_gasConstant / (m_gamma - 1) * log(T) - m_gasConstant * log(rho);
}

References Nektar::EquationOfState::GetTemperature(), tinysimd::log(), Nektar::EquationOfState::m_gamma, and Nektar::EquationOfState::m_gasConstant.

◆ v_GetPressure() [1/2]

NekDouble Nektar::IdealGasEoS::v_GetPressure	(	const NekDouble &	rho,
		const NekDouble &	e
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 66 of file IdealGasEoS.cpp.

{
    return GetPressureKernel(rho, e);
}

References GetPressureKernel().

◆ v_GetPressure() [2/2]

vec_t Nektar::IdealGasEoS::v_GetPressure	(	const vec_t &	rho,
		const vec_t &	e
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 71 of file IdealGasEoS.cpp.

{
    return GetPressureKernel(rho, e);
}

References GetPressureKernel().

◆ v_GetRhoFromPT()

NekDouble Nektar::IdealGasEoS::v_GetRhoFromPT	(	const NekDouble &	rho,
		const NekDouble &	p
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 105 of file IdealGasEoS.cpp.

{
    return p / (m_gasConstant * T);
}

References Nektar::EquationOfState::m_gasConstant, and CellMLToNektar.cellml_metadata::p.

◆ v_GetSoundSpeed()

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

finaloverrideprotectedvirtual

Reimplemented from Nektar::EquationOfState.

Definition at line 76 of file IdealGasEoS.cpp.

{
    NekDouble T = GetTemperature(rho, e);
    return sqrt(m_gamma * m_gasConstant * T);
}

References Nektar::EquationOfState::GetTemperature(), Nektar::EquationOfState::m_gamma, Nektar::EquationOfState::m_gasConstant, and tinysimd::sqrt().

◆ v_GetTemperature() [1/2]

NekDouble Nektar::IdealGasEoS::v_GetTemperature	(	const NekDouble &	rho,
		const NekDouble &	e
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 53 of file IdealGasEoS.cpp.

{
    boost::ignore_unused(rho);
    return GetTemperatureKernel(e);
}

References GetTemperatureKernel().

◆ v_GetTemperature() [2/2]

vec_t Nektar::IdealGasEoS::v_GetTemperature	(	const vec_t &	rho,
		const vec_t &	e
	)

finaloverrideprotectedvirtual

Implements Nektar::EquationOfState.

Definition at line 60 of file IdealGasEoS.cpp.

{
    boost::ignore_unused(rho);
    return GetTemperatureKernel(e);
}

References GetTemperatureKernel().

Friends And Related Function Documentation

◆ MemoryManager< IdealGasEoS >

friend class MemoryManager< IdealGasEoS >

friend

Definition at line 1 of file IdealGasEoS.h.

Member Data Documentation

◆ className

std::string Nektar::IdealGasEoS::className

static

Initial value:

=
    GetEquationOfStateFactory().RegisterCreatorFunction(
        "IdealGas", IdealGasEoS::create, "Ideal gas equation of state.")

Name of the class.

Definition at line 62 of file IdealGasEoS.h.

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IdealGasEoS()

◆ ~IdealGasEoS()

Member Function Documentation

◆ create()

◆ GetPressureKernel()

◆ GetTemperatureKernel()

◆ v_GetDPDe_rho()

◆ v_GetDPDrho_e()

◆ v_GetEFromRhoP()

◆ v_GetEntropy()

◆ v_GetPressure() [1/2]

◆ v_GetPressure() [2/2]

◆ v_GetRhoFromPT()

◆ v_GetSoundSpeed()

◆ v_GetTemperature() [1/2]

◆ v_GetTemperature() [2/2]

Friends And Related Function Documentation

◆ MemoryManager< IdealGasEoS >

Member Data Documentation

◆ className