Module LALSimNeutronStarEOS.c

Detailed Description

Provides routines for handling neutron star equations of state.

Author

Jolien Creighton, Benjamin Lackey

Variables
const char *const	lalSimNeutronStarEOSNames [111]
	Recognised equations of state names. More...

Destruction routine
void	XLALDestroySimNeutronStarEOS (LALSimNeutronStarEOS *eos)
	Frees the memory associated with a pointer to an EOS structure. More...

Routines to access equation of state variables
char *	XLALSimNeutronStarEOSName (LALSimNeutronStarEOS *eos)
	The name of the equation of state. More...
double	XLALSimNeutronStarEOSMaxPressureGeometerized (LALSimNeutronStarEOS *eos)
	Returns the maximum pressure of the EOS in geometrized units m^-2. More...
double	XLALSimNeutronStarEOSMaxPressure (LALSimNeutronStarEOS *eos)
	Returns the maximum pressure of the EOS in Pa. More...
double	XLALSimNeutronStarEOSMaxPseudoEnthalpy (LALSimNeutronStarEOS *eos)
	Returns the maximum pseudo enthalpy of the EOS (dimensionless). More...
double	XLALSimNeutronStarEOSMinAcausalPseudoEnthalpy (LALSimNeutronStarEOS *eos)
	Returns the minimum pseudo-enthalpy at which EOS becomes acausal (speed of sound > speed of light) (dimensionless). More...
double	XLALSimNeutronStarEOSEnergyDensityOfPressureGeometerized (double p, LALSimNeutronStarEOS *eos)
	Returns the energy density in geometerized units (m^-2) at a given pressure in geometerized units (m^-2). More...
double	XLALSimNeutronStarEOSPseudoEnthalpyOfPressureGeometerized (double p, LALSimNeutronStarEOS *eos)
	Returns the dimensionless pseudo-enthalpy at a given pressure in geometerized units (m^-2). More...
double	XLALSimNeutronStarEOSPressureOfPseudoEnthalpyGeometerized (double h, LALSimNeutronStarEOS *eos)
	Returns the pressure in geometerized units (m^-2) at a given value of the dimensionless pseudo-enthalpy. More...
double	XLALSimNeutronStarEOSEnergyDensityOfPseudoEnthalpyGeometerized (double h, LALSimNeutronStarEOS *eos)
	Returns the energy density in geometerized units (m^-2) at a given value of the dimensionless pseudo-enthalpy. More...
double	XLALSimNeutronStarEOSRestMassDensityOfPseudoEnthalpyGeometerized (double h, LALSimNeutronStarEOS *eos)
	Returns the rest mass density in geometerized units (m^-2) at a given value of the dimensionless pseudo-enthalpy. More...
double	XLALSimNeutronStarEOSEnergyDensityDerivOfPressureGeometerized (double p, LALSimNeutronStarEOS *eos)
	Returns the gradient of the energy density with respect to the pressure (dimensionless) at a given value of the pressure in geometerized units (m^-2). More...
double	XLALSimNeutronStarEOSSpeedOfSoundGeometerized (double h, LALSimNeutronStarEOS *eos)
	Returns the speed of sound in geometerized units (dimensionless) at a given value of the pseudo-enthalpy (dimensionless). More...
double	XLALSimNeutronStarEOSEnergyDensityOfPressure (double p, LALSimNeutronStarEOS *eos)
	Returns the energy density (J m^-3) at a given pressure (Pa). More...
double	XLALSimNeutronStarEOSPseudoEnthalpyOfPressure (double p, LALSimNeutronStarEOS *eos)
	Returns the dimensionless pseudo-enthalpy at a given pressure (Pa). More...
double	XLALSimNeutronStarEOSPressureOfPseudoEnthalpy (double h, LALSimNeutronStarEOS *eos)
	Returns the pressure (Pa) at a given value of the dimensionless pseudo-enthalpy. More...
double	XLALSimNeutronStarEOSEnergyDensityOfPseudoEnthalpy (double h, LALSimNeutronStarEOS *eos)
	Returns the energy density (J m^-3) at a given value of the dimensionless pseudo-enthalpy. More...
double	XLALSimNeutronStarEOSRestMassDensityOfPseudoEnthalpy (double h, LALSimNeutronStarEOS *eos)
	Returns the rest mass density (kg m^-3) at a given value of the dimensionless pseudo-enthalpy. More...
