Module LALSimNeutronStarFamily.c

Detailed Description

Provides routines for one-parameter families of neutron stars of a given equation of state.

Author

Jolien Creighton

Prototypes
void	XLALDestroySimNeutronStarFamily (LALSimNeutronStarFamily *fam)
	Frees the memory associated with a pointer to a neutron star family. More...
LALSimNeutronStarFamily *	XLALCreateSimNeutronStarFamily (LALSimNeutronStarEOS *eos)
	Creates a neutron star family structure for a given equation of state. More...
double	XLALSimNeutronStarFamMinimumMass (LALSimNeutronStarFamily *fam)
	Returns the minimum mass of a neutron star family. More...
double	XLALSimNeutronStarMaximumMass (LALSimNeutronStarFamily *fam)
	Returns the maximum mass of a neutron star family. More...
double	XLALSimNeutronStarCentralPressure (double m, LALSimNeutronStarFamily *fam)
	Returns the central pressure of a neutron star of mass m. More...
double	XLALSimNeutronStarRadius (double m, LALSimNeutronStarFamily *fam)
	Returns the radius of a neutron star of mass m. More...
double	XLALSimNeutronStarLoveNumberK2 (double m, LALSimNeutronStarFamily *fam)
	Returns the tidal Love number k2 of a neutron star of mass m. More...

Variables
GSL_VAR const gsl_interp_type *	lal_gsl_interp_steffen

Function Documentation

XLALDestroySimNeutronStarFamily()

void XLALDestroySimNeutronStarFamily

(

LALSimNeutronStarFamily *

fam

)

Frees the memory associated with a pointer to a neutron star family.

Parameters

fam	Pointer to the neutron star family structure to be freed.

Definition at line 69 of file LALSimNeutronStarFamily.c.

XLALCreateSimNeutronStarFamily()

LALSimNeutronStarFamily* XLALCreateSimNeutronStarFamily

(

LALSimNeutronStarEOS *

eos

)

Creates a neutron star family structure for a given equation of state.

A neutron star family is a one-parameter family of neturon stars for a fixed equation of state. The one parameter is the neutron star central pressure, or, equivalently, the mass of the neutron star. The family is terminated at the maximum neutron star mass for the specified equation of state, so the mass can be used as the family parameter.

Parameters

eos	Pointer to the Equation of State structure.

Returns

A pointer to the neutron star family structure.

Definition at line 98 of file LALSimNeutronStarFamily.c.

XLALSimNeutronStarFamMinimumMass()

double XLALSimNeutronStarFamMinimumMass

(

LALSimNeutronStarFamily *

fam

)

Returns the minimum mass of a neutron star family.

Parameters

fam	Pointer to the neutron star family structure.

Returns

The maximum mass of the neutron star family (kg).

Definition at line 198 of file LALSimNeutronStarFamily.c.

XLALSimNeutronStarMaximumMass()

double XLALSimNeutronStarMaximumMass

(

LALSimNeutronStarFamily *

fam

)

Returns the maximum mass of a neutron star family.

Parameters

fam	Pointer to the neutron star family structure.

Returns

The maximum mass of the neutron star family (kg).

Definition at line 208 of file LALSimNeutronStarFamily.c.

XLALSimNeutronStarCentralPressure()

double XLALSimNeutronStarCentralPressure	(	double	m,
		LALSimNeutronStarFamily *	fam
	)

Returns the central pressure of a neutron star of mass m.

Parameters

m	The mass of the neutron star (kg).
fam	Pointer to the neutron star family structure.

Returns

The central pressure of the neutron star (Pa).

Definition at line 219 of file LALSimNeutronStarFamily.c.

XLALSimNeutronStarRadius()

double XLALSimNeutronStarRadius	(	double	m,
		LALSimNeutronStarFamily *	fam
	)

Returns the radius of a neutron star of mass m.

Parameters

m	The mass of the neutron star (kg).
fam	Pointer to the neutron star family structure.

Returns

The radius of the neutron star (m).

Definition at line 234 of file LALSimNeutronStarFamily.c.

XLALSimNeutronStarLoveNumberK2()

double XLALSimNeutronStarLoveNumberK2	(	double	m,
		LALSimNeutronStarFamily *	fam
	)

Returns the tidal Love number k2 of a neutron star of mass m.

Parameters

m	The mass of the neutron star (kg).
fam	Pointer to the neutron star family structure.

Returns

The dimensionless tidal Love number k2.

Definition at line 248 of file LALSimNeutronStarFamily.c.

Variable Documentation

lal_gsl_interp_steffen

GSL_VAR const gsl_interp_type* lal_gsl_interp_steffen

Definition at line 31 of file LALSimNeutronStarFamily.c.