serif::eos::EOSOutput Struct Reference

Output from an EOS calculation. More...

#include <EOS.h>

Public Member Functions
double	chiTemperature ()
	Calculates the temperature susceptibility (chi_T).
double	chiRho ()
	Calculates the density susceptibility (chi_rho).
double	soundSpeed ()
	Calculates the adiabatic sound speed.
double	adiabaticGradient ()
	Calculates the adiabatic temperature gradient (nabla_ad).
double	gamma1 ()
	Calculates the first adiabatic index (Gamma1).
double	gamma2 ()
	Calculates the second adiabatic index (Gamma2).
double	gamma3 ()
	Calculates the third adiabatic index (Gamma3).
double	specificHeatCapacityAtConstantVolume ()
	Calculates the specific heat capacity at constant volume (c_v).
double	specificHeatCapacityAtConstantPressure ()
	Calculates the specific heat capacity at constant pressure (c_p).

Public Attributes
double	electronFraction {}
	Electron fraction (ye), dimensionless.
double	electronChemicalPotential {}
	Electron chemical potential (eta_e) in cgs (erg/g).
double	neutronExcessFraction {}
	Neutron excess fraction (xnefer), dimensionless.
EOSParameter	pressure {"pressure"}
	Pressure output data, including total, gas, radiation, and derivatives.
EOSParameter	energy {"energy"}
	Internal energy output data, including total, gas, radiation, and derivatives.
EOSParameter	entropy {"entropy"}
	Entropy output data, including total, gas, radiation, and derivatives.

Friends
std::ostream &	operator<< (std::ostream &os, const EOSOutput &output)

Detailed Description

Output from an EOS calculation.

This struct contains various thermodynamic quantities and their derivatives calculated by the EOS for a given set of input conditions. It includes fundamental properties like electron fraction and chemical potential, as well as detailed breakdowns of pressure, energy, and entropy. Additionally, it provides methods to calculate derived quantities like susceptibilities, sound speed, adiabatic gradients, and specific heats.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Definition at line 78 of file EOS.h.

Member Function Documentation

adiabaticGradient()

double serif::eos::EOSOutput::adiabaticGradient

(

)

Calculates the adiabatic temperature gradient (nabla_ad).

Returns

Adiabatic gradient, dimensionless.

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, nabla_ad = (P * chi_T) / (rho * T * c_p * chi_rho).

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

chiRho()

double serif::eos::EOSOutput::chiRho

(

)

Calculates the density susceptibility (chi_rho).

Returns

Density susceptibility, dimensionless.

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, chi_rho = (d ln P / d ln rho)_T.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

chiTemperature()

double serif::eos::EOSOutput::chiTemperature

(

)

Calculates the temperature susceptibility (chi_T).

Returns

Temperature susceptibility, dimensionless.

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, chi_T = (d ln P / d ln T)_rho.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

gamma1()

double serif::eos::EOSOutput::gamma1

(

)

Calculates the first adiabatic index (Gamma1).

Returns

First adiabatic index, dimensionless.

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, Gamma1 = (d ln P / d ln rho)_S.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

gamma2()

double serif::eos::EOSOutput::gamma2

(

)

Calculates the second adiabatic index (Gamma2).

Returns

Second adiabatic index, dimensionless.

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, Gamma2 / (Gamma2 - 1) = (d ln P / d ln T)_S.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

gamma3()

double serif::eos::EOSOutput::gamma3

(

)

Calculates the third adiabatic index (Gamma3).

Returns

Third adiabatic index, dimensionless.

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, Gamma3 - 1 = (d ln T / d ln rho)_S.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

soundSpeed()

double serif::eos::EOSOutput::soundSpeed

(

)

Calculates the adiabatic sound speed.

Returns

Sound speed in cgs (cm/s).

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, c_s^2 = gamma1 * P / rho.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

specificHeatCapacityAtConstantPressure()

double serif::eos::EOSOutput::specificHeatCapacityAtConstantPressure

(

)

Calculates the specific heat capacity at constant pressure (c_p).

Returns

Specific heat capacity at constant pressure in cgs (erg/K/g).

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, c_p = c_v + (T / rho^2) * ( (d P / d T)_rho^2 / (d P / d rho)_T ).

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

specificHeatCapacityAtConstantVolume()

double serif::eos::EOSOutput::specificHeatCapacityAtConstantVolume

(

)

Calculates the specific heat capacity at constant volume (c_v).

Returns

Specific heat capacity at constant volume in cgs (erg/K/g).

Note

Placeholder: Actual calculation needs to be implemented based on available EOS derivatives. Typically, c_v = (dE/dT)_rho.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, const EOSOutput & output )

friend

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Definition at line 151 of file EOS.h.

Member Data Documentation

electronChemicalPotential

double serif::eos::EOSOutput::electronChemicalPotential {}

Electron chemical potential (eta_e) in cgs (erg/g).

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Definition at line 80 of file EOS.h.

electronFraction

double serif::eos::EOSOutput::electronFraction {}

Electron fraction (ye), dimensionless.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Definition at line 79 of file EOS.h.

energy

EOSParameter serif::eos::EOSOutput::energy {"energy"}

Internal energy output data, including total, gas, radiation, and derivatives.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Definition at line 84 of file EOS.h.

entropy

EOSParameter serif::eos::EOSOutput::entropy {"entropy"}

Entropy output data, including total, gas, radiation, and derivatives.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Definition at line 85 of file EOS.h.

neutronExcessFraction

double serif::eos::EOSOutput::neutronExcessFraction {}

Neutron excess fraction (xnefer), dimensionless.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Definition at line 81 of file EOS.h.

pressure

EOSParameter serif::eos::EOSOutput::pressure {"pressure"}

Pressure output data, including total, gas, radiation, and derivatives.

Examples

/Users/tboudreaux/Programming/SERiF/src/eos/public/EOS.h.

Definition at line 83 of file EOS.h.

---

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

• src/eos/public/EOS.h