LALSimIMRPhenomTPHM.c File Reference

Prototypes
Routines for IMRPhenomTP
C code for the IMRPhenomTP phenomenological waveform model. Author Héctor Estellés This is a precessing time domain model covering the L=2 sector of Spin-Weighted Spherical Harmonic modes through applying the 'twisting-up' procedure [Phys. Rev. D 91, 024043 (2015), Phys.Rev.D85,084003 (2012), Phys. Rev. D 86, 104063 (2012)] to the dominant non-precessing mode from the IMRPhenomT model. Different versions for the Euler angles employed in the 'twisting-up' of IMRPhenomT can be selected through the WaveformParams option 'PhenomXPrecVersion'. A specific version can be passed with a 5-digit number specification: #####, where tree first digits have to correspond to a valid precessing version of the models IMRPhenomXP/IMRPhenomXPHM, fourth digit selects EulerRDVersion internal option, and 5 digit selects EulerGammaVersion internal option (example, 22310 will select PhenomXPrecVersion=223 for the MSA/NNLO angles calculation, EulerRDVersion=1 and EulerGammaVersion=0.) If only three digits are passed, these have to correspond to a valid precessing version of the models IMRPhenomXP/IMRPhenomXPHM, or to be 300 for computing Euler angles from a numerical PN evolution of the precessing equations. In the case of numerical PN evolution, other options don't apply (for example, it is invalid to call 30010; version 300 always incorporate an approximation of the Euler angles during the ringdown and a numerical determination of gamma through the minimal rotation condition.) Final spin options from IMRPhenomXP/XPHM can also be employed, with the same LAL parameter 'PhenomXFinalSpinMod'. Additional final spin option can be employed when PrecVersion=300, calling PhenomXFinalSpinMod=4. This new final spin option computes the total in-plane spin at the coalescence (t=0 in model convention) for constructing the geometrical precessing final spin, and employs the parallel components to L of the individual spins to evaluate the non-precessing final spin fit. Summary of options for analytical PN angles: EulerRDVersion: 0 (no RD angles attached, MSA/NNLO computed for the whole waveform) 1 (MSA/NNLO computed up to the peak time of the 22 mode, then RD angles are attached.) 2 (MSA/NNLO computed up to MECO time, linear continuation performed up to the peak time, then RD angles are attached.) GammaVersion: 0 (Gamma is computed from the MSA/NNLO PN expressions.) 1 (Gamma computed numerically from minimal rotation condition.) List of model versions (values of PhenomXPrecVersion LAL parameters): 22300: MSA during the whole waveform duration, including ringdown. Closest to 223 PhenomXP/HM. 223/22310: MSA up to the t=0 (peak time of non-precessing 22 mode) and then ringdown angles addition. 22311: MSA up to the t=0 (peak time of non-precessing 22 mode), but gamma angle computed numerically from minimal rotation condition, and then ringdown angles addition. 22320: MSA up to t=tMECO, then linear continuation of alpha and beta up to t=0, then ringdown angles addition (gamma computed from minimal rotation condition from tMECO). 22321: MSA up to t=tMECO, then linear continuation of alpha and beta up to t=0, then ringdown angles addition (gamma computed from minimal rotation during the whole waveform). 10200: NNLO during the whole waveform duration, including ringdown. Closest to 102 PhenomXP/HM. 102/10210: NNLO up to the t=0 (peak time of non-precessing 22 mode) and then ringdown angles addition. 10211: NNLO up to the t=0 (peak time of non-precessing 22 mode), but gamma angle computed numerically from minimal rotation condition, and then ringdown angles addition. 10220: NNLO up to t=tMECO, then linear continuation of alpha and beta up to t=0, then ringdown angles addition (gamma computed from minimal rotation condition from tMECO). 10221: NNLo up to t=tMECO, then linear continuation of alpha and beta up to t=0, then ringdown angles addition (gamma computed from minimal rotation during the whole waveform). 300: Numerical evolution of the precessing spin equations, employing PhenomT 22 mode frequency for approximating orbital frequency. Angles determined by the direction evolution of L(t). This version accepts the same FinalSpinMod options as 102* versions (i.e, FS=3 corresponds to FS=0) but also admits a computation of final spin reading the spin components at merger, this is specified by FinalSpinMod = 4. All analytical versions (MSA/NNLO + different options) can be called with non-default implementations of MSA/NNLO in XP/XPHM (i.e, 224, 104, 220, etc ...)
int	XLALSimIMRPhenomTP (REAL8TimeSeries **hp, REAL8TimeSeries **hc, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
	Routine to compute time-domain polarizations for the IMRPhenomTP model. More...
Routines for IMRPhenomTPHM
C Code for the IMRPhenomTPHM phenomenological waveform model. Author Héctor Estellés This is a precessing time domain model covering up to the L=5 sector of Spin-Weighted Spherical Harmonic modes through applying the 'twisting-up' procedure [Phys. Rev. D 91, 024043 (2015), Phys.Rev.D85,084003 (2012), Phys. Rev. D 86, 104063 (2012)] to the non-precessing modes from the IMRPhenomTHM model. Note The same precessing versions specified for the IMRPhenomTP model are available here.
int	XLALSimIMRPhenomTPHM (REAL8TimeSeries **hp, REAL8TimeSeries **hc, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
	Routine to compute time-domain polarizations for the IMRPhenomTPHM model. More...
SphHarmTimeSeries *	XLALSimIMRPhenomTPHM_ChooseTDModes (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 deltaT, REAL8 fmin, REAL8 fRef, LALDict *lalParams)
	Routine to be used by ChooseTDModes, it returns a list of the time-domain modes of the IMRPhenomTPHM model in the inertial L0-frame. More...
int	XLALSimIMRPhenomTPHM_L0Modes (SphHarmTimeSeries **hlmI, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams, UINT4 only22)
	Routine to compute a list of the time-domain modes of the IMRPhenomTPHM model in the inertial L0-frame. More...
int	XLALSimIMRPhenomTPHM_JModes (SphHarmTimeSeries **hlmJ, REAL8TimeSeries **alphaTS, REAL8TimeSeries **cosbetaTS, REAL8TimeSeries **gammaTS, REAL8 *af, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams, UINT4 only22)
	Routine to compute a list of the time-domain modes of the IMRPhenomTPHM model in the inertial J-frame. More...
int	XLALSimIMRPhenomTPHM_CoprecModes (SphHarmTimeSeries **hlmJ, REAL8TimeSeries **alphaTS, REAL8TimeSeries **cosbetaTS, REAL8TimeSeries **gammaTS, REAL8 *af, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams, UINT4 only22)
	Routine to compute a list of the time-domain modes of the IMRPhenomTPHM model in the co-precessing frame. More...

Go to the source code of this file.

Macros
#define	MAX(a, b)   (((a)>(b))?(a):(b))

Macro Definition Documentation

MAX

#define MAX	(		a,
			b
	)		(((a)>(b))?(a):(b))

Definition at line 55 of file LALSimIMRPhenomTPHM.c.