double	XLALSimNeutronStarEOSEnergyDensityDerivOfPressure (double p, LALSimNeutronStarEOS *eos)
	Returns the gradient of the energy density with respect to the pressure (dimensionless) at a given value of the pressure (Pa). More...
double	XLALSimNeutronStarEOSSpeedOfSound (double h, LALSimNeutronStarEOS *eos)
	Returns the speed of sound (m s^-1) at a given value of the pseudo-enthalpy (dimensionless). More...
double	XLALSimNeutronStarEOSPressureOfEnergyDensity (double e, LALSimNeutronStarEOS *eos)
	Returns the pressure in Pa at a given energy density in J/m^3. More...
double	XLALSimNeutronStarEOSPressureOfRestMassDensity (double rho, LALSimNeutronStarEOS *eos)
	Returns the pressure in Pa at a given rest-mass density in kg/m^3. More...

Creation routines for dynamic polytrope equations of state
LALSimNeutronStarEOS *	XLALSimNeutronStarEOSDynamicAnalytic (double parameters[], size_t nsec, int causal)
	Reads dynamic analytic eos parameters to make an eos. More...
LALSimNeutronStarEOS *	XLALSimNeutronStarEOS3PieceDynamicPolytrope (double g0, double log10p1_si, double g1, double log10p2_si, double g2)
	Reads 5 dynamic polytrope eos parameters to make an eos. More...
LALSimNeutronStarEOS *	XLALSimNeutronStarEOS3PieceCausalAnalytic (double v1, double log10p1_si, double v2, double log10p2_si, double v3)
	Reads 5 causal analytic eos parameters to make an eos. More...
int	XLALSimNeutronStarEOS3PDViableFamilyCheck (double p0, double log10p1_si, double p1, double log10p2_si, double p2, int causal)
	Check that EOS has enough points (>4) in M-R space to interpolate. More...

Creation routines for piecewise polytrope equations of state
LALSimNeutronStarEOS *	XLALSimNeutronStarEOSPolytrope (double Gamma, double reference_pressure_si, double reference_density_si)
	Creates a polytrope Equation of State defined by p = K rho^Gamma. More...
LALSimNeutronStarEOS *	XLALSimNeutronStarEOS4ParameterPiecewisePolytrope (double logp1_si, double gamma1, double gamma2, double gamma3)
	Creates a 4-parameter piecewise-polytrope Equation of State. More...

Creation routines for spectral decomposition equations of state
LALSimNeutronStarEOS *	XLALSimNeutronStarEOSSpectralDecomposition (double gamma[], int size)
	Reads spectral decomposition eos parameters to make an eos. More...
LALSimNeutronStarEOS *	XLALSimNeutronStarEOS4ParameterSpectralDecomposition (double SDgamma0, double SDgamma1, double SDgamma2, double SDgamma3)
	Reads 4 spectral decomposition eos parameters to make an eos. More...
int	XLALSimNeutronStarEOS4ParamSDGammaCheck (double g0, double g1, double g2, double g3)
	Check that EOS has adiabatic index in range (0.6,4.5) More...
int	XLALSimNeutronStarEOS4ParamSDViableFamilyCheck (double g0, double g1, double g2, double g3)
	Check that EOS has enough points (>4) in M-R space to interpolate. More...

Creation routines for tabulated equations of state
LALSimNeutronStarEOS *	XLALSimNeutronStarEOSFromFile (const char *fname)
	Reads a data file containing a tabulated equation of state. More...
LALSimNeutronStarEOS *	XLALSimNeutronStarEOSByName (const char *name)
	Creates an equation of state structure from tabulated equation of state data of a known name. More...

Function Documentation

XLALDestroySimNeutronStarEOS()

void XLALDestroySimNeutronStarEOS

(

LALSimNeutronStarEOS *

eos

)

Frees the memory associated with a pointer to an EOS structure.

Parameters

eos	Pointer to the EOS structure to be freed.

Definition at line 128 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSName()

char * XLALSimNeutronStarEOSName

(

LALSimNeutronStarEOS *

eos

)

The name of the equation of state.

Parameters

[in]

eos

Pointer to the EOS structure.

Returns

Pointer to a string containing the name of the equation of state.

Warning

The pointer returned might be shallow and might be left dangling if the eos structure is freed.

Definition at line 160 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSMaxPressureGeometerized()

double XLALSimNeutronStarEOSMaxPressureGeometerized

(

LALSimNeutronStarEOS *

eos

)

