Module LALSimInspiralTaylorXX.c

Detailed Description

Routines to produce Taylor -T1, -T2, -T3, -T4, -F2, and -Et inspiral waveforms.

Review status:

TaylorF2 routines reviewed by Frank Ohme, Andrew Lundgren, Alex Nitz, Alex Nielsen, Salvatore Vitale, Jocelyn Read, Sebastian Khan.

The review concluded with git hash 6106138b2140ffb11bc38fc914e0a1de7082dc4d (Nov 2014) Additional tidal terms up to 7.5PN order reviewed by Ohme, Haney, Khan, Samajdar, Riemenschneider, Setyawati, Hinderer. Concluded with git hash f15615215a7e70488d32137a827d63192cbe3ef6 (February 2019).

Note

If not specified explicitly by the user, the default tidal order will be chosen as 7.0PN, based on the good performance found in https://arxiv.org/pdf/1804.02235.pdf (Fig. 10). However, the user is free to specify any tidal order up to 7.5PN passing the relevant flag through the LALDict.

Routines for TaylorEt Waveforms
See also Section IIIE of Alessandra Buonanno, Bala R Iyer, Evan Ochsner, Yi Pan, and B S Sathyaprakash, "Comparison of post-Newtonian templates for compact binary inspiral signals in gravitational-wave detectors", Phys. Rev. D 80, 084043 (2009), arXiv:0907.0700v1
int	XLALSimInspiralTaylorEtPNEvolveOrbit (REAL8TimeSeries **V, REAL8TimeSeries **phi, REAL8 phic, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, int O)
	Evolves a post-Newtonian orbit using the Taylor Et method. More...
int	XLALSimInspiralTaylorEtPNGenerator (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phic, REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 r, REAL8 i, int amplitudeO, int phaseO)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
int	XLALSimInspiralTaylorEtPN (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phic, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 r, REAL8 i, int O)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
int	XLALSimInspiralTaylorEtPNRestricted (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phic, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 r, REAL8 i, int O)
	Driver routine to compute the restricted post-Newtonian inspiral waveform. More...

Routines for TaylorF2 Waveforms
See also Section IIIF of Alessandra Buonanno, Bala R Iyer, Evan Ochsner, Yi Pan, and B S Sathyaprakash, "Comparison of post-Newtonian templates for compact binary inspiral signals in gravitational-wave detectors", Phys. Rev. D 80, 084043 (2009), arXiv:0907.0700v1
int	XLALSimInspiralTaylorF2AlignedPhasing (PNPhasingSeries **pn, const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 chi2, LALDict *p)
	Returns structure containing TaylorF2 phasing coefficients for given physical parameters. More...
int	XLALSimInspiralTaylorF2AlignedPhasingArray (REAL8Vector **phasingvals, REAL8Vector mass1, REAL8Vector mass2, REAL8Vector chi1, REAL8Vector chi2, REAL8Vector lambda1, REAL8Vector lambda2, REAL8Vector dquadmon1, REAL8Vector dquadmon2)
int	XLALSimInspiralTaylorF2Core (COMPLEX16FrequencySeries **htilde_out, const REAL8Sequence *freqs, const REAL8 phi_ref, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_ref, const REAL8 shft, const REAL8 r, LALDict *p, PNPhasingSeries *pfaP)
int	XLALSimInspiralTaylorF2 (COMPLEX16FrequencySeries **htilde_out, const REAL8 phi_ref, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 S1z, const REAL8 S2z, const REAL8 fStart, const REAL8 fEnd, const REAL8 f_ref, const REAL8 r, LALDict *p)
	Computes the stationary phase approximation to the Fourier transform of a chirp waveform. More...

Routines for TaylorF2-NLTides Waveforms
int	XLALSimInspiralTaylorF2AlignedPhasingNLTides (PNPhasingSeries **pn, const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 chi2, LALDict *p)
	Returns structure containing TaylorF2 phasing coefficients for given physical parameters. More...
