LALSimIMRPhenomX_PNR_alpha.h File Reference

Prototypes
REAL8	IMRPhenomX_PNR_GeneratePNRAlphaAtMf (REAL8 Mf, const IMRPhenomX_PNR_alpha_parameters *alphaParams, IMRPhenomXWaveformStruct *pWF, IMRPhenomXPrecessionStruct *pPrec)
	This function evaluates Eq. More...
REAL8	IMRPhenomX_PNR_GenerateMergedPNRAlphaAtMf (REAL8 Mf, const IMRPhenomX_PNR_alpha_parameters *alphaParams, IMRPhenomXWaveformStruct *pWF, IMRPhenomXPrecessionStruct *pPrec)
	This function generates the blended PNR and PN expressions for alpha for the transition region of parameter space. More...
REAL8	IMRPhenomX_PNR_GetPNAlphaAtFreq (REAL8 Mf, IMRPhenomXWaveformStruct *pWF, IMRPhenomXPrecessionStruct *pPrec)
	Here we write a wrapper function to produce either MSA or NNLO alpha for use in IMRPhenomX_PNR_GeneratePNRAlphaAtMf. More...
int	IMRPhenomX_PNR_precompute_alpha_coefficients (IMRPhenomX_PNR_alpha_parameters *alphaParams, IMRPhenomXWaveformStruct *pWF, IMRPhenomXPrecessionStruct *pPrec)
	This function evaluates the coefficients outlined in Sec 7A of arXiv:2107.08876 for alpha. More...
REAL8	IMRPhenomX_PNR_alpha_interpolation_0 (REAL8 Mf1, REAL8 Mf2, REAL8 alpha1, REAL8 alpha2, REAL8 dalpha1, REAL8 dalpha2)
	The following four functions are used to compute the C1 interpolation function used to connect the inspiral and MR expressions for alpha. More...
REAL8	IMRPhenomX_PNR_alpha_interpolation_1 (REAL8 Mf1, REAL8 Mf2, REAL8 alpha1, REAL8 alpha2, REAL8 dalpha1, REAL8 dalpha2)
REAL8	IMRPhenomX_PNR_alpha_interpolation_2 (REAL8 Mf1, REAL8 Mf2, REAL8 alpha1, REAL8 alpha2, REAL8 dalpha1, REAL8 dalpha2)
REAL8	IMRPhenomX_PNR_alpha_interpolation_3 (REAL8 Mf1, REAL8 Mf2, REAL8 alpha1, REAL8 alpha2, REAL8 dalpha1, REAL8 dalpha2)
REAL8	IMRPhenomX_PNR_intermediate_alpha_expression (REAL8 Mf, const IMRPhenomX_PNR_alpha_parameters *alphaParams)
	This function evaluates Eq. More...
REAL8	IMRPhenomX_PNR_MR_alpha_expression (REAL8 Mf, const IMRPhenomX_PNR_alpha_parameters *alphaParams)
	This function evaluates Eq. More...
int	IMRPhenomX_PNR_alpha_connection_parameters (IMRPhenomX_PNR_alpha_parameters *alphaParams, IMRPhenomXWaveformStruct *pWF, IMRPhenomXPrecessionStruct *pPrec)
	This function evaluates the connection frequencies Mf1 and Mf2 detailed in Sec. More...

Go to the source code of this file.

Data Structures
struct	IMRPhenomX_PNR_alpha_parameters

Function Documentation

IMRPhenomX_PNR_GeneratePNRAlphaAtMf()

REAL8 IMRPhenomX_PNR_GeneratePNRAlphaAtMf	(	REAL8	Mf,
		const IMRPhenomX_PNR_alpha_parameters *	alphaParams,
		IMRPhenomXWaveformStruct *	pWF,
		IMRPhenomXPrecessionStruct *	pPrec
	)

This function evaluates Eq.

59 of arXiv:2107.08876.

Parameters

Mf	geometric frequency
alphaParams	Alpha parameter struct
pWF	PhenomX Waveform struct
pPrec	PhenomX Precession struct

Definition at line 50 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_GenerateMergedPNRAlphaAtMf()

REAL8 IMRPhenomX_PNR_GenerateMergedPNRAlphaAtMf	(	REAL8	Mf,
		const IMRPhenomX_PNR_alpha_parameters *	alphaParams,
		IMRPhenomXWaveformStruct *	pWF,
		IMRPhenomXPrecessionStruct *	pPrec
	)

This function generates the blended PNR and PN expressions for alpha for the transition region of parameter space.

Parameters

Mf	geometric frequency
alphaParams	Alpha parameter struct
pWF	PhenomX Waveform struct
pPrec	PhenomX Precession struct

Definition at line 83 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_GetPNAlphaAtFreq()

REAL8 IMRPhenomX_PNR_GetPNAlphaAtFreq	(	REAL8	Mf,
		IMRPhenomXWaveformStruct *	pWF,
		IMRPhenomXPrecessionStruct *	pPrec
	)

Here we write a wrapper function to produce either MSA or NNLO alpha for use in IMRPhenomX_PNR_GeneratePNRAlphaAtMf.

This function will toggle which to use based on IMRPhenomXPrecVersion.