Returns the maximum pressure of the EOS in geometrized units m^-2.

Parameters

eos	Pointer to the EOS structure.

Returns

The maximum pressure of the EOS in geometrized units m^-2.

Definition at line 170 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSMaxPressure()

double XLALSimNeutronStarEOSMaxPressure

(

LALSimNeutronStarEOS *

eos

)

Returns the maximum pressure of the EOS in Pa.

Parameters

eos	Pointer to the EOS structure.

Returns

The maximum pressure of the EOS in Pa.

Definition at line 181 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSMaxPseudoEnthalpy()

double XLALSimNeutronStarEOSMaxPseudoEnthalpy

(

LALSimNeutronStarEOS *

eos

)

Returns the maximum pseudo enthalpy of the EOS (dimensionless).

Parameters

eos	Pointer to the EOS structure.

Returns

The maximum pseudo enthalpy of the EOS (dimensionless).

Definition at line 194 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSMinAcausalPseudoEnthalpy()

double XLALSimNeutronStarEOSMinAcausalPseudoEnthalpy

(

LALSimNeutronStarEOS *

eos

)

Returns the minimum pseudo-enthalpy at which EOS becomes acausal (speed of sound > speed of light) (dimensionless).

Parameters

eos	Pointer to the EOS structure.

Returns

The minimum pseudo-enthalpy at which EOS becomes acausal (speed of sound > speed of light).

Definition at line 206 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSEnergyDensityOfPressureGeometerized()

double XLALSimNeutronStarEOSEnergyDensityOfPressureGeometerized	(	double	p,
		LALSimNeutronStarEOS *	eos
	)

Returns the energy density in geometerized units (m^-2) at a given pressure in geometerized units (m^-2).

Parameters

p	Pressure in geometerized units (m^-2)
eos	Pointer to the EOS structure.

Returns

The energy density in geometerized units (m^-2).

Definition at line 221 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSPseudoEnthalpyOfPressureGeometerized()

double XLALSimNeutronStarEOSPseudoEnthalpyOfPressureGeometerized	(	double	p,
		LALSimNeutronStarEOS *	eos
	)

Returns the dimensionless pseudo-enthalpy at a given pressure in geometerized units (m^-2).

Parameters

p	Pressure in geometerized units (m^-2)
eos	Pointer to the EOS structure.

Returns

The pseudo-enthalpy (dimensionless).

Definition at line 236 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSPressureOfPseudoEnthalpyGeometerized()

double XLALSimNeutronStarEOSPressureOfPseudoEnthalpyGeometerized	(	double	h,
		LALSimNeutronStarEOS *	eos
	)

Returns the pressure in geometerized units (m^-2) at a given value of the dimensionless pseudo-enthalpy.

Parameters

h	The value of the dimensionless pseudo-enthalpy.
eos	Pointer to the EOS structure.

Returns

The pressure in geometerized units (m^-2).

Definition at line 251 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSEnergyDensityOfPseudoEnthalpyGeometerized()

double XLALSimNeutronStarEOSEnergyDensityOfPseudoEnthalpyGeometerized	(	double	h,
		LALSimNeutronStarEOS *	eos
	)

Returns the energy density in geometerized units (m^-2) at a given value of the dimensionless pseudo-enthalpy.

Parameters

h	The value of the dimensionless pseudo-enthalpy.
eos	Pointer to the EOS structure.

Returns

The energy density in geometerized units (m^-2).

Definition at line 266 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSRestMassDensityOfPseudoEnthalpyGeometerized()

double XLALSimNeutronStarEOSRestMassDensityOfPseudoEnthalpyGeometerized	(	double	h,
		LALSimNeutronStarEOS *	eos
	)

Returns the rest mass density in geometerized units (m^-2) at a given value of the dimensionless pseudo-enthalpy.

Parameters

h	The value of the dimensionless pseudo-enthalpy.
eos	Pointer to the EOS structure.

Returns

The rest mass density in geometerized units (m^-2).

Definition at line 281 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSEnergyDensityDerivOfPressureGeometerized()

double XLALSimNeutronStarEOSEnergyDensityDerivOfPressureGeometerized	(	double	p,
		LALSimNeutronStarEOS *	eos
	)

Returns the gradient of the energy density with respect to the pressure (dimensionless) at a given value of the pressure in geometerized units (m^-2).

Parameters

p	Pressure in geometerized units (m^-2).
eos	Pointer to the EOS structure.

