Prototypes
static int	XLALSimIMREOBNRv2SetupFlux (expnCoeffsdEnergyFlux *ak, REAL8 eta)
	The following declarations are so that the compiler quits. More...

static REAL8	omegaofrP4PN (const REAL8 r, const REAL8 eta, void *params)

static int	LALHCapDerivativesP4PN (double t, const double values[], double dvalues[], void *funcParams)

static REAL8	XLALCalculateOmega (REAL8 eta, REAL8 r, REAL8 pr, REAL8 pPhi, EOBACoefficients *aCoeffs)

static int	XLALFirstStoppingCondition (double t, const double values[], double dvalues[], void *funcParams)

static int	XLALHighSRStoppingCondition (double t, const double values[], double dvalues[], void *funcParams)

static REAL8	XLALprInitP4PN (REAL8 p, void *params)

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

static REAL8	XLALrOfOmegaP4PN (REAL8 r, void *params)

static REAL8	XLALvrP4PN (const REAL8 r, const REAL8 omega, pr3In *params)

static size_t	find_instant_freq (const REAL8TimeSeries hp, const REAL8TimeSeries hc, const REAL8 target, const size_t start, const int fsign)

static size_t	find_instant_freq_hlm (const COMPLEX16TimeSeries *hlm, const REAL8 target, const size_t start)

static int	LALHCapDerivativesP4PN (double UNUSED t, const REAL8 values[], REAL8 dvalues[], void *funcParams)

static int	XLALFirstStoppingCondition (double UNUSED t, const double UNUSED values[], double dvalues[], void *funcParams)

static int	XLALHighSRStoppingCondition (double UNUSED t, const double values[], double dvalues[], void UNUSED *funcParams)

static REAL8	XLALSimIMREOBGetRingdownAttachCombSize (INT4 l, INT4 m)

static int	XLALSimIMREOBNRv2Generator (REAL8TimeSeries hplus, REAL8TimeSeries hcross, SphHarmTimeSeries **h_lms, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fLower, const REAL8 distance, const REAL8 inclination, const int higherModeFlag)

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...

Variables
static const int	EOBNRV2_NUM_MODES_MAX = 5
	The maximum number of modes available to us in this model. More...

Function Documentation

◆ XLALSimIMREOBNRv2SetupFlux()

static int XLALSimIMREOBNRv2SetupFlux	(	expnCoeffsdEnergyFlux *	ak,
		REAL8	eta
	)

static

The following declarations are so that the compiler quits.

It appears that they are here because some of these functions are called before their definitions in the following code. Perhaps this can be made cleaner by just moving the definitions, but for now I'm keeping with what the original code did.

Parameters

ak	<PN expansion coefficients (only relevant fields will be populated)
eta	< Symmetric mass ratio

Definition at line 573 of file LALSimIMREOBNRv2.c.

◆ omegaofrP4PN()

static REAL8 omegaofrP4PN	(	const REAL8	r,
		const REAL8	eta,
		void *	params
	)

static

Parameters

