SpECTRE  v2024.12.16
Public Types | Public Member Functions | Static Public Attributes | List of all members
EquationsOfState::EquationOfState< IsRelativistic, 1 > Class Template Referenceabstract
Equations of State

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
 
EquationOfState & operator= (const EquationOfState &)=default
 
 EquationOfState (EquationOfState &&)=default
 
EquationOfState & operator= (EquationOfState &&)=default
 
 EquationOfState (CkMigrateMessage *msg)
 
 WRAPPED_PUPable_abstract (EquationOfState)
 
virtual std::unique_ptr< EquationOfState< IsRelativistic, 1 > > get_clone () const =0
 
virtual bool is_equal (const EquationOfState< IsRelativistic, 1 > &rhs) const =0
 
virtual std::unique_ptr< EquationOfState< IsRelativistic, 3 > > promote_to_3d_eos () const =0
 Create a 3D EOS from the 1D EOS. More...
 
virtual std::unique_ptr< EquationOfState< IsRelativistic, 2 > > promote_to_2d_eos () const =0
 Create a 2D EOS from the 1D EOS. More...
 
bool is_barotropic () const
 Returns true if the EOS is barotropic.
 
virtual Scalar< double > equilibrium_electron_fraction_from_density_temperature (const Scalar< double > &rest_mass_density, const Scalar< double > &) const
 
virtual Scalar< DataVector > equilibrium_electron_fraction_from_density_temperature (const Scalar< DataVector > &rest_mass_density, const Scalar< DataVector > &) const
 
virtual Scalar< double > pressure_from_density (const Scalar< double > &) const =0
 
virtual Scalar< DataVector > pressure_from_density (const Scalar< DataVector > &) const =0
 
virtual Scalar< double > rest_mass_density_from_enthalpy (const Scalar< double > &) const =0
 
virtual Scalar< DataVector > rest_mass_density_from_enthalpy (const Scalar< DataVector > &) const =0
 
virtual Scalar< double > specific_internal_energy_from_density (const Scalar< double > &) const =0
 
virtual Scalar< DataVector > specific_internal_energy_from_density (const Scalar< DataVector > &) const =0
 
virtual Scalar< double > temperature_from_density (const Scalar< double > &) const
 
virtual Scalar< DataVector > temperature_from_density (const Scalar< DataVector > &rest_mass_density) const
 
virtual Scalar< double > temperature_from_specific_internal_energy (const Scalar< double > &) const
 
virtual Scalar< DataVector > temperature_from_specific_internal_energy (const Scalar< DataVector > &specific_internal_energy) const
 
virtual Scalar< double > chi_from_density (const Scalar< double > &) const =0
 
virtual Scalar< DataVector > chi_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< DataVector > kappa_times_p_over_rho_squared_from_density (const Scalar< DataVector > &) const =0
 
virtual double electron_fraction_lower_bound () const
 The lower bound of the electron fraction that is valid for this EOS.
 
virtual double electron_fraction_upper_bound () const
 The upper bound of the electron fraction that is valid for this EOS.
 
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 temperature_lower_bound () const
 The lower bound of the temperature that is valid for this EOS.
 
virtual double temperature_upper_bound () const
 The upper bound of the temperature that is valid for this EOS.
 
virtual double specific_internal_energy_lower_bound () const
 The lower bound of the specific internal energy that is valid for this EOS. More...
 
virtual double specific_internal_energy_upper_bound () const
 The upper bound of the specific internal energy that is valid for this EOS. More...
 
virtual double specific_enthalpy_lower_bound () const =0
 The lower bound of the specific enthalpy that is valid for this EOS. More...
 
virtual double baryon_mass () const
 The vacuum mass of a baryon 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

◆ baryon_mass()

template<bool IsRelativistic>
virtual double EquationsOfState::EquationOfState< IsRelativistic, 1 >::baryon_mass ( ) const
inlinevirtual

The vacuum mass of a baryon for this EOS.

Reimplemented in EquationsOfState::PiecewisePolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< false >, and EquationsOfState::PolytropicFluid< true >.

◆ 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.

◆ equilibrium_electron_fraction_from_density_temperature() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::equilibrium_electron_fraction_from_density_temperature ( const Scalar< DataVector > &  rest_mass_density,
const Scalar< DataVector > &   
) const
inlinevirtual

Computes the electron fraction in beta-equilibrium \(Y_e^{\rm eq}\) from the rest mass density \(\rho\).

◆ equilibrium_electron_fraction_from_density_temperature() [2/2]

template<bool IsRelativistic>
virtual Scalar< double > EquationsOfState::EquationOfState< IsRelativistic, 1 >::equilibrium_electron_fraction_from_density_temperature ( const Scalar< double > &  rest_mass_density,
const Scalar< double > &   
) const
inlinevirtual

Computes the electron fraction in beta-equilibrium \(Y_e^{\rm eq}\) from the rest mass density \(\rho\).

◆ 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\).

◆ promote_to_2d_eos()

template<bool IsRelativistic>
virtual std::unique_ptr< EquationOfState< IsRelativistic, 2 > > EquationsOfState::EquationOfState< IsRelativistic, 1 >::promote_to_2d_eos ( ) const
pure virtual

Create a 2D EOS from the 1D EOS.

Implemented in EquationsOfState::PiecewisePolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< false >, and EquationsOfState::PolytropicFluid< true >.

◆ promote_to_3d_eos()

template<bool IsRelativistic>
virtual std::unique_ptr< EquationOfState< IsRelativistic, 3 > > EquationsOfState::EquationOfState< IsRelativistic, 1 >::promote_to_3d_eos ( ) const
pure virtual

Create a 3D EOS from the 1D EOS.

Implemented in EquationsOfState::PiecewisePolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< false >, and EquationsOfState::PolytropicFluid< true >.

◆ 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::PiecewisePolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< false >, and EquationsOfState::PolytropicFluid< true >.

◆ 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::PiecewisePolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< false >, and EquationsOfState::PolytropicFluid< true >.

◆ 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::PiecewisePolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< false >, and EquationsOfState::PolytropicFluid< true >.

◆ 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
inlinevirtual

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

Reimplemented in EquationsOfState::PiecewisePolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< false >, and EquationsOfState::PolytropicFluid< true >.

◆ specific_internal_energy_upper_bound()

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

The upper bound of the specific internal energy that is valid for this EOS.

Reimplemented in EquationsOfState::PiecewisePolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< IsRelativistic >, EquationsOfState::PolytropicFluid< false >, and EquationsOfState::PolytropicFluid< true >.

◆ temperature_from_density() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::temperature_from_density ( const Scalar< DataVector > &  rest_mass_density) const
inlinevirtual

Computes the temperature \(T\) from the rest mass density \(\rho\).

◆ temperature_from_density() [2/2]

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

Computes the temperature \(T\) from the rest mass density \(\rho\).

◆ temperature_from_specific_internal_energy() [1/2]

template<bool IsRelativistic>
virtual Scalar< DataVector > EquationsOfState::EquationOfState< IsRelativistic, 1 >::temperature_from_specific_internal_energy ( const Scalar< DataVector > &  specific_internal_energy) const
inlinevirtual

Computes the temperature \(\T\) from the specific internal energy \(\epsilon\).

◆ temperature_from_specific_internal_energy() [2/2]

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

Computes the temperature \(\T\) from the specific internal energy \(\epsilon\).

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