SpECTRE  v2021.12.06
EquationsOfState::EquationOfState< IsRelativistic, 1 > Class Template Referenceabstract

Base class for equations of state which need one thermodynamic variable in order to determine the pressure. More...

#include <EquationOfState.hpp>

Public Types

using creatable_classes = typename detail::DerivedClasses< IsRelativistic, 1 >::type
 

Public Member Functions

 EquationOfState (const EquationOfState &)=default
 
EquationOfStateoperator= (const EquationOfState &)=default
 
 EquationOfState (EquationOfState &&)=default
 
EquationOfStateoperator= (EquationOfState &&)=default
 
 WRAPPED_PUPable_abstract (EquationOfState)
 
virtual Scalar< double > pressure_from_density (const Scalar< double > &) const =0
 
virtual Scalar< DataVectorpressure_from_density (const Scalar< DataVector > &) const =0
 
virtual Scalar< double > rest_mass_density_from_enthalpy (const Scalar< double > &) const =0
 
virtual Scalar< DataVectorrest_mass_density_from_enthalpy (const Scalar< DataVector > &) const =0
 
virtual Scalar< double > specific_enthalpy_from_density (const Scalar< double > &) const =0
 
virtual Scalar< DataVectorspecific_enthalpy_from_density (const Scalar< DataVector > &) const =0
 
virtual Scalar< double > specific_internal_energy_from_density (const Scalar< double > &) const =0
 
virtual Scalar< DataVectorspecific_internal_energy_from_density (const Scalar< DataVector > &) const =0
 
virtual Scalar< double > chi_from_density (const Scalar< double > &) const =0
 
virtual Scalar< DataVectorchi_from_density (const Scalar< DataVector > &) const =0
 
virtual Scalar< double > kappa_times_p_over_rho_squared_from_density (const Scalar< double > &) const =0
 
virtual Scalar< DataVectorkappa_times_p_over_rho_squared_from_density (const Scalar< DataVector > &) const =0
 
virtual double rest_mass_density_lower_bound () const =0
 The lower bound of the rest mass density that is valid for this EOS. More...
 
virtual double rest_mass_density_upper_bound () const =0
 The upper bound of the rest mass density that is valid for this EOS. More...
 
virtual double specific_internal_energy_lower_bound (const double rest_mass_density) const =0
 The lower bound of the specific internal energy that is valid for this EOS at the given rest mass density \(\rho\). More...
 
virtual double specific_internal_energy_upper_bound (const double rest_mass_density) const =0
 The upper bound of the specific internal energy that is valid for this EOS at the given rest mass density \(\rho\). More...
 
virtual double specific_enthalpy_lower_bound () const =0
 The lower bound of the specific enthalpy that is valid for this EOS. More...
 

Static Public Attributes

static constexpr bool is_relativistic = IsRelativistic
 
static constexpr size_t thermodynamic_dim = 1
 

Detailed Description

template<bool IsRelativistic>
class EquationsOfState::EquationOfState< IsRelativistic, 1 >

Base class for equations of state which need one thermodynamic variable in order to determine the pressure.

The template parameter IsRelativistic is true for relativistic equations of state and false for non-relativistic equations of state.

Member Function Documentation

◆ chi_from_density() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::chi_from_density ( const Scalar< DataVector > &  ) const
pure virtual

Computes \(\chi=\partial p / \partial \rho\) from \(\rho\), where \(p\) is the pressure and \(\rho\) is the rest mass density.

◆ chi_from_density() [2/2]

template<bool IsRelativistic>
virtual Scalar< double > EquationsOfState::EquationOfState< IsRelativistic, 1 >::chi_from_density ( const Scalar< double > &  ) const
pure virtual

Computes \(\chi=\partial p / \partial \rho\) from \(\rho\), where \(p\) is the pressure and \(\rho\) is the rest mass density.

◆ kappa_times_p_over_rho_squared_from_density() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::kappa_times_p_over_rho_squared_from_density ( const Scalar< DataVector > &  ) const
pure virtual

Computes \(\kappa p/\rho^2=(p/\rho^2)\partial p / \partial \epsilon\) from \(\rho\), where \(p\) is the pressure, \(\rho\) is the rest mass density, and \(\epsilon\) is the specific internal energy.

The reason for not returning just \(\kappa=\partial p / \partial \epsilon\) is to avoid division by zero for small values of \(\rho\) when assembling the speed of sound with some equations of state.

◆ kappa_times_p_over_rho_squared_from_density() [2/2]

template<bool IsRelativistic>
virtual Scalar< double > EquationsOfState::EquationOfState< IsRelativistic, 1 >::kappa_times_p_over_rho_squared_from_density ( const Scalar< double > &  ) const
pure virtual