Returns

The gradient of the energy density with respect to the pressure (dimensionless).

Definition at line 298 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSSpeedOfSoundGeometerized()

double XLALSimNeutronStarEOSSpeedOfSoundGeometerized	(	double	h,
		LALSimNeutronStarEOS *	eos
	)

Returns the speed of sound in geometerized units (dimensionless) at a given value of the pseudo-enthalpy (dimensionless).

Parameters

h	The value of the dimensionless pseudo-enthalpy.
eos	Pointer to the EOS structure.

Returns

The speed of sound in geometerized units (dimensionless).

Definition at line 313 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSEnergyDensityOfPressure()

double XLALSimNeutronStarEOSEnergyDensityOfPressure	(	double	p,
		LALSimNeutronStarEOS *	eos
	)

Returns the energy density (J m^-3) at a given pressure (Pa).

Parameters

p	Pressure (Pa).
eos	Pointer to the EOS structure.

Returns

The energy density (J m^3).

Definition at line 329 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSPseudoEnthalpyOfPressure()

double XLALSimNeutronStarEOSPseudoEnthalpyOfPressure	(	double	p,
		LALSimNeutronStarEOS *	eos
	)

Returns the dimensionless pseudo-enthalpy at a given pressure (Pa).

Parameters

p	Pressure (Pa).
eos	Pointer to the EOS structure.

Returns

The pseudo-enthalpy (dimensionless).

Definition at line 345 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSPressureOfPseudoEnthalpy()

double XLALSimNeutronStarEOSPressureOfPseudoEnthalpy	(	double	h,
		LALSimNeutronStarEOS *	eos
	)

Returns the pressure (Pa) at a given value of the dimensionless pseudo-enthalpy.

Parameters

h	The value of the dimensionless pseudo-enthalpy.
eos	Pointer to the EOS structure.

Returns

The pressure (Pa).

Definition at line 361 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSEnergyDensityOfPseudoEnthalpy()

double XLALSimNeutronStarEOSEnergyDensityOfPseudoEnthalpy	(	double	h,
		LALSimNeutronStarEOS *	eos
	)

Returns the energy density (J m^-3) at a given value of the dimensionless pseudo-enthalpy.

Parameters

h	The value of the dimensionless pseudo-enthalpy.
eos	Pointer to the EOS structure.

Returns

The energy density (J m^-3).

Definition at line 377 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSRestMassDensityOfPseudoEnthalpy()

double XLALSimNeutronStarEOSRestMassDensityOfPseudoEnthalpy	(	double	h,
		LALSimNeutronStarEOS *	eos
	)

Returns the rest mass density (kg m^-3) at a given value of the dimensionless pseudo-enthalpy.

Parameters

h	The value of the dimensionless pseudo-enthalpy.
eos	Pointer to the EOS structure.

Returns

The rest mass density (kg m^-3), which is the number density of baryons times the baryon rest mass.

Definition at line 395 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSEnergyDensityDerivOfPressure()

double XLALSimNeutronStarEOSEnergyDensityDerivOfPressure	(	double	p,
		LALSimNeutronStarEOS *	eos
	)

Returns the gradient of the energy density with respect to the pressure (dimensionless) at a given value of the pressure (Pa).

Parameters

p	Pressure (Pa).
eos	Pointer to the EOS structure.

Returns

The gradient of the energy density with respect to the pressure (dimensionless).

Definition at line 414 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSSpeedOfSound()

double XLALSimNeutronStarEOSSpeedOfSound	(	double	h,
		LALSimNeutronStarEOS *	eos
	)

Returns the speed of sound (m s^-1) at a given value of the pseudo-enthalpy (dimensionless).

Parameters

h	The value of the dimensionless pseudo-enthalpy.
eos	Pointer to the EOS structure.

Returns

The speed of sound (m s^-1).

Definition at line 431 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSPressureOfEnergyDensity()

double XLALSimNeutronStarEOSPressureOfEnergyDensity	(	double	e,
		LALSimNeutronStarEOS *	eos
	)

Returns the pressure in Pa at a given energy density in J/m^3.

Parameters

e	energy density in J/m^3
eos	Pointer to the EOS structure.

Returns

The pressure in Pa.

Definition at line 446 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSPressureOfRestMassDensity()

double XLALSimNeutronStarEOSPressureOfRestMassDensity	(	double	rho,
		LALSimNeutronStarEOS *	eos
	)

