Module LALSimInspiralTaylorF2Ecc.c

Detailed Description

Routines for generating eccentric TaylorF2 waveforms.

Review status:

TaylorF2Ecc is reviewed, with review statement and git has details available at https://git.ligo.org/waveforms/reviews/taylorf2ecc/wikis/home.

Files
file	LALSimInspiralTaylorF2Ecc.c
	Module to compute the eccentric TaylorF2 inspiral waveform for small eccentricity. Code is based on Section IV of Marc, et al paper Phys. Rev. D 93, 124061 (2016), arXiv:1605.00304. Code review page is https://git.ligo.org/waveforms/reviews/taylorf2ecc/wikis/Eccentric-phase-PN-coefficient-form.

Routines for TaylorF2Ecc 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 Section IV of Marc, et al paper Phys. Rev. D 93, 124061 (2016), arXiv:1605.00304. review page is https://git.ligo.org/waveforms/reviews/taylorf2ecc/wikis/Eccentric-phase-PN-coefficient-form.
int	XLALSimInspiralTaylorF2CoreEcc (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, const REAL8 eccentricity, LALDict *p, PNPhasingSeries *pfaP)
int	XLALSimInspiralTaylorF2Ecc (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, const REAL8 eccentricity, LALDict *p)
	Computes the stationary phase approximation to the Fourier transform of a chirp waveform with eccentric correction. More...

Function Documentation

XLALSimInspiralTaylorF2CoreEcc()

int XLALSimInspiralTaylorF2CoreEcc	(	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,
		const REAL8	eccentricity,
		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)
eccentricity	eccentricity effect control < 0 : no eccentricity effect
p	Linked list containing the extra parameters >*
pfaP	Phasing coefficients >*

Definition at line 74 of file LALSimInspiralTaylorF2Ecc.c.

XLALSimInspiralTaylorF2Ecc()

int XLALSimInspiralTaylorF2Ecc	(	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,
		const REAL8	eccentricity,
		LALDict *	p
	)

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

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 See Phys. Rev. Lett. 112, 101101(2014) for eccentric phasing corrections upto 3PN 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)
eccentricity	eccentricity effect control < 0 : no eccentricity effect
p	Linked list containing the extra parameters >*

Definition at line 448 of file LALSimInspiralTaylorF2Ecc.c.