r	< Initial orbital separation (in units of total mass M
eta	< Symmetric mass ratio
params	< The pre-computed A coefficients

Definition at line 198 of file LALSimIMREOBNRv2.c.

◆ LALHCapDerivativesP4PN() [1/2]

static int LALHCapDerivativesP4PN	(	double	t,
		const double	values[],
		double	dvalues[],
		void *	funcParams
	)

static

◆ XLALCalculateOmega()

static REAL8 XLALCalculateOmega	(	REAL8	eta,
		REAL8	r,
		REAL8	pr,
		REAL8	pPhi,
		EOBACoefficients *	aCoeffs
	)

static

Parameters

eta	< Symmetric mass ratio
r	< Orbital separation (units of total mass M)
pr	< Tortoise co-ordinate
pPhi	< Momentum pphi
aCoeffs	< Pre-computed EOB A coefficients

Definition at line 342 of file LALSimIMREOBNRv2.c.

◆ XLALFirstStoppingCondition() [1/2]

static int XLALFirstStoppingCondition	(	double	t,
		const double	values[],
		double	dvalues[],
		void *	funcParams
	)

static

◆ XLALHighSRStoppingCondition() [1/2]

static int XLALHighSRStoppingCondition	(	double	t,
		const double	values[],
		double	dvalues[],
		void *	funcParams
	)

static

◆ XLALprInitP4PN()

static REAL8 XLALprInitP4PN	(	REAL8	p,
		void *	params
	)

static

Parameters

p	< The pr value we are currently testing
params	< The pr3In structure containing necessary parameters

Definition at line 149 of file LALSimIMREOBNRv2.c.

◆ XLALpphiInitP4PN()

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

static

Parameters

r	< Initial orbital separation
coeffs	< Pre-computed EOB A coefficients

Definition at line 120 of file LALSimIMREOBNRv2.c.

◆ XLALrOfOmegaP4PN()

static REAL8 XLALrOfOmegaP4PN	(	REAL8	r,
		void *	params
	)

static

Parameters

r	< Test value of the initial radius
params	< pr3In structure, containing useful parameters, including omega

Definition at line 230 of file LALSimIMREOBNRv2.c.

◆ XLALvrP4PN()

static REAL8 XLALvrP4PN	(	const REAL8	r,
		const REAL8	omega,
		pr3In *	params
	)

static

Parameters

r	< Orbital separation (in units of total mass M)
omega	< Orbital frequency (dimensionless: M*omega)
params	< pr3In structure containing some necessary parameters

Definition at line 421 of file LALSimIMREOBNRv2.c.

◆ find_instant_freq()

static size_t find_instant_freq	(	const REAL8TimeSeries *	hp,
		const REAL8TimeSeries *	hc,
		const REAL8	target,
		const size_t	start,
		const int	fsign
	)

static

Definition at line 697 of file LALSimIMREOBNRv2.c.

◆ find_instant_freq_hlm()

static size_t find_instant_freq_hlm	(	const COMPLEX16TimeSeries *	hlm,
		const REAL8	target,
		const size_t	start
	)

static

Definition at line 718 of file LALSimIMREOBNRv2.c.

◆ LALHCapDerivativesP4PN() [2/2]

static int LALHCapDerivativesP4PN	(	double UNUSED	t,
		const REAL8	values[],
		REAL8	dvalues[],
		void *	funcParams
	)

static

Parameters

t	< Current time (GSL requires it to be a parameter, but it's irrelevant)
values	< The dynamics r, phi, pr, pphi
dvalues	< The derivatives dr/dt, dphi/dt. dpr/dt and dpphi/dt
funcParams	< Structure containing all the necessary parameters

Definition at line 256 of file LALSimIMREOBNRv2.c.

◆ XLALFirstStoppingCondition() [2/2]

static int XLALFirstStoppingCondition	(	double UNUSED	t,
		const double UNUSED	values[],
		double	dvalues[],
		void *	funcParams
	)

static

Parameters

t	< Current time (required by GSL)
values	< Current dynamics (required by GSL)
dvalues	< Derivatives of dynamics w.r.t. time
funcParams	< Structure containing necessary parameters

Definition at line 366 of file LALSimIMREOBNRv2.c.

◆ XLALHighSRStoppingCondition() [2/2]

static int XLALHighSRStoppingCondition	(	double UNUSED	t,
		const double	values[],
		double	dvalues[],
		void UNUSED *	funcParams
	)

static

Parameters

t	< Current time (required by GSL)
values	< Current dynamics
dvalues	< Derivatives of dynamics w.r.t. time
funcParams	< Structure containing necessary parameters

Definition at line 392 of file LALSimIMREOBNRv2.c.

◆ XLALSimIMREOBGetRingdownAttachCombSize()

static REAL8 XLALSimIMREOBGetRingdownAttachCombSize	(	INT4	l,
		INT4	m
	)

static

Parameters

l	< Mode l
m	< Mode m

Definition at line 500 of file LALSimIMREOBNRv2.c.

◆ XLALSimIMREOBNRv2Generator()

static int XLALSimIMREOBNRv2Generator	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		SphHarmTimeSeries **	h_lms,
		const REAL8	phiC,
		const REAL8	deltaT,
		const REAL8	m1SI,
		const REAL8	m2SI,
		const REAL8	fLower,
		const REAL8	distance,
		const REAL8	inclination,
		const int	higherModeFlag
	)

static

Definition at line 742 of file LALSimIMREOBNRv2.c.

Variable Documentation

◆ EOBNRV2_NUM_MODES_MAX

const int EOBNRV2_NUM_MODES_MAX = 5

static

The maximum number of modes available to us in this model.

Definition at line 46 of file LALSimIMREOBNRv2.c.

Prototypes

Variables

Function Documentation

◆ XLALSimIMREOBNRv2SetupFlux()

◆ omegaofrP4PN()

◆ LALHCapDerivativesP4PN() [1/2]

◆ XLALCalculateOmega()

◆ XLALFirstStoppingCondition() [1/2]

◆ XLALHighSRStoppingCondition() [1/2]

◆ XLALprInitP4PN()

◆ XLALpphiInitP4PN()

◆ XLALrOfOmegaP4PN()

◆ XLALvrP4PN()

◆ find_instant_freq()

◆ find_instant_freq_hlm()

◆ LALHCapDerivativesP4PN() [2/2]

◆ XLALFirstStoppingCondition() [2/2]

◆ XLALHighSRStoppingCondition() [2/2]

◆ XLALSimIMREOBGetRingdownAttachCombSize()

◆ XLALSimIMREOBNRv2Generator()

Variable Documentation

◆ EOBNRV2_NUM_MODES_MAX