int	XLALSimInspiralTaylorF2NLPhase (REAL8Sequence *dphi, const REAL8Sequence *freqs, const REAL8 Anl1, const REAL8 n1, const REAL8 fo1, const REAL8 m1_SI, const REAL8 Anl2, const REAL8 n2, const REAL8 fo2, const REAL8 m2_SI)
int	XLALSimInspiralTaylorF2CoreNLTides (COMPLEX16FrequencySeries **htilde_out, const REAL8Sequence *freqs, const REAL8 phi_ref, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 S1z, const REAL8 S2z, const REAL8 f_ref, const REAL8 shft, const REAL8 r, LALDict *p)
int	XLALSimInspiralTaylorF2NLTides (COMPLEX16FrequencySeries **htilde_out, const REAL8 phi_ref, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 S1z, const REAL8 S2z, const REAL8 fStart, const REAL8 fEnd, const REAL8 f_ref, const REAL8 r, LALDict *p)
	Computes the stationary phase approximation to the Fourier transform of a chirp waveform. More...

Routines for TaylorT1 Waveforms
See also Section IIIA of Alessandra Buonanno, Bala R Iyer, Evan Ochsner, Yi Pan, and B S Sathyaprakash, "Comparison of post-Newtonian templates for compact binary inspiral signals in gravitational-wave detectors", Phys. Rev. D 80, 084043 (2009), arXiv:0907.0700v1
int	XLALSimInspiralTaylorT1PNEvolveOrbit (REAL8TimeSeries **V, REAL8TimeSeries **phi, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Evolves a post-Newtonian orbit using the Taylor T1 method. More...
int	XLALSimInspiralTaylorT1PNGenerator (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
SphHarmTimeSeries *	XLALSimInspiralTaylorT1PNModes (UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO, int lmax)
COMPLEX16TimeSeries *	XLALSimInspiralTaylorT1PNMode (UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO, int l, int m)
	Driver routine to compute the -2 spin-weighted spherical harmonic mode using TaylorT1 phasing. More...
int	XLALSimInspiralTaylorT1PN (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
int	XLALSimInspiralTaylorT1PNRestricted (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Driver routine to compute the restricted post-Newtonian inspiral waveform. More...

Routines for TaylorT2 Waveforms
See also Section IIIC of Alessandra Buonanno, Bala R Iyer, Evan Ochsner, Yi Pan, and B S Sathyaprakash, "Comparison of post-Newtonian templates for compact binary inspiral signals in gravitational-wave detectors", Phys. Rev. D 80, 084043 (2009), arXiv:0907.0700v1
int	XLALSimInspiralTaylorT2PNEvolveOrbit (REAL8TimeSeries **V, REAL8TimeSeries **phi, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Computes a post-Newtonian orbit using the Taylor T2 method. More...
int	XLALSimInspiralTaylorT2PNGenerator (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
SphHarmTimeSeries *	XLALSimInspiralTaylorT2PNModes (UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO, int lmax)
	Driver routine to compute the -2 spin-weighted spherical harmonic modes using TaylorT2 phasing. More...
COMPLEX16TimeSeries *	XLALSimInspiralTaylorT2PNMode (UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO, int l, int m)
	Driver routine to compute the -2 spin-weighted spherical harmonic mode using TaylorT2 phasing. More...
int	XLALSimInspiralTaylorT2PN (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
int	XLALSimInspiralTaylorT2PNRestricted (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Driver routine to compute the restricted post-Newtonian inspiral waveform. More...

Routines for TaylorT3 Waveforms
See also Section IIID of Alessandra Buonanno, Bala R Iyer, Evan Ochsner, Yi Pan, and B S Sathyaprakash, "Comparison of post-Newtonian templates for compact binary inspiral signals in gravitational-wave detectors", Phys. Rev. D 80, 084043 (2009), arXiv:0907.0700v1
int	XLALSimInspiralTaylorT3PNEvolveOrbit (REAL8TimeSeries **V, REAL8TimeSeries **phi, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Computes a post-Newtonian orbit using the Taylor T3 method. More...
int	XLALSimInspiralTaylorT3PNGenerator (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
SphHarmTimeSeries *	XLALSimInspiralTaylorT3PNModes (UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO, int lmax)
	Driver routine to compute the -2 spin-weighted spherical harmonic modes using TaylorT3 phasing. More...
COMPLEX16TimeSeries *	XLALSimInspiralTaylorT3PNMode (UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO, int l, int m)
	Driver routine to compute the -2 spin-weighted spherical harmonic mode using TaylorT3 phasing. More...
int	XLALSimInspiralTaylorT3PN (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
int	XLALSimInspiralTaylorT3PNRestricted (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Driver routine to compute the restricted post-Newtonian inspiral waveform. More...

Routines for TaylorT4 Waveforms
See also Section IIIB of Alessandra Buonanno, Bala R Iyer, Evan Ochsner, Yi Pan, and B S Sathyaprakash, "Comparison of post-Newtonian templates for compact binary inspiral signals in gravitational-wave detectors", Phys. Rev. D 80, 084043 (2009), arXiv:0907.0700v1
int	XLALSimInspiralTaylorT4PNEvolveOrbit (REAL8TimeSeries **v, REAL8TimeSeries **phi, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Evolves a post-Newtonian orbit using the Taylor T4 method. More...
int	XLALSimInspiralTaylorT4PNGenerator (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
SphHarmTimeSeries *	XLALSimInspiralTaylorT4PNModes (UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO, int lmax)
	Driver routine to compute the -2 spin-weighted spherical harmonic modes using TaylorT4 phasing. More...
COMPLEX16TimeSeries *	XLALSimInspiralTaylorT4PNMode (UNUSED REAL8 v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int amplitudeO, int phaseO, int l, int m)
	Driver routine to compute the -2 spin-weighted spherical harmonic mode using TaylorT4 phasing. More...
int	XLALSimInspiralTaylorT4PN (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
int	XLALSimInspiralTaylorT4PNRestricted (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 lambda1, REAL8 lambda2, LALSimInspiralTidalOrder tideO, int O)
	Driver routine to compute the restricted post-Newtonian inspiral waveform. More...

Function Documentation

XLALSimInspiralTaylorEtPNEvolveOrbit()

int XLALSimInspiralTaylorEtPNEvolveOrbit	(	REAL8TimeSeries **	V,
		REAL8TimeSeries **	phi,
		REAL8	phic,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		int	O
	)

Evolves a post-Newtonian orbit using the Taylor Et method.

See Section IIIE: Alessandra Buonanno, Bala R Iyer, Evan Ochsner, Yi Pan, and B S Sathyaprakash, "Comparison of post-Newtonian templates for compact binary inspiral signals in gravitational-wave detectors", Phys. Rev. D 80, 084043 (2009), arXiv:0907.0700v1

Parameters

V	post-Newtonian parameter [returned]
phi	orbital phase [returned]
phic	orbital phase at end
deltaT	sampling interval
m1	mass of companion 1
m2	mass of companion 2
f_min	start frequency
O	twice post-Newtonian order

Definition at line 474 of file LALSimInspiralTaylorEt.c.

XLALSimInspiralTaylorEtPNGenerator()

int XLALSimInspiralTaylorEtPNGenerator	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phic,
		REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	r,
		REAL8	i,
		int	amplitudeO,
		int	phaseO
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine allows the user to specify different pN orders for phasing calcuation vs. amplitude calculations.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phic	orbital phase at end
v0	tail-term gauge choice (default = 1)
deltaT	sampling interval
m1	mass of companion 1
m2	mass of companion 2
f_min	start frequency
r	distance of source
i	inclination of source (rad)
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order

Definition at line 577 of file LALSimInspiralTaylorEt.c.

XLALSimInspiralTaylorEtPN()

int XLALSimInspiralTaylorEtPN	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phic,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	r,
		REAL8	i,
		int	O
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine uses the same pN order for phasing and amplitude (unless the order is -1 in which case the highest available order is used for both of these – which might not be the same).

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phic	orbital phase at end
deltaT	sampling interval
m1	mass of companion 1
m2	mass of companion 2
f_min	start frequency
r	distance of source
i	inclination of source (rad)
O	twice post-Newtonian order

Definition at line 617 of file LALSimInspiralTaylorEt.c.

XLALSimInspiralTaylorEtPNRestricted()

int XLALSimInspiralTaylorEtPNRestricted	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phic,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	r,
		REAL8	i,
		int	O
	)

Driver routine to compute the restricted post-Newtonian inspiral waveform.

This routine computes the phasing to the specified order, but only computes the amplitudes to the Newtonian (quadrupole) order.

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phic	orbital phase at end
deltaT	sampling interval
m1	mass of companion 1
m2	mass of companion 2
f_min	start frequency
r	distance of source
i	inclination of source (rad)
O	twice post-Newtonian phase order

Definition at line 643 of file LALSimInspiralTaylorEt.c.

XLALSimInspiralTaylorF2AlignedPhasing()

int XLALSimInspiralTaylorF2AlignedPhasing	(	PNPhasingSeries **	pn,
		const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi1,
		const REAL8	chi2,
		LALDict *	p
	)

Returns structure containing TaylorF2 phasing coefficients for given physical parameters.

Parameters

pn	phasing coefficients (output)
m1	mass of body 1
m2	mass of body 2
chi1	aligned spin parameter of body 1
chi2	aligned spin parameter of body 2
p	LAL dictionary containing accessory parameters

Definition at line 73 of file LALSimInspiralTaylorF2.c.

XLALSimInspiralTaylorF2AlignedPhasingArray()

int XLALSimInspiralTaylorF2AlignedPhasingArray	(	REAL8Vector **	phasingvals,
		REAL8Vector	mass1,
		REAL8Vector	mass2,
		REAL8Vector	chi1,
		REAL8Vector	chi2,
		REAL8Vector	lambda1,
		REAL8Vector	lambda2,
		REAL8Vector	dquadmon1,
		REAL8Vector	dquadmon2
	)

Parameters

phasingvals	phasing coefficients (output)
mass1	Masses of heavier bodies
mass2	Masses of lighter bodies
chi1	Aligned spin of body 1
chi2	Aligned spin of body 2
lambda1	Tidal deformation of body 1
lambda2	Tidal deformation of body 2
dquadmon1	Self-spin deformation of body 1
dquadmon2	Self-spin deformation of body 2

Definition at line 97 of file LALSimInspiralTaylorF2.c.

XLALSimInspiralTaylorF2Core()

int XLALSimInspiralTaylorF2Core	(	COMPLEX16FrequencySeries **	htilde_out,
		const REAL8Sequence *	freqs,
		const REAL8	phi_ref,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	f_ref,
		const REAL8	shft,
		const REAL8	r,
		LALDict *	p,
		PNPhasingSeries *	pfaP
	)

Parameters

htilde_out	FD waveform
freqs	frequency points at which to evaluate the waveform (Hz)
phi_ref	reference orbital phase (rad)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
f_ref	Reference GW frequency (Hz) - if 0 reference point is coalescence
shft	time shift to be applied to frequency-domain phase (sec)
r	distance of source (m)
p	Linked list containing the extra testing GR parameters >
pfaP	Phasing coefficients >*

Definition at line 146 of file LALSimInspiralTaylorF2.c.

XLALSimInspiralTaylorF2()

int XLALSimInspiralTaylorF2	(	COMPLEX16FrequencySeries **	htilde_out,
		const REAL8	phi_ref,
		const REAL8	deltaF,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	S1z,
		const REAL8	S2z,
		const REAL8	fStart,
		const REAL8	fEnd,
		const REAL8	f_ref,
		const REAL8	r,
		LALDict *	p
	)

Computes the stationary phase approximation to the Fourier transform of a chirp waveform.

The amplitude is given by expanding \(1/\sqrt{\dot{F}}\). If the PN order is set to -1, then the highest implemented order is used.

Note

f_ref is the GW frequency at which phi_ref is defined. The most common choice in the literature is to choose the reference point as "coalescence", when the frequency becomes infinite. This is the behavior of the code when f_ref==0. If f_ref > 0, phi_ref sets the orbital phase at that GW frequency.

See arXiv:0810.5336 and arXiv:astro-ph/0504538 for spin corrections to the phasing. See arXiv:1303.7412 for spin-orbit phasing corrections at 3 and 3.5PN order

The spin and tidal order enums are defined in LALSimInspiralWaveformFlags.h

Parameters

htilde_out	FD waveform
phi_ref	reference orbital phase (rad)
deltaF	frequency resolution
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
S1z	z component of the spin of companion 1
S2z	z component of the spin of companion 2
fStart	start GW frequency (Hz)
fEnd	highest GW frequency (Hz) of waveform generation - if 0, end at Schwarzschild ISCO
f_ref	Reference GW frequency (Hz) - if 0 reference point is coalescence
r	distance of source (m)
p	Linked list containing the extra testing GR parameters >*

Definition at line 503 of file LALSimInspiralTaylorF2.c.

XLALSimInspiralTaylorF2AlignedPhasingNLTides()

int XLALSimInspiralTaylorF2AlignedPhasingNLTides	(	PNPhasingSeries **	pn,
		const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi1,
		const REAL8	chi2,
		LALDict *	p
	)

Returns structure containing TaylorF2 phasing coefficients for given physical parameters.

Parameters

pn	phasing coefficients (output)
m1	mass of body 1
m2	mass of body 2
chi1	aligned spin parameter of body 1
chi2	aligned spin parameter of body 2
p	LAL dictionary containing accessory parameters

Definition at line 54 of file LALSimInspiralTaylorF2NLTides.c.

XLALSimInspiralTaylorF2NLPhase()

int XLALSimInspiralTaylorF2NLPhase	(	REAL8Sequence *	dphi,
		const REAL8Sequence *	freqs,
		const REAL8	Anl1,
		const REAL8	n1,
		const REAL8	fo1,
		const REAL8	m1_SI,
		const REAL8	Anl2,
		const REAL8	n2,
		const REAL8	fo2,
		const REAL8	m2_SI
	)

Parameters

dphi	the arrary for the NL phase errors, should be the same length as freqs
freqs	frequency array [Hz], should be the same length as dphi
Anl1	the amplitude of the phase shift from m1
n1	the spectral index of the phase shift from m1
fo1	the 'turn-on' frequency for the phase shift in m1 [Hz]
m1_SI	the primary mass [kg]
Anl2	the amplitude of the phase shift from m2
n2	the spectral index of the phase shift from m2
fo2	the 'turn-on' frequency for the phase shift in m2 [Hz]
m2_SI	the secondary mass [kg]

Definition at line 81 of file LALSimInspiralTaylorF2NLTides.c.

XLALSimInspiralTaylorF2CoreNLTides()

int XLALSimInspiralTaylorF2CoreNLTides	(	COMPLEX16FrequencySeries **	htilde_out,
		const REAL8Sequence *	freqs,
		const REAL8	phi_ref,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	S1z,
		const REAL8	S2z,
		const REAL8	f_ref,
		const REAL8	shft,
		const REAL8	r,
		LALDict *	p
	)

Parameters

htilde_out	FD waveform
freqs	frequency points at which to evaluate the waveform (Hz)
phi_ref	reference orbital phase (rad)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
S1z	z component of the spin of companion 1
S2z	z component of the spin of companion 2
f_ref	Reference GW frequency (Hz) - if 0 reference point is coalescence
shft	time shift to be applied to frequency-domain phase (sec)
r	distance of source (m)
p	Linked list containing the extra testing GR parameters >*

Definition at line 227 of file LALSimInspiralTaylorF2NLTides.c.

XLALSimInspiralTaylorF2NLTides()

int XLALSimInspiralTaylorF2NLTides	(	COMPLEX16FrequencySeries **	htilde_out,
		const REAL8	phi_ref,
		const REAL8	deltaF,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	S1z,
		const REAL8	S2z,
		const REAL8	fStart,
		const REAL8	fEnd,
		const REAL8	f_ref,
		const REAL8	r,
		LALDict *	p
	)

Computes the stationary phase approximation to the Fourier transform of a chirp waveform.

The amplitude is given by expanding \(1/\sqrt{\dot{F}}\). If the PN order is set to -1, then the highest implemented order is used.

Note

f_ref is the GW frequency at which phi_ref is defined. The most common choice in the literature is to choose the reference point as "coalescence", when the frequency becomes infinite. This is the behavior of the code when f_ref==0. If f_ref > 0, phi_ref sets the orbital phase at that GW frequency.

See arXiv:0810.5336 and arXiv:astro-ph/0504538 for spin corrections to the phasing. See arXiv:1303.7412 for spin-orbit phasing corrections at 3 and 3.5PN order

The spin and tidal order enums are defined in LALSimInspiralWaveformFlags.h

Parameters

htilde_out	FD waveform
phi_ref	reference orbital phase (rad)
deltaF	frequency resolution
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
S1z	z component of the spin of companion 1
S2z	z component of the spin of companion 2
fStart	start GW frequency (Hz)
fEnd	highest GW frequency (Hz) of waveform generation - if 0, end at Schwarzschild ISCO
f_ref	Reference GW frequency (Hz) - if 0 reference point is coalescence
r	distance of source (m)
p	Linked list containing the extra testing GR parameters >*

Definition at line 578 of file LALSimInspiralTaylorF2NLTides.c.

XLALSimInspiralTaylorT1PNEvolveOrbit()

int XLALSimInspiralTaylorT1PNEvolveOrbit	(	REAL8TimeSeries **	V,
		REAL8TimeSeries **	phi,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Evolves a post-Newtonian orbit using the Taylor T1 method.

See Section IIIA: Alessandra Buonanno, Bala R Iyer, Evan Ochsner, Yi Pan, and B S Sathyaprakash, "Comparison of post-Newtonian templates for compact binary inspiral signals in gravitational-wave detectors", Phys. Rev. D 80, 084043 (2009), arXiv:0907.0700v1

Parameters

V	post-Newtonian parameter [returned]
phi	orbital phase [returned]
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian order

Definition at line 294 of file LALSimInspiralTaylorT1.c.

XLALSimInspiralTaylorT1PNGenerator()

int XLALSimInspiralTaylorT1PNGenerator	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine allows the user to specify different pN orders for phasing calcuation vs. amplitude calculations.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order

Definition at line 413 of file LALSimInspiralTaylorT1.c.

XLALSimInspiralTaylorT1PNModes()

SphHarmTimeSeries* XLALSimInspiralTaylorT1PNModes	(	UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO,
		int	lmax
	)

Parameters

v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
lambda1	(tidal deformability of body 1)/(individual mass of body 1)^5
lambda2	(tidal deformability of body 2)/(individual mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order
lmax	generate all modes with l <= lmax

Definition at line 472 of file LALSimInspiralTaylorT1.c.

XLALSimInspiralTaylorT1PNMode()

COMPLEX16TimeSeries* XLALSimInspiralTaylorT1PNMode	(	UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO,
		int	l,
		int	m
	)

Driver routine to compute the -2 spin-weighted spherical harmonic mode using TaylorT1 phasing.

Parameters

v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
lambda1	(tidal deformability of body 1)/(individual mass of body 1)^5
lambda2	(tidal deformability of body 2)/(individual mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order
l	l index of mode
m	m index of mode

Definition at line 541 of file LALSimInspiralTaylorT1.c.

XLALSimInspiralTaylorT1PN()

int XLALSimInspiralTaylorT1PN	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine uses the same pN order for phasing and amplitude (unless the order is -1 in which case the highest available order is used for both of these – which might not be the same).

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian order

Definition at line 608 of file LALSimInspiralTaylorT1.c.

XLALSimInspiralTaylorT1PNRestricted()

int XLALSimInspiralTaylorT1PNRestricted	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Driver routine to compute the restricted post-Newtonian inspiral waveform.

This routine computes the phasing to the specified order, but only computes the amplitudes to the Newtonian (quadrupole) order.

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian phase order

Definition at line 640 of file LALSimInspiralTaylorT1.c.

XLALSimInspiralTaylorT2PNEvolveOrbit()

int XLALSimInspiralTaylorT2PNEvolveOrbit	(	REAL8TimeSeries **	V,
		REAL8TimeSeries **	phi,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Computes a post-Newtonian orbit using the Taylor T2 method.

Parameters

V	post-Newtonian parameter [returned]
phi	orbital phase [returned]
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	twice PN order of tidal effects
O	twice post-Newtonian order

Definition at line 745 of file LALSimInspiralTaylorT2.c.

XLALSimInspiralTaylorT2PNGenerator()

int XLALSimInspiralTaylorT2PNGenerator	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine allows the user to specify different pN orders for phasing calcuation vs. amplitude calculations.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	twice PN order of tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order

Definition at line 932 of file LALSimInspiralTaylorT2.c.

XLALSimInspiralTaylorT2PNModes()

SphHarmTimeSeries* XLALSimInspiralTaylorT2PNModes	(	UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO,
		int	lmax
	)

Driver routine to compute the -2 spin-weighted spherical harmonic modes using TaylorT2 phasing.

Parameters

v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	twice PN order of tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order
lmax	generate all modes with l <= lmax

Definition at line 996 of file LALSimInspiralTaylorT2.c.

XLALSimInspiralTaylorT2PNMode()

COMPLEX16TimeSeries* XLALSimInspiralTaylorT2PNMode	(	UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO,
		int	l,
		int	m
	)

Driver routine to compute the -2 spin-weighted spherical harmonic mode using TaylorT2 phasing.

Parameters

v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	twice PN order of tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order
l	l index of mode
m	m index of mode

Definition at line 1065 of file LALSimInspiralTaylorT2.c.

XLALSimInspiralTaylorT2PN()

int XLALSimInspiralTaylorT2PN	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine uses the same pN order for phasing and amplitude (unless the order is -1 in which case the highest available order is used for both of these – which might not be the same).

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	twice PN order of tidal effects
O	twice post-Newtonian order

Definition at line 1129 of file LALSimInspiralTaylorT2.c.

XLALSimInspiralTaylorT2PNRestricted()

int XLALSimInspiralTaylorT2PNRestricted	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Driver routine to compute the restricted post-Newtonian inspiral waveform.

This routine computes the phasing to the specified order, but only computes the amplitudes to the Newtonian (quadrupole) order.

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	twice PN order of tidal effects
O	twice post-Newtonian phase order

Definition at line 1160 of file LALSimInspiralTaylorT2.c.

XLALSimInspiralTaylorT3PNEvolveOrbit()

int XLALSimInspiralTaylorT3PNEvolveOrbit	(	REAL8TimeSeries **	V,
		REAL8TimeSeries **	phi,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Computes a post-Newtonian orbit using the Taylor T3 method.

Parameters

V	post-Newtonian parameter [returned]
phi	orbital phase [returned]
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian order

Definition at line 802 of file LALSimInspiralTaylorT3.c.

XLALSimInspiralTaylorT3PNGenerator()

int XLALSimInspiralTaylorT3PNGenerator	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine allows the user to specify different pN orders for phasing calcuation vs. amplitude calculations.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order

Definition at line 1002 of file LALSimInspiralTaylorT3.c.

XLALSimInspiralTaylorT3PNModes()

SphHarmTimeSeries* XLALSimInspiralTaylorT3PNModes	(	UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO,
		int	lmax
	)

Driver routine to compute the -2 spin-weighted spherical harmonic modes using TaylorT3 phasing.

Parameters

v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order
lmax	generate all modes with l <= lmax

Definition at line 1042 of file LALSimInspiralTaylorT3.c.

XLALSimInspiralTaylorT3PNMode()

COMPLEX16TimeSeries* XLALSimInspiralTaylorT3PNMode	(	UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO,
		int	l,
		int	m
	)

Driver routine to compute the -2 spin-weighted spherical harmonic mode using TaylorT3 phasing.

Parameters

v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order
l	l index of mode
m	m index of mode

Definition at line 1111 of file LALSimInspiralTaylorT3.c.

XLALSimInspiralTaylorT3PN()

int XLALSimInspiralTaylorT3PN	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine uses the same pN order for phasing and amplitude (unless the order is -1 in which case the highest available order is used for both of these – which might not be the same).

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian order

Definition at line 1175 of file LALSimInspiralTaylorT3.c.

XLALSimInspiralTaylorT3PNRestricted()

int XLALSimInspiralTaylorT3PNRestricted	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Driver routine to compute the restricted post-Newtonian inspiral waveform.

This routine computes the phasing to the specified order, but only computes the amplitudes to the Newtonian (quadrupole) order.

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian phase order

Definition at line 1207 of file LALSimInspiralTaylorT3.c.

XLALSimInspiralTaylorT4PNEvolveOrbit()

int XLALSimInspiralTaylorT4PNEvolveOrbit	(	REAL8TimeSeries **	v,
		REAL8TimeSeries **	phi,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Evolves a post-Newtonian orbit using the Taylor T4 method.

See: Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsky "High-accuracy comparison of numerical relativity simulations with post-Newtonian expansions" arXiv:0710.0158v2.

Parameters

v	post-Newtonian parameter [returned]
phi	orbital phase [returned]
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	start frequency (Hz)
fRef	reference frequency (Hz)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian order

Definition at line 451 of file LALSimInspiralTaylorT4.c.

XLALSimInspiralTaylorT4PNGenerator()

int XLALSimInspiralTaylorT4PNGenerator	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine allows the user to specify different pN orders for phasing calcuation vs. amplitude calculations.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	start frequency (Hz)
fRef	reference frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order

Definition at line 571 of file LALSimInspiralTaylorT4.c.

XLALSimInspiralTaylorT4PNModes()

SphHarmTimeSeries* XLALSimInspiralTaylorT4PNModes	(	UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO,
		int	lmax
	)

Driver routine to compute the -2 spin-weighted spherical harmonic modes using TaylorT4 phasing.

Parameters

v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order
lmax	generate all modes with l <= lmax

Definition at line 636 of file LALSimInspiralTaylorT4.c.

XLALSimInspiralTaylorT4PNMode()

COMPLEX16TimeSeries* XLALSimInspiralTaylorT4PNMode	(	UNUSED REAL8	v0,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	amplitudeO,
		int	phaseO,
		int	l,
		int	m
	)

Driver routine to compute the -2 spin-weighted spherical harmonic mode using TaylorT4 phasing.

Parameters

v0	tail-term gauge choice (default = 1)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order
l	l index of mode
m	m index of mode

Definition at line 705 of file LALSimInspiralTaylorT4.c.

XLALSimInspiralTaylorT4PN()

int XLALSimInspiralTaylorT4PN	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine uses the same pN order for phasing and amplitude (unless the order is -1 in which case the highest available order is used for both of these – which might not be the same).

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (Hz)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	start frequency (Hz)
fRef	reference frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian order

Definition at line 769 of file LALSimInspiralTaylorT4.c.

XLALSimInspiralTaylorT4PNRestricted()

int XLALSimInspiralTaylorT4PNRestricted	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	lambda1,
		REAL8	lambda2,
		LALSimInspiralTidalOrder	tideO,
		int	O
	)

Driver routine to compute the restricted post-Newtonian inspiral waveform.

This routine computes the phasing to the specified order, but only computes the amplitudes to the Newtonian (quadrupole) order.

Constant log term in amplitude set to 1. This is a gauge choice.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
f_min	start frequency (Hz)
fRef	reference frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
lambda1	(tidal deformability of body 1)/(mass of body 1)^5
lambda2	(tidal deformability of body 2)/(mass of body 2)^5
tideO	flag to control spin and tidal effects
O	twice post-Newtonian phase order

Definition at line 800 of file LALSimInspiralTaylorT4.c.