Returns the pressure in Pa at a given rest-mass density in kg/m^3.

Parameters

rho	rest-mass density in kg/m^3
eos	Pointer to the EOS structure.

Returns

The pressure in Pa.

Definition at line 463 of file LALSimNeutronStarEOS.c.

XLALSimNeutronStarEOSDynamicAnalytic()

LALSimNeutronStarEOS * XLALSimNeutronStarEOSDynamicAnalytic	(	double	parameters[],
		size_t	nsec,
		int	causal
	)

Reads dynamic analytic eos parameters to make an eos.

Reads an array of eos parameters to construct either the causal analytic eos or non-causal analytic polytrope generically outlined in PRD 97, 123019 (2018). The models are dynamic because the stitching pressures are also parameter choices.

Parameters

[in]	parameters[]	Array of dynamic analytic eos parameters. [param0, log10(p1), param1, log10(p2), ... , log10(pN), paramN], where pressure is in SI units, and the params are either gammas (adiabatic indexes) for the non-causal polytrope model or the vs (speed function exponents) for the causal analytic model.
[in]	nsec	The number of sections (pressure sub-domains) to stitch to crust eos.
[in]	causal	Option to use causal version (0=non-causal, 1=causal).

Returns

A pointer to neutron star equation of state structure.

Definition at line 78 of file LALSimNeutronStarEOSDynamicPolytrope.c.

XLALSimNeutronStarEOS3PieceDynamicPolytrope()

LALSimNeutronStarEOS * XLALSimNeutronStarEOS3PieceDynamicPolytrope	(	double	g0,
		double	log10p1_si,
		double	g1,
		double	log10p2_si,
		double	g2
	)

Reads 5 dynamic polytrope eos parameters to make an eos.

Reads 5 dynamic polytrope eos parameters to construct a 3-piece dynamic polytrope eos, generically outlined in PRD 97, 123019 (2018), and stitched to a low-density SLy eos crust.

Parameters

[in]	g0	The adiabatic index of the first polytrope.
[in]	log10p1_si	The log10 of the first dividing pressure in SI units.
[in]	g1	The adiabatic index of the second polytrope.
[in]	log10p2_si	The log10 of the second dividing pressure in SI units.
[in]	g2	The adiabatic index of the third polytrope.

Returns

A pointer to neutron star equation of state structure.

Definition at line 296 of file LALSimNeutronStarEOSDynamicPolytrope.c.

XLALSimNeutronStarEOS3PieceCausalAnalytic()

LALSimNeutronStarEOS * XLALSimNeutronStarEOS3PieceCausalAnalytic	(	double	v1,
		double	log10p1_si,
		double	v2,
		double	log10p2_si,
		double	v3
	)

Reads 5 causal analytic eos parameters to make an eos.

Reads 5 causal analytic eos parameters to construct a 3-piece causal eos, generically outlined in PRD 97, 123019 (2018), and stitched to a low-density SLy eos crust.

Parameters

[in]	v1	The first sound function exponent.
[in]	log10p1_si	The log10 of the first dividing pressure in SI units.
[in]	v2	The second sound function exponent.
[in]	log10p2_si	The log10 of the second dividing pressure in SI units.
[in]	v3	The third sound function exponent.

Returns

A pointer to neutron star equation of state structure.

Definition at line 316 of file LALSimNeutronStarEOSDynamicPolytrope.c.

XLALSimNeutronStarEOS3PDViableFamilyCheck()

int XLALSimNeutronStarEOS3PDViableFamilyCheck	(	double	p0,
		double	log10p1_si,
		double	p1,
		double	log10p2_si,
		double	p2,
		int	causal
	)

Check that EOS has enough points (>4) in M-R space to interpolate.

As the TOV equations are integrated from pmin to pmax, masses are calculated. Once the mass turns over (i.e. m(p_i) > m(p_{i+1})), the integration is terminated. It is possible therefore to have less than 4 points in M-R space. We demand, then, that in the interval [pmin,pmax], m(pmin) = m(p_0) < m(p_1) < m(p_2) < m(p_3).

Reads 3-piece dynamic polytrope (non-causal) or analytic (causal) eos parameters and checks that the eos has at least 4 data points before turning over in M-R space, which abruptly terminates the eos.

Parameters

