A 3D equation of state representing a barotropic fluid. More...

#include <Barotropic3D.hpp>

Classes
struct	UnderlyingEos

Public Types
using	options = tmpl::list< UnderlyingEos >

Public Member Functions
	Barotropic3D (const Barotropic3D &)=default

Barotropic3D &	operator= (const Barotropic3D &)=default

	Barotropic3D (Barotropic3D &&)=default

Barotropic3D &	operator= (Barotropic3D &&)=default

	Barotropic3D (const ColdEquilEos &underlying_eos)

std::unique_ptr< EquationOfState< ColdEquilEos::is_relativistic, 3 > >	get_clone () const override

bool	is_equal (const EquationOfState< ColdEquilEos::is_relativistic, 3 > &rhs) const override

bool	is_barotropic () const override
	Returns `true` if the EOS is barotropic.

bool	is_equilibrium () const override
	Returns `true` if the EOS is in beta-equilibrium.

bool	operator== (const Barotropic3D< ColdEquilEos > &rhs) const

bool	operator!= (const Barotropic3D< ColdEquilEos > &rhs) const

	WRAPPED_PUPable_decl_base_template (SINGLE_ARG(EquationOfState< ColdEquilEos::is_relativistic, 3 >), Barotropic3D)

double	electron_fraction_lower_bound () const override
	The lower bound of the electron fraction that is valid for this EOS.

double	electron_fraction_upper_bound () const override
	The upper bound of the electron fraction that is valid for this EOS.

double	rest_mass_density_lower_bound () const override
	The lower bound of the rest mass density that is valid for this EOS.

double	rest_mass_density_upper_bound () const override
	The upper bound of the rest mass density that is valid for this EOS.

double	temperature_lower_bound () const override
	The lower bound of the temperature that is valid for this EOS.

double	temperature_upper_bound () const override
	The upper bound of the temperature that is valid for this EOS.

double	specific_internal_energy_lower_bound (const double, const double) const override
	The lower bound of the specific internal energy that is valid for this EOS at the given rest mass density \(\rho\) and electron fraction \(Y_e\).

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

double	specific_enthalpy_lower_bound () const override
	The lower bound of the specific enthalpy that is valid for this EOS.

double	baryon_mass () const override
	The baryon mass for this EoS.


Scalar< double >	equilibrium_electron_fraction_from_density_temperature (const Scalar< double > &rest_mass_density, const Scalar< double > &temperature) const override

Scalar< DataVector >	equilibrium_electron_fraction_from_density_temperature (const Scalar< DataVector > &rest_mass_density, const Scalar< DataVector > &temperature) const override

Static Public Member Functions
static std::string	name ()

Static Public Attributes
static constexpr size_t	thermodynamic_dim = 3

static constexpr bool	is_relativistic = ColdEquilEos::is_relativistic

static constexpr Options::String	help

Detailed Description

template<typename ColdEquilEos>
class EquationsOfState::Barotropic3D< ColdEquilEos >

A 3D equation of state representing a barotropic fluid.

The equation of state takes the form

\[ p = p (\rho , T, Y_e) = p(\rho, 0, Y_e= Y_{e, \beta}) \]

where \(\rho\) is the rest mass density, \(T\) the temperature , and \(Y_e\) the electron fraction. The temperature and electron fraction are not used, so evaluating this EoS at any arbtirary temeperature or electron fraction is equivalent to evaluating it at zero temperature and in beta equalibrium.

Member Function Documentation

◆ equilibrium_electron_fraction_from_density_temperature() [1/2]

template<typename ColdEquilEos >

Scalar< DataVector > EquationsOfState::Barotropic3D< ColdEquilEos >::equilibrium_electron_fraction_from_density_temperature	(	const Scalar< DataVector > &	rest_mass_density,
		const Scalar< DataVector > &	temperature
	)		const

inlineoverride

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

◆ equilibrium_electron_fraction_from_density_temperature() [2/2]

template<typename ColdEquilEos >

Scalar< double > EquationsOfState::Barotropic3D< ColdEquilEos >::equilibrium_electron_fraction_from_density_temperature	(	const Scalar< double > &	rest_mass_density,
		const Scalar< double > &	temperature
	)		const

inlineoverride

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

Member Data Documentation

◆ help

template<typename ColdEquilEos >

constexpr Options::String EquationsOfState::Barotropic3D< ColdEquilEos >::help

staticconstexpr

Initial value:

= {
      "An 3D EoS which is independent of electron fraction and temperature. "
      "Contains an underlying 1D EoS which is dependent only "
      "on rest mass density."}

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

src/PointwiseFunctions/Hydro/EquationsOfState/Barotropic3D.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ equilibrium_electron_fraction_from_density_temperature() [1/2]

◆ equilibrium_electron_fraction_from_density_temperature() [2/2]

Member Data Documentation

◆ help