Parameters

Mf	geometric frequency
pWF	PhenomX waveform struct
pPrec	PhenomX precession struct

Definition at line 127 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_precompute_alpha_coefficients()

int IMRPhenomX_PNR_precompute_alpha_coefficients	(	IMRPhenomX_PNR_alpha_parameters *	alphaParams,
		IMRPhenomXWaveformStruct *	pWF,
		IMRPhenomXPrecessionStruct *	pPrec
	)

This function evaluates the coefficients outlined in Sec 7A of arXiv:2107.08876 for alpha.

Parameters

alphaParams	Alpha parameter struct
pWF	PhenomX waveform struct
pPrec	PhenomX precession struct

Definition at line 184 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_alpha_interpolation_0()

REAL8 IMRPhenomX_PNR_alpha_interpolation_0	(	REAL8	Mf1,
		REAL8	Mf2,
		REAL8	alpha1,
		REAL8	alpha2,
		REAL8	dalpha1,
		REAL8	dalpha2
	)

The following four functions are used to compute the C1 interpolation function used to connect the inspiral and MR expressions for alpha.

They are evaluated at the two transition frequency values Mf1 = 2 A4 / 7 and Mf2 = A4 / 3. See Sec. 8A of arXiv:2107.08876.

Specifically, the next four functions are Eq. 52 in arXiv:2107.08876.

Parameters

Mf1	lower connection frequency in geometric units
Mf2	upper connection frequency in geometric units
alpha1	value of alpha at Mf1
alpha2	value of alpha at Mf2
dalpha1	derivative of alpha at Mf1
dalpha2	derivative of alpha at Mf2

Definition at line 233 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_alpha_interpolation_1()

REAL8 IMRPhenomX_PNR_alpha_interpolation_1	(	REAL8	Mf1,
		REAL8	Mf2,
		REAL8	alpha1,
		REAL8	alpha2,
		REAL8	dalpha1,
		REAL8	dalpha2
	)

Parameters

Mf1	lower connection frequency in geometric units
Mf2	upper connection frequency in geometric units
alpha1	value of alpha at Mf1
alpha2	value of alpha at Mf2
dalpha1	derivative of alpha at Mf1
dalpha2	derivative of alpha at Mf2

Definition at line 249 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_alpha_interpolation_2()

REAL8 IMRPhenomX_PNR_alpha_interpolation_2	(	REAL8	Mf1,
		REAL8	Mf2,
		REAL8	alpha1,
		REAL8	alpha2,
		REAL8	dalpha1,
		REAL8	dalpha2
	)

Parameters

Mf1	lower connection frequency in geometric units
Mf2	upper connection frequency in geometric units
alpha1	value of alpha at Mf1
alpha2	value of alpha at Mf2
dalpha1	derivative of alpha at Mf1
dalpha2	derivative of alpha at Mf2

Definition at line 265 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_alpha_interpolation_3()

REAL8 IMRPhenomX_PNR_alpha_interpolation_3	(	REAL8	Mf1,
		REAL8	Mf2,
		REAL8	alpha1,
		REAL8	alpha2,
		REAL8	dalpha1,
		REAL8	dalpha2
	)

Parameters

Mf1	lower connection frequency in geometric units
Mf2	upper connection frequency in geometric units
alpha1	value of alpha at Mf1
alpha2	value of alpha at Mf2
dalpha1	derivative of alpha at Mf1
dalpha2	derivative of alpha at Mf2

Definition at line 281 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_intermediate_alpha_expression()

REAL8 IMRPhenomX_PNR_intermediate_alpha_expression	(	REAL8	Mf,
		const IMRPhenomX_PNR_alpha_parameters *	alphaParams
	)

This function evaluates Eq.

51 of arXiv:2107.08876

Parameters

Mf	frequency in geometric units
alphaParams	Alpha parameter struct

Definition at line 300 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_MR_alpha_expression()

REAL8 IMRPhenomX_PNR_MR_alpha_expression	(	REAL8	Mf,
		const IMRPhenomX_PNR_alpha_parameters *	alphaParams
	)

This function evaluates Eq.

48 of arXiv:2107.08876

Parameters

Mf	frequency in geometric units
alphaParams	Alpha parameter struct

Definition at line 321 of file LALSimIMRPhenomX_PNR_alpha.c.

IMRPhenomX_PNR_alpha_connection_parameters()

int IMRPhenomX_PNR_alpha_connection_parameters	(	IMRPhenomX_PNR_alpha_parameters *	alphaParams,
		IMRPhenomXWaveformStruct *	pWF,
		IMRPhenomXPrecessionStruct *	pPrec
	)

This function evaluates the connection frequencies Mf1 and Mf2 detailed in Sec.

8A of arXiv:2107.08876. It then computes the values of alpha and its derivatives at these frequencies to compute the coefficients used for the intermediate interpolation function Eq. 51.

The derivatives are computed using simple centered finite differences.

Parameters

alphaParams	Alpha parameter struct
pWF	PhenomX waveform struct
pPrec	PhenomX precession struct

Definition at line 347 of file LALSimIMRPhenomX_PNR_alpha.c.