Module LALSimInspiralEccentricTD.c

Detailed Description

Routines to generate time-domain eccentric inspiral waveforms.

Prototypes
int	XLALSimInspiralEccentricTDPNEvolveOrbit (REAL8TimeSeries **v, REAL8TimeSeries **et, REAL8TimeSeries **l, REAL8TimeSeries **lambda, REAL8TimeSeries **u, REAL8TimeSeries **phi, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 e_min, int O)
	Evolves a post-Newtonian orbit using the eccentric Taylor T4 method. More...
int	XLALSimInspiralEccentricTDPNGenerator (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 e_min, int amplitudeO, int phaseO)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
int	XLALSimInspiralEccentricTDPN (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 e_min, int O)
	Driver routine to compute the post-Newtonian inspiral waveform. More...
int	XLALSimInspiralEccentricTDPNRestricted (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 fRef, REAL8 r, REAL8 i, REAL8 e_min, int O)
	Driver routine to compute the restricted post-Newtonian inspiral waveform. More...

Function Documentation

XLALSimInspiralEccentricTDPNEvolveOrbit()

int XLALSimInspiralEccentricTDPNEvolveOrbit	(	REAL8TimeSeries **	v,
		REAL8TimeSeries **	et,
		REAL8TimeSeries **	l,
		REAL8TimeSeries **	lambda,
		REAL8TimeSeries **	u,
		REAL8TimeSeries **	phi,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	e_min,
		int	O
	)

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

See: Sashwat Tanay, Maria Haney, and Achamveedu Gopakumar, "Frequency and time domain inspiral waveforms from comparable mass compact binaries in eccentric orbits", (2015); arXiv:TBD https://dcc.ligo.org/P1500148-v1

Parameters

v	post-Newtonian parameter [returned]
et	orbital eccentricity [returned]
l	mean anomaly of quasi-Keplerian orbit [returned]
lambda	secular contribution to orbital phase [returned]
u	eccentric anomaly of quasi-Keplerian orbit [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)
e_min	initial orbital eccentricity at f_min
O	twice post-Newtonian order

Definition at line 809 of file LALSimInspiralEccentricTD.c.

XLALSimInspiralEccentricTDPNGenerator()

int XLALSimInspiralEccentricTDPNGenerator	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	e_min,
		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 calculation vs. amplitude calculations.

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)
e_min	initial orbital eccentricity at f_min
amplitudeO	twice post-Newtonian amplitude order
phaseO	twice post-Newtonian phase order

Definition at line 1012 of file LALSimInspiralEccentricTD.c.

XLALSimInspiralEccentricTDPN()

int XLALSimInspiralEccentricTDPN	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	e_min,
		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).

Note that at present phasing calculations for eccentric waveforms are implemented up to 2PN order, while amplitude calculations are accurate up to Newtonian (quadrupolar) order. Higher-order contributions to phasing and amplitude calculations will be implemented in the near future.

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)
e_min	initial orbital eccentricity at f_min
O	twice post-Newtonian order

Definition at line 1098 of file LALSimInspiralEccentricTD.c.

XLALSimInspiralEccentricTDPNRestricted()

int XLALSimInspiralEccentricTDPNRestricted	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	phiRef,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	f_min,
		REAL8	fRef,
		REAL8	r,
		REAL8	i,
		REAL8	e_min,
		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.

Note that amplitudes of eccentric waveforms are at present Newtonian order by default. Amplitude corrections will be implemented in the near future.

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)
e_min	initial orbital eccentricity at f_min
O	twice post-Newtonian phase order

Definition at line 1127 of file LALSimInspiralEccentricTD.c.