LALSimIMRPhenomX.c File Reference

Prototypes
int	IMRPhenomXASGenerateFD (COMPLEX16FrequencySeries **htilde22, const REAL8Sequence *freqs_In, IMRPhenomXWaveformStruct *pWF, LALDict *lalParams)
int	IMRPhenomXCheckForUniformFrequencies (REAL8Sequence *frequencies, REAL8 df)
int	IMRPhenomXPGenerateFD (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs_In, IMRPhenomXWaveformStruct *pWF, IMRPhenomXPrecessionStruct *pPrec, LALDict *lalParams)
REAL8	XLALSimPhenomPNRfRingEff (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
REAL8	XLALSimPhenomPNRfRINGEffShiftDividedByEmm (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
REAL8	XLALSimPhenomPNRbetaRD (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
REAL8	XLALSimPhenomPNRafinal_prec (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
REAL8	XLALSimPhenomPNRafinal_nonprec (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
REAL8	XLALSimPhenomPNRafinal (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
REAL8	XLALSimPhenomPNRwindow (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
Routines for IMRPhenomXAS
C code for IMRPhenomXAS phenomenological waveform model. Author Geraint Pratten This is an aligned-spin frequency domain model for the 22 mode. See G.Pratten et al arXiv:2001.11412 for details. Any studies that use this waveform model should include a reference to this paper. Note The model was calibrated to mass-ratios from 1 to 1000. The calibration points will be given in forthcoming papers. Attention The model is usable outside this parameter range, and in tests to date gives sensible physical results, but conclusive statements on the physical fidelity of the model for these parameters await comparisons against further numerical-relativity simulations. For more information, see the review wiki under https://git.ligo.org/waveforms/reviews/imrphenomx/wikis/home Waveform flags: InsPhaseVersion: Determines the inspiral phase model. 104 : Canonical TaylorF2 at 3.5PN including cubic-in-spin and quadratic-in-spin corrections. Uses 4 pseudo-PN coefficients. (RECOMMENDED). 105 : Canonical TaylorF2 at 3.5PN including cubic-in-spin and quadratic-in-spin corrections. Uses 5 pseudo-PN coefficients. 114 : Extended TaylorF2. Includes cubic-in-spin, quadratic-in-spin corrections, 4PN and 4.5PN orbital corrections. Uses 4 pseudo-PN coefficients. 115 : Extended TaylorF2. Includes cubic-in-spin, quadratic-in-spin corrections, 4PN and 4.5PN orbital corrections. Uses 5 pseudo-PN coefficients. IntPhaseVersion: Determines the intermediate phase model. 104 : 4th order polynomial ansatz. 105 : 5th order polynomial ansatz. (RECOMMENDED). RDPhaseVersion: Determines the merger-ringdown phase model. 105 : Deformed Lorentzian using 5 coefficients. (RECOMMENDED). InsAmpVersion : Determines inspiral amplitude model. 103 : Canonical PN re-expanded TaylorF2 amplitude with pseudo-PN corrections. (RECOMMENDED). IntAmpVersion : Determines intermediate amplitude model. 104 : Based on a 4th order polynomial ansatz. Less accurate but stable extrapolation. (RECOMMENDED). 105 : Based on 5th order polynomial ansatz. More accurate in calibration domain, more unstable extrapolation. RDAmpVersion : Determines the merger-ringdown amplitude model. 103 : Deformed Lorentzian with 3 free coefficients. Uses 1 calibrated collocation point and 2 calibrated phenomenological coefficients. (RECOMMENDED).
int	XLALSimIMRPhenomXASGenerateFD (COMPLEX16FrequencySeries **htilde22, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 phi0, REAL8 fRef_In, LALDict *lalParams)
	Driver routine to calculate an IMRPhenomX aligned-spin, inspiral-merger-ringdown phenomenological waveform model in the frequency domain. More...
int	XLALSimIMRPhenomXASFrequencySequence (COMPLEX16FrequencySeries **htilde22, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 phi0, REAL8 fRef_In, LALDict *lalParams)
	Compute waveform in LAL format at specified frequencies for the IMRPhenomX model. More...
double	XLALSimIMRPhenomXASDuration (const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi1L, const REAL8 chi2L, const REAL8 f_start)
	Compute the duration of IMRPhenomXAS using the approximate SPA relation \(t_f \sim \frac{1}{2 \pi} \frac{d \varphi}{d f} \). More...
Routines for IMRPhenomXP
C code for IMRPhenomXP phenomenological waveform model. Author Geraint Pratten, Cecilio García Quirós This is a precessing frequency domain model. See Pratten, García-Quirós, Colleoni et al arXiv:2004.06503 for details. Studies using this model are kindly asked to cite Pratten et al arXiv:2001.11412, García-Quirós et al arXiv:2001.10914 and Pratten, García-Quirós, Colleoni et al arXiv:2004.06503. Note The underlying aligned-spin model was calibrated for mass-ratios 1 to 1000. Attention The model can be called outside this parameter space and in all tests to date gives sensible physical results but conclusive statements on the physical fidelity of the model requires further detailed comparisons against numerical-relativity simulations. For more information, see the review wiki under https://git.ligo.org/waveforms/reviews/imrphenomx/wikis/home IMRPhenomXP/HM is based on a modular framework. User can specify flags to control how Euler angles are calculated, the final spin parameterization and the conventions used in reconstructing the waveform in the LAL frame. A detailed discussion can be found in arXiv:2004.06503. The various flags are detailed below. Precession flags: PhenomXPrecVersion: 101 : NNLO PN Euler angles and a 2PN non-spinning approximation to L 102 : NNLO PN Euler angles and a 3PN spinning approximation to L 103 : NNLO PN Euler angles and a 4PN spinning approximation to L 104 : NNLO PN Euler angles and a 4PN spinning approximation to L augmeneted with leading PN order at all order in spin terms. See N. Siemonsen et al, PRD, 97, 124046, (2018), arXiv:1712.08603 220 : MSA Euler angles and a 3PN spinning approximation to L, see K. Chatziioannou et al, PRD, 95, 104004, (2017), arXiv:1703.03967. Defaults to NNLO version 102 if MSA fails to initialize. 221 : MSA Euler angles and a 3PN spinning approximation to L. 222 : MSA Euler angles as implemented in LALSimInspiralFDPrecAngles. 223 : MSA Euler angles as implemented in LALSimInspiralFDPrecAngles. Defaults to NNLO version 102 if MSA fails to initialize. [Default]. 224 : As version 220 but using the \(\phi_{z,0}\) and \(\zeta_{z,0}\) prescription from 223. 310 : Numerical integration of SpinTaylor equations with constant angles in merger-ringdown 311 : Numerical integration of SpinTaylor equations with constant angles in merger-ringdown, without tidal and non-black hole spin-induced quadrupole terms in the SpinTaylor equations when used in IMRPhenomXP_NRTidalv2, for comparison 320 : Numerical integration of SpinTaylor equations, analytical continuation in merger-ringdown 321 : Numerical integration of SpinTaylor equations, analytical continuation in merger-ringdown, without tidal and non-black hole spin-induced quadrupole terms in the SpinTaylor equations when used in IMRPhenomXP_NRTidalv2, for comparison PhenomXPExpansionOrder: -1, 0, 1, 2, 3, 4, 5. Controls the expansion order of the leading-order MSA terms for both \(\zeta\) and \(\phi_z\). [Default is 5]. PhenomXPFinalSpinMod: 0 : Modify final spin based on \(\chi_p\). [Recommended default for NNLO angles]. 1 : Modify final spin using \(\chi_{1x}\). This is pathological. Do not use. Implemented to compare to PhenomPv3 pre-bug fix. 2 : Modify final spin using norm of total in-plane spin vector. 3 : Modify final spin using precession-averaged couplings from MSA analysis. Only works with MSA Euler angles (versions 220, 221, 222, 223 and 224). If MSA fails to initialize or called with NNLO angles, default to version 0. [Default] 4: Modify final spin estimating the total in-plane spin from the PN spin-evolution equations. PhenomXPConvention (App. C and Table IV of arXiv:2004.06503): 0 : Conventions defined as following https://dcc.ligo.org/LIGO-T1500602 1 : Convention defined following App. C, see Table II of arXiv:2004.06503 for specific details. [Default] 5 : Conventions as used in PhenomPv3/HM 6 : Conventions defined following App. C, see Table II of arXiv:2004.06503 for specific details. 7 : Conventions defined following App. C, see Table II of arXiv:2004.06503 for specific details.
int	XLALSimIMRPhenomXPGenerateFD (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, REAL8 f_min, REAL8 f_max, const REAL8 deltaF, REAL8 fRef_In, LALDict *lalParams)
int	XLALSimIMRPhenomXPFrequencySequence (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
	Compute waveform in LAL format at specified frequencies for the IMRPhenomXP model. More...
int	XLALSimIMRPhenomXPCalculateModelParametersFromSourceFrame (REAL8 *chi1L, REAL8 *chi2L, REAL8 *chi_p, REAL8 *thetaJN, REAL8 *alpha0, REAL8 *phi_aligned, REAL8 *zeta_polarization, REAL8 m1_SI, REAL8 m2_SI, REAL8 f_ref, REAL8 phiRef, REAL8 incl, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
int	XLALSimIMRPhenomXPMSAAngles (REAL8Sequence **alpha_of_f, REAL8Sequence **gamma_of_f, REAL8Sequence **cosbeta_of_f, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 inclination, REAL8 fRef_In, INT4 mprime, LALDict *lalParams)
int	XLALSimIMRPhenomXPPNAngles (REAL8Sequence **alpha_of_f, REAL8Sequence **gamma_of_f, REAL8Sequence **cosbeta_of_f, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 inclination, REAL8 fRef_In, INT4 mprime, LALDict *lalParams)

Go to the source code of this file.

Macros
#define	DEBUG   0
#define	PHENOMXDEBUG   0
#define	PHENOMXPDEBUG   0
#define	omp   ignore

Variables
IMRPhenomX_UsefulPowers	powers_of_lalpi

Macro Definition Documentation

DEBUG

#define DEBUG   0

Definition at line 47 of file LALSimIMRPhenomX.c.

PHENOMXDEBUG

#define PHENOMXDEBUG   0

Definition at line 48 of file LALSimIMRPhenomX.c.

PHENOMXPDEBUG

#define PHENOMXPDEBUG   0

Definition at line 49 of file LALSimIMRPhenomX.c.

omp

#define omp   ignore

Definition at line 70 of file LALSimIMRPhenomX.c.

Function Documentation

IMRPhenomXASGenerateFD()

int IMRPhenomXASGenerateFD	(	COMPLEX16FrequencySeries **	htilde22,
		const REAL8Sequence *	freqs_In,
		IMRPhenomXWaveformStruct *	pWF,
		LALDict *	lalParams
	)

Parameters

[out]	htilde22	FD waveform
	freqs_In	Input frequency grid
	pWF	IMRPhenomX Waveform Struct
	lalParams	LAL Dictionary Structure

Definition at line 507 of file LALSimIMRPhenomX.c.

IMRPhenomXCheckForUniformFrequencies()

int IMRPhenomXCheckForUniformFrequencies	(	REAL8Sequence *	frequencies,
		REAL8	df
	)

Definition at line 919 of file LALSimIMRPhenomX.c.

IMRPhenomXPGenerateFD()

int IMRPhenomXPGenerateFD	(	COMPLEX16FrequencySeries **	hptilde,
		COMPLEX16FrequencySeries **	hctilde,
		const REAL8Sequence *	freqs_In,
		IMRPhenomXWaveformStruct *	pWF,
		IMRPhenomXPrecessionStruct *	pPrec,
		LALDict *	lalParams
	)

declare all variables used in anti-symmetric waveform calculation

Parameters

[out]	hptilde	FD waveform
[out]	hctilde	FD waveform
	freqs_In	Input frequency grid
	pWF	IMRPhenomX Waveform Struct
	pPrec	IMRPhenomXP Waveform Struct
	lalParams	LAL Dictionary Structure

Definition at line 1873 of file LALSimIMRPhenomX.c.

XLALSimPhenomPNRfRingEff()

REAL8 XLALSimPhenomPNRfRingEff	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1x,
		REAL8	chi1y,
		REAL8	chi1z,
		REAL8	chi2x,
		REAL8	chi2y,
		REAL8	chi2z,
		LALDict *	lalParams
	)

Definition at line 2499 of file LALSimIMRPhenomX.c.

XLALSimPhenomPNRfRINGEffShiftDividedByEmm()

REAL8 XLALSimPhenomPNRfRINGEffShiftDividedByEmm	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1x,
		REAL8	chi1y,
		REAL8	chi1z,
		REAL8	chi2x,
		REAL8	chi2y,
		REAL8	chi2z,
		LALDict *	lalParams
	)

Definition at line 2578 of file LALSimIMRPhenomX.c.

XLALSimPhenomPNRbetaRD()

REAL8 XLALSimPhenomPNRbetaRD	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1x,
		REAL8	chi1y,
		REAL8	chi1z,
		REAL8	chi2x,
		REAL8	chi2y,
		REAL8	chi2z,
		LALDict *	lalParams
	)

Definition at line 2658 of file LALSimIMRPhenomX.c.

XLALSimPhenomPNRafinal_prec()

REAL8 XLALSimPhenomPNRafinal_prec	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1x,
		REAL8	chi1y,
		REAL8	chi1z,
		REAL8	chi2x,
		REAL8	chi2y,
		REAL8	chi2z,
		LALDict *	lalParams
	)

Definition at line 2739 of file LALSimIMRPhenomX.c.

XLALSimPhenomPNRafinal_nonprec()

REAL8 XLALSimPhenomPNRafinal_nonprec	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1x,
		REAL8	chi1y,
		REAL8	chi1z,
		REAL8	chi2x,
		REAL8	chi2y,
		REAL8	chi2z,
		LALDict *	lalParams
	)

Definition at line 2820 of file LALSimIMRPhenomX.c.

XLALSimPhenomPNRafinal()

REAL8 XLALSimPhenomPNRafinal	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1x,
		REAL8	chi1y,
		REAL8	chi1z,
		REAL8	chi2x,
		REAL8	chi2y,
		REAL8	chi2z,
		LALDict *	lalParams
	)

Definition at line 2903 of file LALSimIMRPhenomX.c.

XLALSimPhenomPNRwindow()

REAL8 XLALSimPhenomPNRwindow	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1x,
		REAL8	chi1y,
		REAL8	chi1z,
		REAL8	chi2x,
		REAL8	chi2y,
		REAL8	chi2z,
		LALDict *	lalParams
	)

Definition at line 2983 of file LALSimIMRPhenomX.c.

Variable Documentation

powers_of_lalpi

IMRPhenomX_UsefulPowers powers_of_lalpi

Definition at line 67 of file LALSimIMRPhenomX.c.