LALSimulation  5.4.0.1-fe68b98
LALSimNeutronStar.h File Reference

Go to the source code of this file.

#define LAL_G_C2_SI   ((LAL_G_SI) / ((double)(LAL_C_SI) * (double)(LAL_C_SI)))
 Factor to convert density in kg/m^3 to geometerized units of m^-2. More...
 
#define LAL_G_C4_SI   ((LAL_G_C2_SI) / ((double)(LAL_C_SI) * (double)(LAL_C_SI)))
 Factor to convert pressure in Pa to geometerized units of m^-2. More...
 
#define LAL_NUCLEAR_DENSITY_SI   2.8e17
 Nuclear density in kg m^-3. More...
 
#define LAL_NUCLEAR_DENSITY_GEOM_SI   ((LAL_NUCLEAR_DENSITY_SI) * (LAL_G_C2_SI))
 Nuclear density in geometrized units of m^-2. More...
 
typedef struct tagLALSimNeutronStarEOS LALSimNeutronStarEOS
 Incomplete type for the neutron star Equation of State (EOS). More...
 
typedef struct tagLALSimNeutronStarFamily LALSimNeutronStarFamily
 Incomplete type for a neutron star family having a particular EOS. More...
 
const char *const lalSimNeutronStarEOSNames [111]
 Recognised names of equations of state. More...
 
void XLALDestroySimNeutronStarEOS (LALSimNeutronStarEOS *eos)
 Frees the memory associated with a pointer to an EOS structure. More...
 
charXLALSimNeutronStarEOSName (LALSimNeutronStarEOS *eos)
 The name of the equation of state. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOSByName (const char *name)
 Creates an equation of state structure from tabulated equation of state data of a known name. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOSFromFile (const char *fname)
 Reads a data file containing a tabulated equation of state. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOSPolytrope (double Gamma, double reference_pressure_si, double reference_density_si)
 Creates a polytrope Equation of State defined by p = K rho^Gamma. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOS4ParameterPiecewisePolytrope (double logp1_si, double gamma1, double gamma2, double gamma3)
 Creates a 4-parameter piecewise-polytrope Equation of State. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOSSpectralDecomposition (double gamma[], int size)
 Reads spectral decomposition eos parameters to make an eos. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOS4ParameterSpectralDecomposition (double SDgamma0, double SDgamma1, double SDgamma2, double SDgamma3)
 Reads 4 spectral decomposition eos parameters to make an eos. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOSDynamicAnalytic (double parameters[], size_t nsec, int causal)
 Reads dynamic analytic eos parameters to make an eos. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOS3PieceDynamicPolytrope (double g0, double log10p1_si, double g1, double log10p2_si, double g2)
 Reads 5 dynamic polytrope eos parameters to make an eos. More...
 
LALSimNeutronStarEOSXLALSimNeutronStarEOS3PieceCausalAnalytic (double v1, double log10p1_si, double v2, double log10p2_si, double v3)
 Reads 5 causal analytic 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...
 
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...
 
double XLALSimNeutronStarEOSMaxPressure (LALSimNeutronStarEOS *eos)
 Returns the maximum pressure of the EOS in Pa. More...
 
double XLALSimNeutronStarEOSMaxPressureGeometerized (LALSimNeutronStarEOS *eos)
 Returns the maximum pressure of the EOS in geometrized units m^-2. 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 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...
 
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...
 
int XLALSimNeutronStarTOVODEIntegrate (double *radius, double *mass, double *love_number_k2, double central_pressure_si, LALSimNeutronStarEOS *eos)
 
int XLALSimNeutronStarTOVODEIntegrateWithTolerance (double *radius, double *mass, double *love_number_k2, double central_pressure_si, LALSimNeutronStarEOS *eos, double epsrel)
 Integrates the Tolman-Oppenheimer-Volkov stellar structure equations. More...
 
int XLALSimNeutronStarVirialODEIntegrate (double *radius, double *mass, double *int1, double *int2, double *int3, double *int4, double *int5, double *int6, double *love_number_k2, double central_pressure_si, LALSimNeutronStarEOS *eos)
 
int XLALSimNeutronStarVirialODEIntegrateWithTolerance (double *radius, double *mass, double *int1, double *int2, double *int3, double *int4, double *int5, double *int6, double *love_number_k2, double central_pressure_si, LALSimNeutronStarEOS *eos, double epsrel)
 Integrates the Tolman-Oppenheimer-Volkov stellar structure equations and the Virial Equations. More...
 
void XLALDestroySimNeutronStarFamily (LALSimNeutronStarFamily *fam)
 Frees the memory associated with a pointer to a neutron star family. More...
 
LALSimNeutronStarFamilyXLALCreateSimNeutronStarFamily (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...
 

Macro Definition Documentation

◆ LAL_G_C2_SI

#define LAL_G_C2_SI   ((LAL_G_SI) / ((double)(LAL_C_SI) * (double)(LAL_C_SI)))

Factor to convert density in kg/m^3 to geometerized units of m^-2.

Definition at line 41 of file LALSimNeutronStar.h.

◆ LAL_G_C4_SI

#define LAL_G_C4_SI   ((LAL_G_C2_SI) / ((double)(LAL_C_SI) * (double)(LAL_C_SI)))

Factor to convert pressure in Pa to geometerized units of m^-2.

Definition at line 44 of file LALSimNeutronStar.h.

◆ LAL_NUCLEAR_DENSITY_SI

#define LAL_NUCLEAR_DENSITY_SI   2.8e17

Nuclear density in kg m^-3.

Definition at line 47 of file LALSimNeutronStar.h.

◆ LAL_NUCLEAR_DENSITY_GEOM_SI

#define LAL_NUCLEAR_DENSITY_GEOM_SI   ((LAL_NUCLEAR_DENSITY_SI) * (LAL_G_C2_SI))

Nuclear density in geometrized units of m^-2.

Definition at line 50 of file LALSimNeutronStar.h.

Typedef Documentation

◆ LALSimNeutronStarEOS

typedef struct tagLALSimNeutronStarEOS LALSimNeutronStarEOS

Incomplete type for the neutron star Equation of State (EOS).

Definition at line 1 of file LALSimNeutronStar.h.

◆ LALSimNeutronStarFamily

typedef struct tagLALSimNeutronStarFamily LALSimNeutronStarFamily

Incomplete type for a neutron star family having a particular EOS.

Definition at line 59 of file LALSimNeutronStar.h.