Computes \(\kappa p/\rho^2=(p/\rho^2)\partial p / \partial \epsilon\) from \(\rho\), where \(p\) is the pressure, \(\rho\) is the rest mass density, and \(\epsilon\) is the specific internal energy.

The reason for not returning just \(\kappa=\partial p / \partial \epsilon\) is to avoid division by zero for small values of \(\rho\) when assembling the speed of sound with some equations of state.

◆ pressure_from_density() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::pressure_from_density ( const Scalar< DataVector > &  ) const
pure virtual

Computes the pressure \(p\) from the rest mass density \(\rho\).

◆ pressure_from_density() [2/2]

template<bool IsRelativistic>
virtual Scalar< double > EquationsOfState::EquationOfState< IsRelativistic, 1 >::pressure_from_density ( const Scalar< double > &  ) const
pure virtual

Computes the pressure \(p\) from the rest mass density \(\rho\).

◆ rest_mass_density_from_enthalpy() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::rest_mass_density_from_enthalpy ( const Scalar< DataVector > &  ) const
pure virtual

Computes the rest mass density \(\rho\) from the specific enthalpy \(h\).

◆ rest_mass_density_from_enthalpy() [2/2]

template<bool IsRelativistic>
virtual Scalar< double > EquationsOfState::EquationOfState< IsRelativistic, 1 >::rest_mass_density_from_enthalpy ( const Scalar< double > &  ) const
pure virtual

Computes the rest mass density \(\rho\) from the specific enthalpy \(h\).

◆ rest_mass_density_lower_bound()

template<bool IsRelativistic>
virtual double EquationsOfState::EquationOfState< IsRelativistic, 1 >::rest_mass_density_lower_bound ( ) const
pure virtual

The lower bound of the rest mass density that is valid for this EOS.

Implemented in EquationsOfState::PolytropicFluid< IsRelativistic >.

◆ rest_mass_density_upper_bound()

template<bool IsRelativistic>
virtual double EquationsOfState::EquationOfState< IsRelativistic, 1 >::rest_mass_density_upper_bound ( ) const
pure virtual

The upper bound of the rest mass density that is valid for this EOS.

Implemented in EquationsOfState::PolytropicFluid< IsRelativistic >.

◆ specific_enthalpy_from_density() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::specific_enthalpy_from_density ( const Scalar< DataVector > &  ) const
pure virtual

Computes the specific enthalpy \(h\) from the rest mass density \(\rho\).

◆ specific_enthalpy_from_density() [2/2]

template<bool IsRelativistic>
virtual Scalar< double > EquationsOfState::EquationOfState< IsRelativistic, 1 >::specific_enthalpy_from_density ( const Scalar< double > &  ) const
pure virtual

Computes the specific enthalpy \(h\) from the rest mass density \(\rho\).

◆ specific_enthalpy_lower_bound()

template<bool IsRelativistic>
virtual double EquationsOfState::EquationOfState< IsRelativistic, 1 >::specific_enthalpy_lower_bound ( ) const
pure virtual

The lower bound of the specific enthalpy that is valid for this EOS.

Implemented in EquationsOfState::PolytropicFluid< IsRelativistic >.

◆ specific_internal_energy_from_density() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::specific_internal_energy_from_density ( const Scalar< DataVector > &  ) const
pure virtual

Computes the specific internal energy \(\epsilon\) from the rest mass density \(\rho\).

◆ specific_internal_energy_from_density() [2/2]

template<bool IsRelativistic>
virtual Scalar< double > EquationsOfState::EquationOfState< IsRelativistic, 1 >::specific_internal_energy_from_density ( const Scalar< double > &  ) const
pure virtual

Computes the specific internal energy \(\epsilon\) from the rest mass density \(\rho\).

◆ specific_internal_energy_lower_bound()

template<bool IsRelativistic>
virtual double EquationsOfState::EquationOfState< IsRelativistic, 1 >::specific_internal_energy_lower_bound ( const double  rest_mass_density) const
pure virtual

The lower bound of the specific internal energy that is valid for this EOS at the given rest mass density \(\rho\).

Implemented in EquationsOfState::PolytropicFluid< IsRelativistic >.

◆ specific_internal_energy_upper_bound()

template<bool IsRelativistic>
virtual double EquationsOfState::EquationOfState< IsRelativistic, 1 >::specific_internal_energy_upper_bound ( const double  rest_mass_density) const
pure virtual

The upper bound of the specific internal energy that is valid for this EOS at the given rest mass density \(\rho\).

Implemented in EquationsOfState::PolytropicFluid< IsRelativistic >.


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