Prototypes
static REAL8	XLALCalculateA5 (const REAL8 eta)
	Calculates the a5 parameter in the A potential function in EOBNRv2. More...

static REAL8	XLALCalculateA6 (REAL8 eta)

static REAL8	XLALCalculateEOBD (REAL8 r, REAL8 eta)
	Calculate the EOB D function. More...

static REAL8	XLALCalculateA6 (const REAL8 UNUSED eta)
	Calculates the a6 parameter in the A potential function in EOBNRv2. More...

static UNUSED int	XLALCalculateEOBACoefficients (EOBACoefficients *const coeffs, const REAL8 eta)
	Function to pre-compute the coefficients in the EOB A potential function. More...

static REAL8	XLALCalculateEOBA (const REAL8 r, EOBACoefficients *restrict coeffs)
	This function calculates the EOB A function which using the pre-computed coefficients which should already have been calculated. More...

static REAL8	XLALCalculateEOBdAdr (const REAL8 r, EOBACoefficients *restrict coeffs)
	Calculated the derivative of the EOB A function with respect to r, using the pre-computed A coefficients. More...

static REAL8	XLALEffectiveHamiltonian (const REAL8 eta, const REAL8 r, const REAL8 pr, const REAL8 pp, EOBACoefficients *aCoeffs)
	Function to calculate the EOB effective Hamiltonian for the given values of the dynamical variables. More...

static UNUSED int	XLALSimIMREOBCalcFacWaveformCoefficients (FacWaveformCoeffs *const coeffs, const REAL8 eta)
	Function which calculates the various coefficients used in the generation of the factorized waveform. More...

static UNUSED int	XLALSimIMREOBModifyFacWaveformCoefficients (FacWaveformCoeffs *const coeffs, const REAL8 eta)
	Function which adds the additional terms required for waveform generation to the factorized waveform coefficients. More...

static REAL8	nonKeplerianCoefficient (REAL8Vector restrict values, const REAL8 eta, EOBACoefficients coeffs)
	Computes the non-Keplerian correction to the velocity as determined from the frequency obtained assuming a circular orbit. More...

static UNUSED int	XLALSimIMREOBGetFactorizedWaveform (COMPLEX16 restrict hlm, REAL8Vector restrict values, const REAL8 v, const INT4 l, const INT4 m, EOBParams *restrict params)
	Computes the factorized waveform according to the prescription given in Pan et al, arXiv:1106.1021v1 [gr-qc], for a given mode l,m, for the given values of the dynamics at that point. More...

Macros
#define	_LALSIMIMRFACTORIZEDWAVEFORM_C
	The functions contained within this file pre-compute the various coefficients which are required for calculating the factorized waveform in EOBNRv2. Note that for some of the higher modes, the coefficients are changed for the generation of the waveform compared to the generation of the flux. Thus we have a function which adds these additional contributions to the already computed coefficients. More...

#define	ninty4by3etc 18.687902694437592603
	Constant which comes up in some of the EOB models. More...

Macro Definition Documentation

◆ _LALSIMIMRFACTORIZEDWAVEFORM_C

#define _LALSIMIMRFACTORIZEDWAVEFORM_C

The functions contained within this file pre-compute the various coefficients which are required for calculating the factorized waveform in EOBNRv2. Note that for some of the higher modes, the coefficients are changed for the generation of the waveform compared to the generation of the flux. Thus we have a function which adds these additional contributions to the already computed coefficients.

Author: Craig Robinson, Yi Pan

Definition at line 42 of file LALSimIMREOBFactorizedWaveform.c.

◆ ninty4by3etc

#define ninty4by3etc 18.687902694437592603

Constant which comes up in some of the EOB models.

Its value is (94/3 -41/32*pi*pi)

Definition at line 54 of file LALSimIMREOBFactorizedWaveform.c.

Function Documentation

◆ XLALCalculateA5()

static REAL8 XLALCalculateA5 ( REAL8 eta )

inlinestatic

Calculates the a5 parameter in the A potential function in EOBNRv2.

Parameters

eta	< Symmetric mass ratio

Definition at line 70 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALCalculateA6() [1/2]

static REAL8 XLALCalculateA6 ( REAL8 eta )

inlinestatic

◆ XLALCalculateEOBD()

static REAL8 XLALCalculateEOBD	(	REAL8	r,
		REAL8	eta
	)

static

Calculate the EOB D function.

Parameters

r	< Orbital separation (in units of total mass M)
eta	< Symmetric mass ratio

Definition at line 204 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALCalculateA6() [2/2]

static REAL8 XLALCalculateA6 ( const REAL8 UNUSED eta )

inlinestatic

Calculates the a6 parameter in the A potential function in EOBNRv2.

Parameters

eta	< Symmetric mass ratio

Definition at line 80 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALCalculateEOBACoefficients()

static UNUSED int XLALCalculateEOBACoefficients	(	EOBACoefficients *const	coeffs,
		const REAL8	eta
	)

static

Function to pre-compute the coefficients in the EOB A potential function.

Parameters

coeffs	< A coefficients (populated in function)
eta	< Symmetric mass ratio

Definition at line 91 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALCalculateEOBA()