[in]	p0	First model param, either g0 (non-causal) or v1 (causal).
[in]	log10p1_si	The log10 of the first dividing pressure in SI units.
[in]	p1	Second model param, either g1 (non-causal) or v2 (causal).
[in]	log10p2_si	The log10 of the second dividing pressure in SI units.
[in]	p2	Third model param, either g2 (non-causal) or v3 (causal).
[in]	causal	Option to use causal version (0=non-causal, 1=causal).

Returns

XLAL_SUCCESS or XLAL_FAILURE.

Definition at line 342 of file LALSimNeutronStarEOSDynamicPolytrope.c.

XLALSimNeutronStarEOSPolytrope()

LALSimNeutronStarEOS * XLALSimNeutronStarEOSPolytrope	(	double	Gamma,
		double	reference_pressure_si,
		double	reference_density_si
	)

Creates a polytrope Equation of State defined by p = K rho^Gamma.

Parameters

Gamma	Polytrope adiabatic index.
reference_pressure_si	Reference pressure in Pa.
reference_density_si	Density at the reference pressure in kg/m^3.

Returns

A pointer to a newly created EOS structure.

Definition at line 339 of file LALSimNeutronStarEOSPiecewisePolytrope.c.

XLALSimNeutronStarEOS4ParameterPiecewisePolytrope()

LALSimNeutronStarEOS * XLALSimNeutronStarEOS4ParameterPiecewisePolytrope	(	double	logp1_si,
		double	gamma1,
		double	gamma2,
		double	gamma3
	)

Creates a 4-parameter piecewise-polytrope Equation of State.

A 4-piece piecewise polytrope as described in Physical Review D 79, 124032 (2009) in which the low-density part is fit to the SLY4 EOS. The remaining pieces are described by adiabatic indices gamma1, gamma2, and gamma3, where gamma1 is the adiabatic index for densities < 10^17.7 kg/m^3, gamma2 is the adiabatic index for densities in the range 10^17.7 kg/m^3 to 10^18 kg/m^3, and gamma3 is the adiabatic index for densities > 10^18 kg/m^3. The base-10 logarithm of the pressure in Pa at a density of 10^17.7 kg/m^3 is specified by logp1_si.

Parameters

logp1_si	Base 10 logarithm of the pressure in Pa at the reference density of 10^17.7 kg/m^3.
gamma1	Adiabatic index for densities below 10^17.7 kg/m^3.
gamma2	Adiabatic index for densities from 10^17.7 kg/m^3 to 10^18 kg/m^3.
gamma3	Adiabatic index for densities above 10^18 kg/m^3.

Returns

A pointer to a newly created EOS structure.

Definition at line 417 of file LALSimNeutronStarEOSPiecewisePolytrope.c.

XLALSimNeutronStarEOSSpectralDecomposition()

LALSimNeutronStarEOS * XLALSimNeutronStarEOSSpectralDecomposition	(	double	gamma[],
		int	size
	)

Reads spectral decomposition eos parameters to make an eos.

Reads an array of spectral decomposition eos parameters and the array length to construct an eos using a spectral decomposition of the adiabatic index. The specifics of this implementation are outlined in PRD 98 063004 (2018). Generic model presented in PRD 82 103011 (2010).

Parameters

[in]	gamma[]	Array of spectral decomposition eos parameters.
[in]	size	The length of the gamma array.

Returns

A pointer to neutron star equation of state structure.

Definition at line 181 of file LALSimNeutronStarEOSSpectralDecomposition.c.

XLALSimNeutronStarEOS4ParameterSpectralDecomposition()

LALSimNeutronStarEOS * XLALSimNeutronStarEOS4ParameterSpectralDecomposition	(	double	SDgamma0,
		double	SDgamma1,
		double	SDgamma2,
		double	SDgamma3
	)

Reads 4 spectral decomposition eos parameters to make an eos.

Reads 4 spectral decomposition eos parameters to construct an eos using a spectral decomposition of the adiabatic index, outlined in PRD 82 103011 (2010).

Parameters

[in]

SDgamma0,SDgamma1,SDgamma2,SDgamma3

The spectral decomposition eos parameters.

Returns

A pointer to neutron star equation of state structure.

Definition at line 321 of file LALSimNeutronStarEOSSpectralDecomposition.c.

XLALSimNeutronStarEOS4ParamSDGammaCheck()

int XLALSimNeutronStarEOS4ParamSDGammaCheck	(	double	g0,
		double	g1,
		double	g2,
		double	g3
	)

Check that EOS has adiabatic index in range (0.6,4.5)

