LALSimIMRPhenomTHM.c

Detailed Description

Routines to produce IMRPhenomT-family of phenomenological inspiral-merger-ringdown waveforms.

These are time-domain models for compact binaries at comparable and extreme mass ratios, tuned to numerical-relativity simulations.

• IMRPhenomT: model for the 22 mode of non-precessing binaries. Model concept together with precession was published in https://arxiv.org/abs/2004.08302. Although an updated version together with the higher mode extension is under the DCC: https://dcc.ligo.org/LIGO-P2000524.
• IMRPhenomTHM: model with subdominant harmonics for non-precessing binaries. DCC link: https://dcc.ligo.org/LIGO-P2000524.
• IMRPhenomTP: model for precessing binaries. Twisted-up version of IMRPhenomT. Original concept: https://arxiv.org/abs/2004.08302.

• IMRPhenomTPHM: model for precessing binaries including higher harmonics. Twisted-up version of IMRPhenomTHM.

  Review status:

  IMRPhenomT(HM) has been review by Maria Haney, Jacob Lange, Jonathan Thompson and Eleanor Hamilton. Review wiki: https://git.ligo.org/waveforms/reviews/phenomt/-/wikis/home. IMRPhenomTP(HM) are being reviewed by the same team under the same wiki page.

Routines for IMRPhenomT
C code for the IMRPhenomT phenomenological waveform model Author Héctor Estellés
int	XLALSimIMRPhenomT (REAL8TimeSeries **hp, REAL8TimeSeries **hc, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
	Routine to compute time domain polarisations for IMRPhenomT model. More...

Routines for IMRPhenomTHM
C code for the IMRPhenomTHM phenomenological waveform model Author Héctor Estellés IMRPhenomTHM is a phenomenological model in the time domain for aligned-spin binary black hole coalescences, calibrated to Numerical Relativity simulations for comparable mass ratio and Teukolsky waveforms for extreme mass ratio. The model produces IMR waveforms for the Spin-Weighted Spherical Harmonic modes (l,m)=(2,2), (2,1), (3,3), (4,4) and (5,5), obtaining the corresponding negative m modes by symmetry. For selecting a particular list of modes to be returned or to be employed in the polarisations construction, the user can follow the usual procedure: Create a mode array object with lalsimulation.SimInspiralCreateModeArray Activate the desired modes with lalsim.SimInspiralModeArrayActivateMode Insert the mode array into a LAL dictionary with lalsim.SimInspiralWaveformParamsInsertModeArray Pass the LAL ditionary to ChooseTDWaveform or ChooseTDModes. For a user specified mode array, only the implemented modes in the model will be computed. User option for selecting (2,2) phase and frequency reconstruction through LAL parameter PhenomTHMInspiralVersion. Default (0) will reconstruct with only 1 inspiral region modelled by TaylorT3 with the merger time parameter tt0 set to 0 and additional higher order terms. Non-default will provide an early inspiral region for imensionless PN time parameter theta<0.33, constructed with pure TaylorT3 (without higher orders) with tt0 calibrated across parameter space. Both options maintained for code historical reasons, but not clear benefit from non-default option was found. Model has been calibrated to 531 BBH non-precessing NR simulations from the last release of the SXS Catalog (https://iopscience.iop.org/article/10.1088/1361-6382/ab34e2), additional BAM NR simulations at q=4, q=8 and q=18, and numerical Teukolsky waveforms placed at q=200 and q=1000. Calibration procedure has followed the hierarchical data-driven fitting approach (Xisco Jimenez-Forteza et al https://arxiv.org/abs/1611.00332) using the symmetric mass ratio eta, dimensionless effective spin Shat=(m1^2*chi1+m2^2*chi2)/(m1^2+m2^2) and spin difference dchi=chi1-chi2. Supplementary material for the fits of the various collocation points and phenomenological coefficients is available at https://git.ligo.org/waveforms/reviews/phenomt/-/tree/master/SupplementaryMaterial/Fits3DPhenomTHM.
int	XLALSimIMRPhenomTHM (REAL8TimeSeries **hp, REAL8TimeSeries **hc, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
	Routine to compute time domain polarisations for IMRPhenomTHM model. More...
SphHarmTimeSeries *	XLALSimIMRPhenomTHM_Modes (REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
	Routine to compute time domain Spin-Weighted Spherical Harmonic modes for IMRPhenomTHM model. More...

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

Routines for spin evolution
C Code for the spin evolution of the IMRPhenomTP(HM) models. Author Héctor Estellés
int	XLALSimIMRPhenomTPHM_EvolveOrbit (REAL8TimeSeries **V, REAL8TimeSeries **S1x, REAL8TimeSeries **S1y, REAL8TimeSeries **S1z, REAL8TimeSeries **S2x, REAL8TimeSeries **S2y, REAL8TimeSeries **S2z, REAL8TimeSeries **LNhatx, REAL8TimeSeries **LNhaty, REAL8TimeSeries **LNhatz, REAL8TimeSeries **E1x, REAL8TimeSeries **E1y, REAL8TimeSeries **E1z, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
	Function to return the time series for the evolution of the individual spins, the Newtonian angular momentum direction and the orbital plane basis vector E. More...

Function Documentation

XLALSimIMRPhenomT()

int XLALSimIMRPhenomT	(	REAL8TimeSeries **	hp,
		REAL8TimeSeries **	hc,
		REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1L,
		REAL8	chi2L,
		REAL8	distance,
		REAL8	inclination,
		REAL8	deltaT,
		REAL8	fmin,
		REAL8	fRef,
		REAL8	phiRef,
		LALDict *	lalParams
	)

Routine to compute time domain polarisations for IMRPhenomT model.

It returns two real time series for the plus and the cross polarisations, constructed with the modes (l,m)=(2,2), (2,-2).

Parameters

[out]	hp	TD waveform for plus polarisation
[out]	hc	TD waveform for cross polarisation
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1L	Dimensionless aligned spin of companion 1
	chi2L	Dimensionless aligned spin of companion 2
	distance	Luminosity distance (m)
	inclination	inclination of source (rad)
	deltaT	sampling interval (s)
	fmin	starting GW frequency (Hz)
	fRef	reference GW frequency (Hz)
	phiRef	reference orbital phase (rad)
	lalParams	LAL dictionary containing accessory parameters

Definition at line 94 of file LALSimIMRPhenomTHM.c.

XLALSimIMRPhenomTHM()

int XLALSimIMRPhenomTHM	(	REAL8TimeSeries **	hp,
		REAL8TimeSeries **	hc,
		REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1L,
		REAL8	chi2L,
		REAL8	distance,
		REAL8	inclination,
		REAL8	deltaT,
		REAL8	fmin,
		REAL8	fRef,
		REAL8	phiRef,
		LALDict *	lalParams
	)

Routine to compute time domain polarisations for IMRPhenomTHM model.

It returns two real time series for the plus and the cross polarisations, constructed with the modes specified in lalParams that correspond to included modes in the model: (l,m)=(2,2), (2,1), (3,3), (4,4) and (5,5) and the corresponding negative m modes.

Parameters

[out]	hp	TD waveform for plus polarisation
[out]	hc	TD waveform for cross polarisation
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1L	Dimensionless aligned spin of companion 1
	chi2L	Dimensionless aligned spin of companion 2
	distance	Luminosity distance (m)
	inclination	inclination of source (rad)
	deltaT	sampling interval (s)
	fmin	starting GW frequency (Hz)
	fRef	reference GW frequency (Hz)
	phiRef	reference orbital phase (rad)
	lalParams	LAL dictionary containing accessory parameters

Definition at line 218 of file LALSimIMRPhenomTHM.c.

XLALSimIMRPhenomTHM_Modes()

SphHarmTimeSeries * XLALSimIMRPhenomTHM_Modes	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1L,
		REAL8	chi2L,
		REAL8	distance,
		REAL8	deltaT,
		REAL8	fmin,
		REAL8	fRef,
		REAL8	phiRef,
		LALDict *	lalParams
	)

Routine to compute time domain Spin-Weighted Spherical Harmonic modes for IMRPhenomTHM model.

It returns a SphHarmTimeSeries structure, with complex time series for each mode generated.

Parameters

m1_SI	Mass of companion 1 (kg)
m2_SI	Mass of companion 2 (kg)
chi1L	Dimensionless aligned spin of companion 1
chi2L	Dimensionless aligned spin of companion 2
distance	Luminosity distance (m)
deltaT	sampling interval (s)
fmin	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
phiRef	reference orbital phase (rad)
lalParams	LAL dictionary containing accessory parameters

Definition at line 285 of file LALSimIMRPhenomTHM.c.

XLALSimIMRPhenomTP()

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.

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/HM models.

Parameters

[out]	hp	TD waveform for plus polarisation
[out]	hc	TD waveform for cross polarisation
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1x	x component of primary spin
	chi1y	y component of primary spin
	chi1z	z component of primary spin
	chi2x	x component of secondary spin
	chi2y	y component of secondary spin
	chi2z	z component of secondary spin
	distance	Luminosity distance (m)
	inclination	inclination (in rad)
	deltaT	sampling interval (s)
	fmin	starting GW frequency (Hz)
	fRef	reference GW frequency (Hz)
	phiRef	reference orbital phase (rad)
	lalParams	LAL dictionary containing accessory parameters

Definition at line 120 of file LALSimIMRPhenomTPHM.c.

XLALSimIMRPhenomTPHM()

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.

Parameters

[out]	hp	TD waveform for plus polarisation
[out]	hc	TD waveform for cross polarisation
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1x	x component of primary spin
	chi1y	y component of primary spin
	chi1z	z component of primary spin
	chi2x	x component of secondary spin
	chi2y	y component of secondary spin
	chi2z	z component of secondary spin
	distance	Luminosity distance (m)
	inclination	inclination (in rad)
	deltaT	sampling interval (s)
	fmin	starting GW frequency (Hz)
	fRef	reference GW frequency (Hz)
	phiRef	reference orbital phase (rad)
	lalParams	LAL dictionary containing accessory parameters

Definition at line 212 of file LALSimIMRPhenomTPHM.c.

XLALSimIMRPhenomTPHM_ChooseTDModes()

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.

This is a wrapper for ChooseTDModes with the following justification: it is desirable to mantain a formal dependence on reference phase and inclination for producing the L0 modes employed in the polarisations, in the function XLALSimIMRPhenomTPHM_L0Modes. Although by construction L0 frame modes are independent of these parameters, this will allow to check if this actually satisfied if a new angle description is included. Since for ChooseTDModes one cannot pass these parameters, they are set to 0 in this wrapper.

Parameters

m1_SI	Mass of companion 1 (kg)
m2_SI	Mass of companion 2 (kg)
chi1x	x component of primary spin
chi1y	y component of primary spin
chi1z	z component of primary spin
chi2x	x component of secondary spin
chi2y	y component of secondary spin
chi2z	z component of secondary spin
distance	Luminosity distance (m)
deltaT	sampling interval (s)
fmin	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
lalParams	LAL dictionary containing accessory parameters

Definition at line 290 of file LALSimIMRPhenomTPHM.c.

XLALSimIMRPhenomTPHM_L0Modes()

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.

This function calls XLALSimIMRPhenomTPHM_JModes for producing the modes in the J-frame and the Euler angles employed in the rotation between the co-precessing frame and the J-frame. Then it reads the angles value corresponding to the specified reference frequency and performs and inverse global rotation with these angles from the J-frame to the L0-frame.

Parameters

[out]	hlmI	Modes in the intertial L0=z frame
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1x	x component of primary spin
	chi1y	y component of primary spin
	chi1z	z component of primary spin
	chi2x	x component of secondary spin
	chi2y	y component of secondary spin
	chi2z	z component of secondary spin
	distance	Luminosity distance (m)
	inclination	inclination (in rad)
	deltaT	sampling interval (s)
	fmin	starting GW frequency (Hz)
	fRef	reference GW frequency (Hz)
	phiRef	reference orbital phase (rad)
	lalParams	LAL dictionary containing accessory parameters
	only22	Flag for calling only IMRPhenomTP (dominant 22 coprec mode only)

Definition at line 328 of file LALSimIMRPhenomTPHM.c.

XLALSimIMRPhenomTPHM_JModes()

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.

It also outputs the time series for the precessing Euler angles in the J-frame.

Parameters

[out]	hlmJ	Modes in the intertial J0=z frame
[out]	alphaTS	Precessing Euler angle alpha
[out]	cosbetaTS	Precessing Euler angle beta
[out]	gammaTS	Precessing Euler angle gamma
[out]	af	Final spin
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1x	x component of primary spin
	chi1y	y component of primary spin
	chi1z	z component of primary spin
	chi2x	x component of secondary spin
	chi2y	y component of secondary spin
	chi2z	z component of secondary spin
	distance	Luminosity distance (m)
	inclination	inclination (in rad)
	deltaT	sampling interval (s)
	fmin	starting GW frequency (Hz)
	fRef	reference GW frequency (Hz)
	phiRef	reference orbital phase (rad)
	lalParams	LAL dictionary containing accessory parameters
	only22	Flag for calling only IMRPhenomTP (dominant 22 coprec mode only)

Definition at line 419 of file LALSimIMRPhenomTPHM.c.

XLALSimIMRPhenomTPHM_CoprecModes()

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.

It also outputs the time series for the precessing Euler angles in the J-frame.

Parameters

[out]	hlmJ	Modes in the intertial J0=z frame
[out]	alphaTS	Precessing Euler angle alpha
[out]	cosbetaTS	Precessing Euler angle beta
[out]	gammaTS	Precessing Euler angle gamma
[out]	af	Final spin
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1x	x component of primary spin
	chi1y	y component of primary spin
	chi1z	z component of primary spin
	chi2x	x component of secondary spin
	chi2y	y component of secondary spin
	chi2z	z component of secondary spin
	distance	Luminosity distance (m)
	inclination	inclination (in rad)
	deltaT	sampling interval (s)
	fmin	starting GW frequency (Hz)
	fRef	reference GW frequency (Hz)
	phiRef	reference orbital phase (rad)
	lalParams	LAL dictionary containing accessory parameters
	only22	Flag for calling only IMRPhenomTP (dominant 22 coprec mode only)

Definition at line 469 of file LALSimIMRPhenomTPHM.c.

XLALSimIMRPhenomTPHM_EvolveOrbit()

int XLALSimIMRPhenomTPHM_EvolveOrbit	(	REAL8TimeSeries **	V,
		REAL8TimeSeries **	S1x,
		REAL8TimeSeries **	S1y,
		REAL8TimeSeries **	S1z,
		REAL8TimeSeries **	S2x,
		REAL8TimeSeries **	S2y,
		REAL8TimeSeries **	S2z,
		REAL8TimeSeries **	LNhatx,
		REAL8TimeSeries **	LNhaty,
		REAL8TimeSeries **	LNhatz,
		REAL8TimeSeries **	E1x,
		REAL8TimeSeries **	E1y,
		REAL8TimeSeries **	E1z,
		REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1x,
		REAL8	chi1y,
		REAL8	chi1z,
		REAL8	chi2x,
		REAL8	chi2y,
		REAL8	chi2z,
		REAL8	deltaT,
		REAL8	fmin,
		REAL8	fRef,
		REAL8	phiRef,
		LALDict *	lalParams
	)

Function to return the time series for the evolution of the individual spins, the Newtonian angular momentum direction and the orbital plane basis vector E.

It computes the frequency of the non-precessing 22 mode between minimum frequency and the peak time of the 22, and approximates the PN parameter v(t) from it. Thenn it calls the internal function IMRPhenomTPHM_EvolveOrbit which evolves the spin precessing PN evolution equations using the precomputed v(t) as a driver for the evolution.

Parameters

V	post-Newtonian parameter [returned]
S1x	Spin1 vector x component [returned]
S1y	Spin1 vector y component [returned]
S1z	Spin1 vector z component [returned]
S2x	Spin2 vector x component [returned]
S2y	Spin2 vector y component [returned]
S2z	Spin2 vector z component [returned]
LNhatx	unit orbital ang. mom. x [returned]
LNhaty	unit orbital ang. mom. y [returned]
LNhatz	unit orbital ang. mom. z [returned]
E1x	orb. plane basis vector x [returned]
E1y	orb. plane basis vector y [returned]
E1z	orb. plane basis vector z [returned]
m1_SI	Mass of companion 1 (kg)
m2_SI	Mass of companion 2 (kg)
chi1x	x component of primary spin
chi1y	y component of primary spin
chi1z	z component of primary spin
chi2x	x component of secondary spin
chi2y	y component of secondary spin
chi2z	z component of secondary spin
deltaT	sampling interval (s)
fmin	starting GW frequency (Hz)
fRef	reference GW frequency (Hz)
phiRef	reference orbital phase (rad)
lalParams	LAL dictionary containing accessory parameters

Definition at line 627 of file LALSimIMRPhenomTPHM_EulerAngles.c.