static REAL8 XLALCalculateEOBA	(	const REAL8	r,
		EOBACoefficients *restrict	coeffs
	)

static

This function calculates the EOB A function which using the pre-computed coefficients which should already have been calculated.

Parameters

r	< Orbital separation (in units of total mass M)
coeffs	< Pre-computed coefficients for the A function

Definition at line 127 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALCalculateEOBdAdr()

static REAL8 XLALCalculateEOBdAdr	(	const REAL8	r,
		EOBACoefficients *restrict	coeffs
	)

static

Calculated the derivative of the EOB A function with respect to r, using the pre-computed A coefficients.

Parameters

r	< Orbital separation (in units of total mass M)
coeffs	< Pre-computed coefficients for the A function

Definition at line 164 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALEffectiveHamiltonian()

static REAL8 XLALEffectiveHamiltonian	(	const REAL8	eta,
		const REAL8	r,
		const REAL8	pr,
		const REAL8	pp,
		EOBACoefficients *	aCoeffs
	)

static

Function to calculate the EOB effective Hamiltonian for the given values of the dynamical variables.

The coefficients in the A potential function should already have been computed. Note that the pr used here is the tortoise co-ordinate.

Parameters

eta	< Symmetric mass ratio
r	< Orbital separation
pr	< Tortoise co-ordinate
pp	< Momentum pphi
aCoeffs	< Pre-computed coefficients in A function

Definition at line 225 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALSimIMREOBCalcFacWaveformCoefficients()

static UNUSED int XLALSimIMREOBCalcFacWaveformCoefficients	(	FacWaveformCoeffs *const	coeffs,
		const REAL8	eta
	)

static

Function which calculates the various coefficients used in the generation of the factorized waveform.

These coefficients depend only on the symmetric mass ratio eta. It should be noted that this function calculates the coefficients used in calculating the flux. For generating the waveforms themselves, the coefficients have additional terms added which are calculated using XLALModifyFacWaveformCoefficients(). THe non-spinning parts of these coefficients can be found in Pan et al, arXiv:1106.1021v1 [gr-qc].

Parameters

coeffs	< Structure containing coefficients (populated in function)
eta	< Symmetric mass ratio

Definition at line 255 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALSimIMREOBModifyFacWaveformCoefficients()

static UNUSED int XLALSimIMREOBModifyFacWaveformCoefficients	(	FacWaveformCoeffs *const	coeffs,
		const REAL8	eta
	)

static

Function which adds the additional terms required for waveform generation to the factorized waveform coefficients.

Note that this function only calculates additional terms not present in the flux, so the factorized waveform coefficients SHOULD ALREADY HAVE BEEN CALCULATED using XLALCalcFacWaveformCoefficients() prior to calling this function.

Parameters

coeffs	< Structure containing coefficients
eta	< Symmetric mass ratio

Definition at line 670 of file LALSimIMREOBFactorizedWaveform.c.

◆ nonKeplerianCoefficient()

static REAL8 nonKeplerianCoefficient	(	REAL8Vector *restrict	values,
		const REAL8	eta,
		EOBACoefficients *	coeffs
	)

static

Computes the non-Keplerian correction to the velocity as determined from the frequency obtained assuming a circular orbit.

In the early stages of the evolution, this should be a number close to 1.

Parameters

values	< Dynamics r, phi, pr, pphi
eta	< Symmetric mass ratio
coeffs	< Pre-computed A coefficients

Definition at line 701 of file LALSimIMREOBFactorizedWaveform.c.

◆ XLALSimIMREOBGetFactorizedWaveform()

static UNUSED int XLALSimIMREOBGetFactorizedWaveform	(	COMPLEX16 *restrict	hlm,
		REAL8Vector *restrict	values,
		const REAL8	v,
		const INT4	l,
		const INT4	m,
		EOBParams *restrict	params
	)

static

Computes the factorized waveform according to the prescription given in Pan et al, arXiv:1106.1021v1 [gr-qc], for a given mode l,m, for the given values of the dynamics at that point.

The function returns XLAL_SUCCESS if everything works out properly, otherwise XLAL_FAILURE will be returned.

Parameters

hlm	< The value of hlm (populated by the function)
values	< Vector containing dynamics r, phi, pr, pphi for a given point
v	< Velocity (in geometric units)
l	< Mode l
m	< Mode m
params	< Structure containing pre-computed coefficients, etc.

Definition at line 725 of file LALSimIMREOBFactorizedWaveform.c.

Prototypes

Macros

Macro Definition Documentation

◆ _LALSIMIMRFACTORIZEDWAVEFORM_C

◆ ninty4by3etc

Function Documentation

◆ XLALCalculateA5()

◆ XLALCalculateA6() [1/2]

◆ XLALCalculateEOBD()

◆ XLALCalculateA6() [2/2]

◆ XLALCalculateEOBACoefficients()

◆ XLALCalculateEOBA()

◆ XLALCalculateEOBdAdr()

◆ XLALEffectiveHamiltonian()

◆ XLALSimIMREOBCalcFacWaveformCoefficients()

◆ XLALSimIMREOBModifyFacWaveformCoefficients()

◆ nonKeplerianCoefficient()

◆ XLALSimIMREOBGetFactorizedWaveform()