LALSimIMRPhenomTHM.c File Reference

Prototypes
int	LALSimIMRPhenomTHM_Modes (SphHarmTimeSeries **hlms, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams, UINT4 only22)
int	LALSimIMRPhenomTHM_OneMode (COMPLEX16TimeSeries **hlm, IMRPhenomTWaveformStruct *pWF, IMRPhenomTPhase22Struct *pPhase, REAL8Sequence *phase22, REAL8Sequence *xorb, UINT4 ell, UINT4 emm)
LALDict *	IMRPhenomTHM_setup_mode_array (LALDict *lalParams)
INT4	check_input_mode_array_THM (LALDict *lalParams)
INT4	check_input_mode_array_22_THM (LALDict *lalParams)
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...

Go to the source code of this file.

Function Documentation

LALSimIMRPhenomTHM_Modes()

int LALSimIMRPhenomTHM_Modes	(	SphHarmTimeSeries **	hlms,
		REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	chi1L,
		REAL8	chi2L,
		REAL8	distance,
		REAL8	deltaT,
		REAL8	fmin,
		REAL8	fRef,
		REAL8	phiRef,
		LALDict *	lalParams,
		UINT4	only22
	)

Parameters

[out]	hlms	Time domain modes
	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
	only22	Internal flag for mode array check

Definition at line 318 of file LALSimIMRPhenomTHM.c.

LALSimIMRPhenomTHM_OneMode()

int LALSimIMRPhenomTHM_OneMode	(	COMPLEX16TimeSeries **	hlm,
		IMRPhenomTWaveformStruct *	pWF,
		IMRPhenomTPhase22Struct *	pPhase,
		REAL8Sequence *	phase22,
		REAL8Sequence *	xorb,
		UINT4	ell,
		UINT4	emm
	)

Author

Hector Estelles

Parameters

[out]	hlm	Time domain waveform of the requested (l,m) mode
	pWF	Waveform structure
	pPhase	22 phase and frequency structure
	phase22	Values of the 22 phase for the waveform time array
	xorb	Values of the 22 frequency for the waveform time array
	ell	l value of the requested mode
	emm	m value of the requested mode

Definition at line 552 of file LALSimIMRPhenomTHM.c.

IMRPhenomTHM_setup_mode_array()

LALDict* IMRPhenomTHM_setup_mode_array

(

LALDict *

lalParams

)

Definition at line 678 of file LALSimIMRPhenomTHM.c.

check_input_mode_array_THM()

INT4 check_input_mode_array_THM

(

LALDict *

lalParams

)

Definition at line 711 of file LALSimIMRPhenomTHM.c.

check_input_mode_array_22_THM()

INT4 check_input_mode_array_22_THM

(

LALDict *

lalParams

)

Definition at line 755 of file LALSimIMRPhenomTHM.c.