Reads 4 spectral decomposition eos parameters and checks that the adiabatic index of the eos is within a range (0.6,4.5), since the TOV solver fails for values outside that range.

Parameters

[in]

g0,g1,g2,g3

The spectral decomposition eos parameters.

Returns

XLAL_SUCCESS or XLAL_FAILURE.

Definition at line 336 of file LALSimNeutronStarEOSSpectralDecomposition.c.

XLALSimNeutronStarEOS4ParamSDViableFamilyCheck()

int XLALSimNeutronStarEOS4ParamSDViableFamilyCheck	(	double	g0,
		double	g1,
		double	g2,
		double	g3
	)

Check that EOS has enough points (>4) in M-R space to interpolate.

As the TOV equations are integrated from pmin to pmax, masses are calculated. Once the mass turns over (i.e. m(p_i) > m(p_{i+1})), the integration is terminated. It is possible therefore to have less than 4 points in M-R space. We demand, then, that in the interval [pmin,pmax], m(pmin) = m(p_0) < m(p_1) < m(p_2) < m(p_3).

Reads 4 spectral decomposition eos parameters and checks that the eos has at least 4 data points before turning over in M-R space, which abruptly terminates the eos.

Parameters

[in]

g0,g1,g2,g3

The spectral decomposition eos parameters.

Returns

XLAL_SUCCESS or XLAL_FAILURE.

Definition at line 401 of file LALSimNeutronStarEOSSpectralDecomposition.c.

XLALSimNeutronStarEOSFromFile()

LALSimNeutronStarEOS * XLALSimNeutronStarEOSFromFile

(

const char *

fname

)

Reads a data file containing a tabulated equation of state.

Read a data file specified by a path fname that contains two whitespace separated columns of equation of state data. The first column contains the pressure in Pa and the second column contains the energy density in J/m^3. Every line beginning with the character '#' then it is ignored. If the path is an absolute path then this specific file is opened; otherwise, search for the file in paths given in the environment variable LALSIM_DATA_PATH, and finally search in the installed PKG_DATA_DIR path.

Parameters

[in]

fname

The path of the file to open.

Returns

A pointer to neutron star equation of state structure.

Definition at line 473 of file LALSimNeutronStarEOSTabular.c.

XLALSimNeutronStarEOSByName()

LALSimNeutronStarEOS * XLALSimNeutronStarEOSByName

(

const char *

name

)

Creates an equation of state structure from tabulated equation of state data of a known name.

The name of the tabulated equation of state must belong to the sample of equations of state from the old frame work or added for the new framework.

A known, installed, named tabulated equation of state data file, whose name is included in the old EOS framework names or the new ones, is read and then used to create the equation of state structure. The equations of state for the OLD framework available are the representative sample drawn from http://xtreme.as.arizona.edu/NeutronStars/ they are:

• ALF1
• ALF2
• ALF3
• ALF4
• AP1
• AP2
• AP3
• AP4
• APR4_EPP
• BBB2
• BGN1H1
• BPAL12
• BSK19
• BSK20
• BSK21
• ENG
• FPS
• GNH3
• GS1
• GS2
• H1
• H2
• H3
• H4
• H5
• H6
• H7
• MPA1
• MS1B
• MS1B_PP
• MS1_PP
• MS1
• MS2
• PAL6
• PCL2
• PS
• QMC700
• SLY4
• SLY
• SQM1
• SQM2
• SQM3
• WFF1
• WFF2
• WFF3 We also include more modern equations from the CompOSE website https://compose.obspm.fr/ downloaded on 18 June 2018. These EOSs are:
• APR
• BHF_BBB2
• KDE0V
• KDE0V1
• RS
• SK255
• SK272
• SKA
• SKB
• SKI2
• SKI3
• SKI4
• SKI5
• SKI6
• SKMP
• SKOP
• SLY2
• SLY230A
• SLY9 And we include HQC18 from http://user.numazu-ct.ac.jp/~sumi/eos/HQC18_submit
• HQC18

Parameters

[in]

name

The name of the equation of state.

Returns

A pointer to neutron star equation of state structure.

Definition at line 642 of file LALSimNeutronStarEOSTabular.c.

Variable Documentation

lalSimNeutronStarEOSNames

const char* const lalSimNeutronStarEOSNames[111]

Recognised equations of state names.

Recognised names of equations of state.

Definition at line 83 of file LALSimNeutronStarEOS.c.