LALSimIMREOBNRv2.c

Detailed Description

Functions to generate the EOBNRv2 waveforms, as defined in Pan et al, PRD84, 124052(2011).

Author

Craig Robinson

Review status:

EOBNRv2 reviewed by Ilya Mandel, Riccardo Sturani, Prayush Kumar, John Whelan, Yi Pan. Review concluded with git hash b29f20ff11e62095dbd44e850b248ecc58b08a13 (April 2013).

Prototypes
int	XLALSimIMREOBNRv2DominantMode (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fLower, const REAL8 distance, const REAL8 inclination)
	This function generates the plus and cross polarizations for the dominant (2,2) mode of the EOBNRv2 approximant. More...
int	XLALSimIMREOBNRv2AllModes (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fLower, const REAL8 distance, const REAL8 inclination)
	This function generates the plus and cross polarizations for the EOBNRv2 approximant with all available modes included. More...
SphHarmTimeSeries *	XLALSimIMREOBNRv2Modes (const REAL8 deltaT, const REAL8 m1, const REAL8 m2, const REAL8 fLower, const REAL8 distance)
	Wrapper function to generate the -2 spin-weighted spherical harmonic modes (as opposed to generating the polarizations). More...

Function Documentation

XLALSimIMREOBNRv2DominantMode()

int XLALSimIMREOBNRv2DominantMode	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		const REAL8	phiC,
		const REAL8	deltaT,
		const REAL8	m1SI,
		const REAL8	m2SI,
		const REAL8	fLower,
		const REAL8	distance,
		const REAL8	inclination
	)

This function generates the plus and cross polarizations for the dominant (2,2) mode of the EOBNRv2 approximant.

This model is defined in Pan et al, PRD84, 124052(2011).

Parameters

hplus	< The +-polarization waveform (returned)
hcross	< The x-polarization waveform (returned)
phiC	< The phase at the coalescence time (twice the orbital phase at the max orbital frequency moment)
deltaT	< Sampling interval (in seconds)
m1SI	< First component mass (in kg)
m2SI	< Second component mass (in kg)
fLower	< Starting frequency (in Hz)
distance	< Distance to source (in metres)
inclination	< Inclination of the source (in radians)

Definition at line 1692 of file LALSimIMREOBNRv2.c.

XLALSimIMREOBNRv2AllModes()

int XLALSimIMREOBNRv2AllModes	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		const REAL8	phiC,
		const REAL8	deltaT,
		const REAL8	m1SI,
		const REAL8	m2SI,
		const REAL8	fLower,
		const REAL8	distance,
		const REAL8	inclination
	)

This function generates the plus and cross polarizations for the EOBNRv2 approximant with all available modes included.

This model is defined in Pan et al, PRD84, 124052(2011).

Parameters

hplus	< The +-polarization waveform (returned)
hcross	< The x-polarization waveform (returned)
phiC	< The orbital phase at the coalescence time
deltaT	< Sampling interval (in seconds)
m1SI	< First component mass (in kg)
m2SI	< Second component mass (in kg)
fLower	< Starting frequency (in Hz)
distance	< Distance to source (in metres)
inclination	< Inclination of the source (in radians)

Definition at line 1720 of file LALSimIMREOBNRv2.c.

XLALSimIMREOBNRv2Modes()

SphHarmTimeSeries* XLALSimIMREOBNRv2Modes	(	const REAL8	deltaT,
		const REAL8	m1,
		const REAL8	m2,
		const REAL8	fLower,
		const REAL8	distance
	)

Wrapper function to generate the -2 spin-weighted spherical harmonic modes (as opposed to generating the polarizations).

This model is defined in Pan et al, PRD84, 124052(2011). Returns the (2,2), (2,1), (3,3), (4,4), (5,5) SWSH modes in a SphHarmTimeSeries struct.

Parameters

deltaT	Sampling interval (s)
m1	First component mass (kg)
m2	Second component mass (kg)
fLower	Starting GW frequency (Hz)
distance	Distance to sources (m)

Definition at line 1748 of file LALSimIMREOBNRv2.c.