Detailed Description

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

These are frequency-domain models for compact binaries at comparable masses, tuned to numerical-relativity simulations.

IMRPhenomA models non-spinning binaries.
IMRPhenomB/C/D model spinning, but non-precessing binaries.
Versions A/B/C should not be used anymore unless there are very specific reasons.
IMRPhenomP models precessing binaries, based on IMRPhenomC (outdated, should not be used unless for very specific reasons).
IMRPhenomPv2 models precessing binaries, based on IMRPhenomD.
IMRPhenomHM models spinning, non-precessing binaries, based on IMRPhenomD that also includes higher order modes.
IMRPhenomPv3 models precessing binaries, based on IMRPhenomD but with a different precession prescription than IMRPhenomPv2.
IMRPhenomPv3HM models precessing binaries with higher-order modes, based on IMRPhenomHM.
The IMRPhenomX family includes updated models for aligned-spin binaries with/without higher modes (IMRPhenomXAS and IMRPhenomXHM), and for precessing binaries with/without higher modes (IMRPhenomXP and IMRPhenomXPHM). See LALSimIMRPhenomX.c for details.
IMRPhenomPv2_NRTidal models precessing binaries, adds NR-tuned tidal effects to IMRPhenomD phasing and twists the waveform to generate the corresponding precessing waveform. Two flavors of NRTidal models are available: original (_NRTidal, based on https://arxiv.org/pdf/1706.02969.pdf) and an improved version 2 (_NRTidalv2, based on https://arxiv.org/pdf/1905.06011.pdf).
IMRPhenomNSBH models single-spin, non-precessing neutron-star-black-hole binaries, based on the amplitude of IMRPhenomC and the phase of IMRPhenomD_NRTidalv2

Review status:: IMRPhenomB routines reviewed by Frank Ohme, P. Ajith, Alex Nitz and Riccardo Sturani. The review concluded with git hash 43ce3b0a8753eb266d75a43ba94b6fb6412121d0 (May 2014).

Review status:: IMRPhenomD routines reviewed by Alex Nielsen, Carl Haster, Sebastian Khan, Sascha Husa, Frank Ohme, Mark Hannam, Ofek Brinholtz, Lionel London and David Keitel. The review concluded with git hash db16d17013531cd10451c7d0c6906972ce731866 (Oct/Nov 2015).

Review status:: original IMRPhenomP not reviewed, nor going to be. IMRPhenomPv2 reviewed by Capano, Pürrer, Bohe et al. Conludeded with git hash 1354291cf6a897995a04cd12dce42b7acaca7b34 (May 2016)

Review status:: IMRPhenomPv2_NRTidal reviewed by Ohme, Haney, Khan, Samajdar, Riemenschneider, Setyawati, Hinderer. Concluded with git hash f15615215a7e70488d32137a827d63192cbe3ef6 (February 2019).

Review status:: IMRPhneomPv2_NRTidalv2 reviewed by Haney, Ossokine, Pürrer. Concluded January 2020, for details and final git hash see review wiki: https://git.ligo.org/waveforms/reviews/nrtidal_v2/-/wikis/home

Review status:: IMRPhenomHM review wiki page can be found here https://git.ligo.org/waveforms/reviews/phenomhm/wikis/home

Review status:: IMRPhenomNSBH review by Frank Ohme, Tim Dietrich, Shrobana Ghosh, Andrew Matas, Jonathan Thompson, Edward Fauchon-Jones. The review concluded on 3 February 2020. The review documentation, resources, and final git hash can be found at https://git.ligo.org/waveforms/reviews/nsbh-models/wikis/home.

Review status:: IMRPhenomPv3 review: https://git.ligo.org/waveforms/reviews/phenompv3hm/-/wikis/home

Review status:: IMRPhenomPv3HM review: https://git.ligo.org/waveforms/reviews/phenompv3hm/-/wikis/home

Review status:: IMRPhenomX family review: https://git.ligo.org/waveforms/reviews/imrphenomx/-/wikis/home

Modules
	XLALSimIMRPhenomNSBHUtility
	C code for utility routines for `IMRPhenomNSBH` phenomenological waveform model.

Routines for IMR Phenomenological Model "A"
int	XLALSimIMRPhenomAGenerateFD (COMPLEX16FrequencySeries **htilde, const REAL8 phi0, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_min, const REAL8 f_max, const REAL8 distance)
	Driver routine to compute the non-spinning, inspiral-merger-ringdown phenomenological waveform IMRPhenomA in the frequency domain. More...

int	XLALSimIMRPhenomAGenerateTD (REAL8TimeSeries hplus, REAL8TimeSeries hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination)
	Driver routine to compute the non-spinning, inspiral-merger-ringdown phenomenological waveform IMRPhenomA in the time domain. More...

double	XLALSimIMRPhenomAGetFinalFreq (const REAL8 m1, const REAL8 m2)
	Compute the default final frequency. More...

Routines for IMR Phenomenological Model "B"
double	XLALSimIMRPhenomBComputeChi (const REAL8 m1, const REAL8 m2, const REAL8 s1z, const REAL8 s2z)
	Compute the dimensionless, spin-aligned parameter chi as used in the IMRPhenomB waveform. More...

double	XLALSimIMRPhenomBGetFinalFreq (const REAL8 m1, const REAL8 m2, const REAL8 chi)
	Compute the default final frequency. More...

int	XLALSimIMRPhenomBGenerateTD (REAL8TimeSeries hplus, REAL8TimeSeries hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination)
	Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomB in the time domain. More...

int	XLALSimIMRPhenomBGenerateFD (COMPLEX16FrequencySeries **htilde, const REAL8 phi0, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance)
	Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomB in the frequency domain. More...

int	XLALSimIMRPhenomBMetricInMEtaChi (REAL8 gamma00, REAL8 gamma01, REAL8 gamma02, REAL8 gamma11, REAL8 gamma12, REAL8 gamma22, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh)
	Compute the template-space metric of the IMRPhenomB waveform in the M, eta, chi coordinates. More...

int	XLALSimIMRPhenomBMetricInTheta0Theta3Theta3S (REAL8 gamma00, REAL8 gamma01, REAL8 gamma02, REAL8 gamma11, REAL8 gamma12, REAL8 gamma22, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh)
	Compute the template-space metric of the IMRPhenomB waveform in the theta0, theta3, theta3S coordinates. More...

Routines for IMR Phenomenological Model "C"
int	XLALSimIMRPhenomCGenerateFD (COMPLEX16FrequencySeries *htilde, const REAL8 phi0, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, LALDict extraParams)
	Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomC in the frequency domain. More...

double	XLALSimIMRPhenomCGetFinalFreq (const REAL8 m1, const REAL8 m2, const REAL8 chi)
	Convenience function to quickly find the default final frequency. More...

int	XLALSimIMRPhenomCGenerateTD (REAL8TimeSeries hplus, REAL8TimeSeries hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination, LALDict *extraParams)
	Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomC in the time domain. More...

Routines for IMR Phenomenological Model "D"
C code for IMRPhenomD phenomenological waveform model. Author Michael Puerrer, Sebastian Khan, Frank Ohme This is an aligned-spin frequency domain model. See Husa et al [10], and Khan et al [12] for details. Any studies that use this waveform model should include a reference to both of these papers. Note The model was calibrated to mass-ratios [1:1,1:4,1:8,1:18]. Along the mass-ratio 1:1 line it was calibrated to spins [-0.95, +0.98]. Along the mass-ratio 1:4 line it was calibrated to spins [-0.75, +0.75]. Along the mass-ratio 1:8 line it was calibrated to spins [-0.85, +0.85]. Along the mass-ratio 1:18 line it was calibrated to spins [-0.8, +0.4]. 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://www.lsc-group.phys.uwm.edu/ligovirgo/cbcnote/WaveformsReview/IMRPhenomDCodeReview
int	XLALSimIMRPhenomDGenerateFD (COMPLEX16FrequencySeries *htilde, const REAL8 phi0, const REAL8 fRef_in, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi1, const REAL8 chi2, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, LALDict extraParams, NRTidal_version_type NRTidal_version)
	Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomD in the frequency domain. More...

int	XLALSimIMRPhenomDFrequencySequence (COMPLEX16FrequencySeries *htilde, const REAL8Sequence freqs, const REAL8 phi0, const REAL8 fRef_in, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi1, const REAL8 chi2, const REAL8 distance, LALDict *extraParams, NRTidal_version_type NRTidal_version)
	Compute waveform in LAL format at specified frequencies for the IMRPhenomD model. More...

Routines for IMR Phenomenological Model "HM"
C code for IMRPhenomHM phenomenological waveform model. Author Sebastian Khan, Francesco Pannarale, Lionel London Inspiral-merger and ringdown phenomenological, frequecny domain waveform model for binary black holes systems. Models not only the dominant (l,\|m\|) = (2,2) modes but also some of the sub-domant modes too. Model described in PhysRevLett.120.161102/1708.00404. The model is based on IMRPhenomD ([10], [12]) Note The higher mode information was not calibrated to Numerical Relativity simulation therefore the calibration range is inherited from PhenomD. 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/phenomhm/wikis/home Also a technical document in the DCC https://dcc.ligo.org/LIGO-T1800295
UNUSED int	XLALSimIMRPhenomHM (UNUSED COMPLEX16FrequencySeries hptilde, UNUSED COMPLEX16FrequencySeries hctilde, UNUSED REAL8Sequence freqs, UNUSED REAL8 m1_SI, UNUSED REAL8 m2_SI, UNUSED REAL8 chi1z, UNUSED REAL8 chi2z, UNUSED const REAL8 distance, UNUSED const REAL8 inclination, UNUSED const REAL8 phiRef, UNUSED const REAL8 deltaF, UNUSED REAL8 f_ref, UNUSED LALDict extraParams)
	Returns h+ and hx in the frequency domain. More...

Routines for IMR Phenomenological Model "NSBH"
C code for `IMRPhenomNSBH` phenomenological waveform model. Author Jonathan Thompson, Edward Fauchon-Jones, Sebastian Khan This is a single-spin, non-precessing frequency domain model. This model is based on the amplitude model described by [16] and the `IMRPhenomD` based NRTidal phase model described by [8]. Please see LIGO-T1900729 for a technical description of the implemented model. Note The model can be evaluated within the following parameter space boundary outside of which an `XLAL_EDOM` error will be thrown \( m_{\mathrm{NS}} \leq 3 M_{\odot} \) \( 1 \leq q \leq 100 \) \( 0 \leq \Lambda_2 \leq 5000 \) The model will throw a warning if it is evaluated inside the above parameter space boundary but violates any of the following conditions \( \chi_{\mathrm{NS}} = 0 \) \( m_{\mathrm{NS}} \geq 1 M_{\odot} \) \( \delta_1 \geq 0 \) \( \delta_2 \geq 10^{-4} \) \( \gamma_1 \geq 0 \) If any of the conditions on the phenomenological coefficient \( \delta_1, \delta_2, \gamma_1 \) are violated then they are increased to the values \( 0, 10^{-4}, 0 \) respectively to remove unphysical zeros in the amplitude. The models amplitude was calibrated to mass-ratios [1:2,1:3,1:4,1:5]. Along the mass-ratio 1:2 line it was calibrated to BH spins [-0.5, 0.75]. Along the mass-ratio 1:3 line it was calibrated to BH spins [-0.5, 0.75]. Along the mass-ratio 1:4 line it was calibrated to BH spins [0, 0.75]. Along the mass-ratio 1:5 line it was calibrated to BH spins [0, 0.75]. Please see [17], [14] and [16] for full details of the NR data used to calibrate the amplitude for this model. The models phase uses the phase of `IMRPhenomD_NRTidalv2`. For full details of the NR data used to calibrate the phase for this model please see [10], [12] and [8] Attention The model is usable outside this parameter range, and tests have shown that the model produces sensible results. However the current set of numerical relativity simulations for NSBH systems is limited. In particular they do not cover the mass ratio ranges and spin ranges of numerical relativity simulations that are available for BBH systems. As such you should carefully consider applications of this model for use case when evaluated outside the suggested parameter space. For more information please see the review wiki which can be found at https://git.ligo.org/waveforms/reviews/nsbh-models/wikis/home.
int	XLALSimIMRPhenomNSBHFrequencySequence (COMPLEX16FrequencySeries *htilde, const REAL8Sequence freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 chi_NS, LALDict *extraParams)
	Compute waveform in LAL format at specified frequencies for the IMRPhenomNSBH model. More...

int	XLALSimIMRPhenomNSBH (COMPLEX16FrequencySeries *htilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 chi_NS, LALDict extraParams)
	Driver routine to compute the single-spin, non-precessing, neutron-star-black-hole, inspiral-merger-ringdown phenomenological waveform IMRPhenomNSBH in the frequency domain in LAL format. More...

Routines for IMR Phenomenological Model "P"
Functions for producing IMRPhenomP waveforms for precessing binaries, as described in Hannam et al., arXiv:1308.3271 [gr-qc]. Author Michael Puerrer, Alejandro Bohe Note Three versions of IMRPhenomP are available (selected by IMRPhenomP_version): version 1 ("IMRPhenomP"): based on IMRPhenomC (outdated, not reviewed!) version 2 ("IMRPhenomPv2"): based on IMRPhenomD (to be used, currently under review as of Dec 2015) version NRTidal ("IMRPhenomPv2_NRTidal" and "IMRPhenomPv2_NRTidalv2"): based on IMRPhenomPv2 (framework for NR-tuned tidal effects added to PhenomD aligned phasing and then twisted up). Two flavors of NRTidal models are available: original ("IMRPhenomPv2_NRTidal", based on https://arxiv.org/pdf/1706.02969.pdf) and an improved version 2 ("IMRPhenomPv2_NRTidalv2", based on https://arxiv.org/pdf/1905.06011.pdf). The different NRTidal versions employ different internal switches (selected by NRTidal_version). Each IMRPhenomP version inherits its range of validity over the parameter space from the respective aligned-spin waveform. Attention A time-domain implementation of IMRPhenomPv2 is available in XLALChooseTDWaveform(). This is based on a straight-forward inverse Fourier transformation via XLALSimInspiralTDfromFD(), but it was not included in the IMRPhenomPv2 review. Use it at your own risk. IMRPhenomPv2_NRTidal is also available in the time domain through the same transformation. Visual checks have been performed during the review, and unphysical features may arise for mass ratios smaller than 1.5 and when both tidal parameters are greater than 2000. In this case, a warning is issued, both for the time and frequency domain version.
static REAL8	atan2tol (REAL8 a, REAL8 b, REAL8 tol)

int	XLALSimIMRPhenomPCalculateModelParametersOld (REAL8 chi1_l, REAL8 chi2_l, REAL8 chip, REAL8 thetaJ, REAL8 *alpha0, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_ref, const REAL8 lnhatx, const REAL8 lnhaty, const REAL8 lnhatz, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, IMRPhenomP_version_type IMRPhenomP_version)
	Deprecated : used the old convention (view frame for the spins) Function to map LAL parameters (masses, 6 spin components and Lhat at f_ref) into IMRPhenomP intrinsic parameters (chi1_l, chi2_l, chip, thetaJ, alpha0). More...

int	XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame (REAL8 chi1_l, REAL8 chi2_l, REAL8 chip, REAL8 thetaJN, REAL8 alpha0, REAL8 phi_aligned, REAL8 *zeta_polariz, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_ref, const REAL8 phiRef, const REAL8 incl, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, IMRPhenomP_version_type IMRPhenomP_version)
	Function to map LAL parameters (masses, 6 spin components, phiRef and inclination at f_ref) (assumed to be in the source frame where LN points in the z direction i.e. More...

int	XLALSimIMRPhenomP (COMPLEX16FrequencySeries hptilde, COMPLEX16FrequencySeries hctilde, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip, const REAL8 thetaJ, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 distance, const REAL8 alpha0, const REAL8 phic, const REAL8 deltaF, const REAL8 f_min, const REAL8 f_max, const REAL8 f_ref, IMRPhenomP_version_type IMRPhenomP_version, NRTidal_version_type NRTidal_version, LALDict *extraParams)
	Driver routine to compute the precessing inspiral-merger-ringdown phenomenological waveform IMRPhenomP in the frequency domain. More...

int	XLALSimIMRPhenomPFrequencySequence (COMPLEX16FrequencySeries hptilde, COMPLEX16FrequencySeries hctilde, const REAL8Sequence freqs, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip, const REAL8 thetaJ, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 distance, const REAL8 alpha0, const REAL8 phic, const REAL8 f_ref, IMRPhenomP_version_type IMRPhenomP_version, NRTidal_version_type NRTidal_version, LALDict extraParams)
	Driver routine to compute the precessing inspiral-merger-ringdown phenomenological waveform IMRPhenomP in the frequency domain. More...

Function Documentation

◆ XLALSimIMRPhenomAGenerateFD()

int XLALSimIMRPhenomAGenerateFD	(	COMPLEX16FrequencySeries **	htilde,
		const REAL8	phi0,
		const REAL8	deltaF,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance
	)

Driver routine to compute the non-spinning, inspiral-merger-ringdown phenomenological waveform IMRPhenomA in the frequency domain.

Reference:

Waveform: Eq.(4.13) and (4.16) of http://arxiv.org/pdf/0710.2335
Coefficients: Eq.(4.18) of http://arxiv.org/pdf/0710.2335 and Table I of http://arxiv.org/pdf/0712.0343

All input parameters should be SI units.

Parameters

htilde	FD waveform
phi0	orbital phase at peak (rad)
deltaF	frequency resolution (Hz)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
f_max	end frequency; if 0, set to fCut
distance	distance of source (m)

Definition at line 1286 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomAGenerateTD()

int XLALSimIMRPhenomAGenerateTD	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		const REAL8	phiPeak,
		const REAL8	deltaT,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		const REAL8	inclination
	)

Driver routine to compute the non-spinning, inspiral-merger-ringdown phenomenological waveform IMRPhenomA in the time domain.

Reference:

Waveform: Eq.(4.13) and (4.16) of http://arxiv.org/pdf/0710.2335
Coefficients: Eq.(4.18) of http://arxiv.org/pdf/0710.2335 and Table I of http://arxiv.org/pdf/0712.0343

All input parameters should be in SI units. Angles should be in radians.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiPeak	orbital phase at peak (rad)
deltaT	sampling interval (s)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
f_min	starting GW frequency (Hz)
f_max	end GW frequency; 0 defaults to ringdown cutoff freq
distance	distance of source (m)
inclination	inclination of source (rad)

Definition at line 1341 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomAGetFinalFreq()

double XLALSimIMRPhenomAGetFinalFreq	(	const REAL8	m1,
		const REAL8	m2
	)

Compute the default final frequency.

Definition at line 1426 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomBComputeChi()

double XLALSimIMRPhenomBComputeChi	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	s1z,
		const REAL8	s2z
	)

Compute the dimensionless, spin-aligned parameter chi as used in the IMRPhenomB waveform.

This is different from chi in SpinTaylorRedSpin! Reference: http://arxiv.org/pdf/0909.2867, paragraph 3.

Parameters

m1	mass of companion 1
m2	mass of companion 2
s1z	spin of companion 1
s2z	spin of companion 2

Definition at line 1447 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomBGetFinalFreq()

double XLALSimIMRPhenomBGetFinalFreq	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi
	)

Compute the default final frequency.

Definition at line 1459 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomBGenerateTD()

int XLALSimIMRPhenomBGenerateTD	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		const REAL8	phiPeak,
		const REAL8	deltaT,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	chi,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		const REAL8	inclination
	)

Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomB in the time domain.

Reference: http://arxiv.org/pdf/0909.2867

Waveform: Eq.(1)
Coefficients: Eq.(2) and Table I

All input parameters should be in SI units. Angles should be in radians.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiPeak	orbital phase at peak (rad)
deltaT	sampling interval (s)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
chi	mass-weighted aligned-spin parameter
f_min	starting GW frequency (Hz)
f_max	end GW frequency; 0 defaults to ringdown cutoff freq
distance	distance of source (m)
inclination	inclination of source (rad)

Definition at line 1479 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomBGenerateFD()

int XLALSimIMRPhenomBGenerateFD	(	COMPLEX16FrequencySeries **	htilde,
		const REAL8	phi0,
		const REAL8	deltaF,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	chi,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance
	)

Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomB in the frequency domain.

Reference: http://arxiv.org/pdf/0909.2867

Waveform: Eq.(1)
Coefficients: Eq.(2) and Table I

All input parameters should be in SI units. Angles should be in radians.

Parameters

htilde	FD waveform
phi0	orbital phase at peak (rad)
deltaF	sampling interval (Hz)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
chi	mass-weighted aligned-spin parameter
f_min	starting GW frequency (Hz)
f_max	end frequency; 0 defaults to ringdown cutoff freq
distance	distance of source (m)

Definition at line 1574 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomBMetricInMEtaChi()

int XLALSimIMRPhenomBMetricInMEtaChi	(	REAL8 *	gamma00,
		REAL8 *	gamma01,
		REAL8 *	gamma02,
		REAL8 *	gamma11,
		REAL8 *	gamma12,
		REAL8 *	gamma22,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	chi,
		const REAL8	fLow,
		const REAL8FrequencySeries *	Sh
	)

Compute the template-space metric of the IMRPhenomB waveform in the M, eta, chi coordinates.

Parameters

gamma00	template metric coeff. 00 in PN Chirp Time
gamma01	template metric coeff. 01/10 PN Chirp Time
gamma02	template metric coeff. 01/10 PN Chirp Time
gamma11	template metric coeff. 11 in PN Chirp Time
gamma12	template metric coeff. 01/10 PN Chirp Time
gamma22	template metric coeff. 01/10 PN Chirp Time
m1_SI	component mass 1 (kg)
m2_SI	component mass 2 (kg)
chi	effective spin parameter of IMRPhenomB: chi = (m1 chi1 + m2 chi2)/(m1+m2)
fLow	low-frequency cutoff (Hz)
Sh	PSD in strain per root Hertz

Definition at line 1627 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomBMetricInTheta0Theta3Theta3S()

int XLALSimIMRPhenomBMetricInTheta0Theta3Theta3S	(	REAL8 *	gamma00,
		REAL8 *	gamma01,
		REAL8 *	gamma02,
		REAL8 *	gamma11,
		REAL8 *	gamma12,
		REAL8 *	gamma22,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	chi,
		const REAL8	fLow,
		const REAL8FrequencySeries *	Sh
	)

Compute the template-space metric of the IMRPhenomB waveform in the theta0, theta3, theta3S coordinates.

Parameters

gamma00	template metric coeff. 00 in PN Chirp Time
gamma01	template metric coeff. 01/10 PN Chirp Time
gamma02	template metric coeff. 01/10 PN Chirp Time
gamma11	template metric coeff. 11 in PN Chirp Time
gamma12	template metric coeff. 01/10 PN Chirp Time
gamma22	template metric coeff. 01/10 PN Chirp Time
m1_SI	component mass 1 (kg)
m2_SI	component mass 2 (kg)
chi	effective spin parameter of IMRPhenomB: chi = (m1 chi1 + m2 chi2)/(m1+m2)
fLow	low-frequency cutoff (Hz)
Sh	PSD in strain per root Hertz

Definition at line 1667 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomCGenerateFD()

int XLALSimIMRPhenomCGenerateFD	(	COMPLEX16FrequencySeries **	htilde,
		const REAL8	phi0,
		const REAL8	deltaF,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	chi,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		LALDict *	extraParams
	)

Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomC in the frequency domain.

Reference: http://arxiv.org/pdf/1005.3306v3.pdf

Waveform: Eq.(5.3)-(5.13)
Coefficients: Eq.(5.14) and Table II

All input parameters should be in SI units. Angles should be in radians.

Parameters

htilde	FD waveform
phi0	orbital phase at peak (rad)
deltaF	sampling interval (Hz)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
chi	mass-weighted aligned-spin parameter
f_min	starting GW frequency (Hz)
f_max	end frequency; 0 defaults to ringdown cutoff freq
distance	distance of source (m)
extraParams	linked list containing the extra testing GR parameters

Definition at line 91 of file LALSimIMRPhenomC.c.

◆ XLALSimIMRPhenomCGetFinalFreq()

double XLALSimIMRPhenomCGetFinalFreq	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi
	)

Convenience function to quickly find the default final frequency.

Definition at line 163 of file LALSimIMRPhenomC.c.

◆ XLALSimIMRPhenomCGenerateTD()

int XLALSimIMRPhenomCGenerateTD	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		const REAL8	phiPeak,
		const REAL8	deltaT,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	chi,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		const REAL8	inclination,
		LALDict *	extraParams
	)

Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomC in the time domain.

(Note that this approximant was constructed as a smooth function in the frequency domain, so there might be spurious effects after transforming into the time domain. One example are small amplitude oscillations just before merger.)

Reference: http://arxiv.org/pdf/1005.3306v3.pdf

Waveform: Eq.(5.3)-(5.13)
Coefficients: Eq.(5.14) and Table II

All input parameters should be in SI units. Angles should be in radians.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiPeak	orbital phase at peak (rad)
deltaT	sampling interval (s)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
chi	mass-weighted aligned-spin parameter
f_min	starting GW frequency (Hz)
f_max	end GW frequency; 0 defaults to ringdown cutoff freq
distance	distance of source (m)
inclination	inclination of source (rad)
extraParams	linked list containing the extra testing GR parameters

Definition at line 188 of file LALSimIMRPhenomC.c.

◆ XLALSimIMRPhenomDGenerateFD()

int XLALSimIMRPhenomDGenerateFD	(	COMPLEX16FrequencySeries **	htilde,
		const REAL8	phi0,
		const REAL8	fRef_in,
		const REAL8	deltaF,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	chi1,
		const REAL8	chi2,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		LALDict *	extraParams,
		NRTidal_version_type	NRTidal_version
	)

Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomD in the frequency domain.

Reference:

Waveform: Eq. 35 and 36 in arXiv:1508.07253
Coefficients: Eq. 31 and Table V in arXiv:1508.07253

All input parameters should be in SI units. Angles should be in radians.

Compute waveform in LAL format for the IMRPhenomD model.

Returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency fLow and zeros beyond the cutoff frequency in the ringdown.

Parameters

[out]	htilde	FD waveform
	phi0	Orbital phase at fRef (rad)
	fRef_in	reference frequency (Hz)
	deltaF	Sampling frequency (Hz)
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1	Aligned-spin parameter of companion 1
	chi2	Aligned-spin parameter of companion 2
	f_min	Starting GW frequency (Hz)
	f_max	End frequency; 0 defaults to Mf = f_CUT
	distance	Distance of source (m)
	extraParams	linked list containing the extra testing GR parameters
	NRTidal_version	Version of NRTides; can be one of NRTidal versions or NoNRT_V for the BBH baseline

Definition at line 105 of file LALSimIMRPhenomD.c.

◆ XLALSimIMRPhenomDFrequencySequence()

int XLALSimIMRPhenomDFrequencySequence	(	COMPLEX16FrequencySeries **	htilde,
		const REAL8Sequence *	freqs,
		const REAL8	phi0,
		const REAL8	fRef_in,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	chi1,
		const REAL8	chi2,
		const REAL8	distance,
		LALDict *	extraParams,
		NRTidal_version_type	NRTidal_version
	)

Compute waveform in LAL format at specified frequencies for the IMRPhenomD model.

XLALSimIMRPhenomDGenerateFD() returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency and zeros beyond the cutoff frequency in the ringdown.

In contrast, XLALSimIMRPhenomDFrequencySequence() returns a complex frequency series with entries exactly at the frequencies specified in the sequence freqs (which can be unequally spaced). No zeros are added.

If XLALSimIMRPhenomDFrequencySequence() is called with frequencies that are beyond the maxium allowed geometric frequency for the ROM, zero strain is returned.

This function is designed as an entry point for reduced order quadratures.

Parameters

[out]	htilde	FD waveform
	freqs	Frequency points at which to evaluate the waveform (Hz)
	phi0	Orbital phase at fRef (rad)
	fRef_in	reference frequency (Hz)
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	chi1	Aligned-spin parameter of companion 1
	chi2	Aligned-spin parameter of companion 2
	distance	Distance of source (m)
	extraParams	linked list containing the extra testing GR parameters
	NRTidal_version	NRTidal version; either NRTidal_V or NRTidalv2_V or NoNRT_V in case of BBH baseline

Definition at line 200 of file LALSimIMRPhenomD.c.

◆ XLALSimIMRPhenomHM()

UNUSED int XLALSimIMRPhenomHM	(	UNUSED COMPLEX16FrequencySeries **	hptilde,
		UNUSED COMPLEX16FrequencySeries **	hctilde,
		UNUSED REAL8Sequence *	freqs,
		UNUSED REAL8	m1_SI,
		UNUSED REAL8	m2_SI,
		UNUSED REAL8	chi1z,
		UNUSED REAL8	chi2z,
		UNUSED const REAL8	distance,
		UNUSED const REAL8	inclination,
		UNUSED const REAL8	phiRef,
		UNUSED const REAL8	deltaF,
		UNUSED REAL8	f_ref,
		UNUSED LALDict *	extraParams
	)

Returns h+ and hx in the frequency domain.

This function can be called in the usual sense where you supply a f_min, f_max and deltaF. This is the case when deltaF > 0. If f_max = 0. then the default ending frequnecy is used. or you can also supply a custom set of discrete frequency points with which to evaluate the waveform. To do this you must call this function with deltaF <= 0.

Parameters

[out]	hptilde	Frequency-domain waveform h+
[out]	hctilde	Frequency-domain waveform hx
	freqs	Frequency points at which to evaluate the waveform (Hz)
	m1_SI	mass of companion 1 (kg)
	m2_SI	mass of companion 2 (kg)
	chi1z	z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1)
	chi2z	z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1)
	distance	distance of source (m)
	inclination	inclination of source (rad)
	phiRef	reference orbital phase (rad)
	deltaF	Sampling frequency (Hz). To use arbitrary frequency points set deltaF <= 0.
	f_ref	Reference frequency
	extraParams	linked list containing the extra testing GR parameters

Definition at line 932 of file LALSimIMRPhenomHM.c.

◆ XLALSimIMRPhenomNSBHFrequencySequence()

int XLALSimIMRPhenomNSBHFrequencySequence	(	COMPLEX16FrequencySeries **	htilde,
		const REAL8Sequence *	freqs,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	mBH_SI,
		REAL8	mNS_SI,
		REAL8	chi_BH,
		REAL8	chi_NS,
		LALDict *	extraParams
	)

Compute waveform in LAL format at specified frequencies for the IMRPhenomNSBH model.

XLALSimIMRPhenomNSBH() returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency and zeros beyond the cutoff frequency in the ringdown.

In contrast, XLALSimIMRPhenomNSBHFrequencySequence() returns a complex frequency series with entries exactly at the frequencies specified in the sequence freqs (which can be unequally spaced). No zeros are added.

This function is designed as an entry point for reduced order quadratures.

Parameters

htilde	Output: Frequency-domain waveform h+
freqs	Frequency points at which to evaluate the waveform (Hz)
phiRef	Phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
mBH_SI	Mass of BH (kg)
mNS_SI	Mass of neutron star 2 (kg)
chi_BH	Dimensionless aligned component spin of Black Hole
chi_NS	Dimensionless aligned component spin of NS
extraParams	linked list containing the extra testing GR parameters and tidal parameters

Definition at line 592 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH()

int XLALSimIMRPhenomNSBH	(	COMPLEX16FrequencySeries **	htilde,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	fLow,
		REAL8	fHigh,
		REAL8	fRef,
		REAL8	distance,
		REAL8	mBH_SI,
		REAL8	mNS_SI,
		REAL8	chi_BH,
		REAL8	chi_NS,
		LALDict *	extraParams
	)

Driver routine to compute the single-spin, non-precessing, neutron-star-black-hole, inspiral-merger-ringdown phenomenological waveform IMRPhenomNSBH in the frequency domain in LAL format.

All input parameters should be in SI units. Angles should be in radians.

Returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency fLow and zeros beyond the cutoff frequency in the ringdown.

Parameters

htilde	Output: Frequency-domain waveform h+
phiRef	Phase at reference time
deltaF	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fHigh	End frequency; 0 defaults to Mf=0.2
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
mBH_SI	Mass of BH (kg)
mNS_SI	Mass of neutron star 2 (kg)
chi_BH	Dimensionless aligned component spin of Black Hole
chi_NS	Dimensionless aligned component spin of NS
extraParams	linked list containing the extra testing GR parameters and tidal parameters

Definition at line 627 of file LALSimIMRPhenomNSBH.c.

◆ atan2tol()

static REAL8 atan2tol	(	REAL8	a,
		REAL8	b,
		REAL8	tol
	)

static

Definition at line 106 of file LALSimIMRPhenomP.c.

◆ XLALSimIMRPhenomPCalculateModelParametersOld()

int XLALSimIMRPhenomPCalculateModelParametersOld	(	REAL8 *	chi1_l,
		REAL8 *	chi2_l,
		REAL8 *	chip,
		REAL8 *	thetaJ,
		REAL8 *	alpha0,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	f_ref,
		const REAL8	lnhatx,
		const REAL8	lnhaty,
		const REAL8	lnhatz,
		const REAL8	s1x,
		const REAL8	s1y,
		const REAL8	s1z,
		const REAL8	s2x,
		const REAL8	s2y,
		const REAL8	s2z,
		IMRPhenomP_version_type	IMRPhenomP_version
	)

Deprecated : used the old convention (view frame for the spins) Function to map LAL parameters (masses, 6 spin components and Lhat at f_ref) into IMRPhenomP intrinsic parameters (chi1_l, chi2_l, chip, thetaJ, alpha0).

All input masses and frequencies should be in SI units.

See Fig. 1. in arxiv:1408.1810 for a diagram of the angles.

Parameters

[out]	chi1_l	Dimensionless aligned spin on companion 1
[out]	chi2_l	Dimensionless aligned spin on companion 2
[out]	chip	Effective spin in the orbital plane
[out]	thetaJ	Angle between J0 and line of sight (z-direction)
[out]	alpha0	Initial value of alpha angle (azimuthal precession angle)
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	f_ref	Reference GW frequency (Hz)
	lnhatx	Initial value of LNhatx: orbital angular momentum unit vector
	lnhaty	Initial value of LNhaty
	lnhatz	Initial value of LNhatz
	s1x	Initial value of s1x: dimensionless spin of BH 1
	s1y	Initial value of s1y: dimensionless spin of BH 1
	s1z	Initial value of s1z: dimensionless spin of BH 1
	s2x	Initial value of s2x: dimensionless spin of BH 2
	s2y	Initial value of s2y: dimensionless spin of BH 2
	s2z	Initial value of s2z: dimensionless spin of BH 2
	IMRPhenomP_version	IMRPhenomP(v1) uses IMRPhenomC, IMRPhenomPv2 uses IMRPhenomD

Definition at line 127 of file LALSimIMRPhenomP.c.

◆ XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame()

int XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame	(	REAL8 *	chi1_l,
		REAL8 *	chi2_l,
		REAL8 *	chip,
		REAL8 *	thetaJN,
		REAL8 *	alpha0,
		REAL8 *	phi_aligned,
		REAL8 *	zeta_polariz,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	f_ref,
		const REAL8	phiRef,
		const REAL8	incl,
		const REAL8	s1x,
		const REAL8	s1y,
		const REAL8	s1z,
		const REAL8	s2x,
		const REAL8	s2y,
		const REAL8	s2z,
		IMRPhenomP_version_type	IMRPhenomP_version
	)

Function to map LAL parameters (masses, 6 spin components, phiRef and inclination at f_ref) (assumed to be in the source frame where LN points in the z direction i.e.

lnhat = (0,0,1) and the separation vector n is in the x direction and the spherical angles of the line of sight N are (incl,Pi/2-phiRef)) into IMRPhenomP intrinsic parameters (chi1_l, chi2_l, chip, thetaJN, alpha0 and phi_aligned).

All input masses and frequencies should be in SI units.

See Fig. 1. in arxiv:1408.1810 for a diagram of the angles.

Parameters

[out]	chi1_l	Dimensionless aligned spin on companion 1
[out]	chi2_l	Dimensionless aligned spin on companion 2
[out]	chip	Effective spin in the orbital plane
[out]	thetaJN	Angle between J0 and line of sight (z-direction)
[out]	alpha0	Initial value of alpha angle (azimuthal precession angle)
[out]	phi_aligned	Initial phase to feed the underlying aligned-spin model
[out]	zeta_polariz	Angle to rotate the polarizations
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	f_ref	Reference GW frequency (Hz)
	phiRef	Reference phase
	incl	Inclination : angle between LN and the line of sight
	s1x	Initial value of s1x: dimensionless spin of BH 1
	s1y	Initial value of s1y: dimensionless spin of BH 1
	s1z	Initial value of s1z: dimensionless spin of BH 1
	s2x	Initial value of s2x: dimensionless spin of BH 2
	s2y	Initial value of s2y: dimensionless spin of BH 2
	s2z	Initial value of s2z: dimensionless spin of BH 2
	IMRPhenomP_version	IMRPhenomP(v1) uses IMRPhenomC, IMRPhenomPv2 uses IMRPhenomD, IMRPhenomPv2_NRTidal uses NRTidal framework with IMRPhenomPv2

Definition at line 262 of file LALSimIMRPhenomP.c.

◆ XLALSimIMRPhenomP()

int XLALSimIMRPhenomP	(	COMPLEX16FrequencySeries **	hptilde,
		COMPLEX16FrequencySeries **	hctilde,
		const REAL8	chi1_l,
		const REAL8	chi2_l,
		const REAL8	chip,
		const REAL8	thetaJ,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	distance,
		const REAL8	alpha0,
		const REAL8	phic,
		const REAL8	deltaF,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	f_ref,
		IMRPhenomP_version_type	IMRPhenomP_version,
		NRTidal_version_type	NRTidal_version,
		LALDict *	extraParams
	)

Driver routine to compute the precessing inspiral-merger-ringdown phenomenological waveform IMRPhenomP in the frequency domain.

Reference:

Hannam et al., arXiv:1308.3271 [gr-qc]

XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame should be called first to map LAL parameters into IMRPhenomP intrinsic parameters (chi1_l, chi2_l, chip, thetaJ, alpha0).

This function can be used for equally-spaced frequency series. For unequal spacing, use XLALSimIMRPhenomPFrequencySequence instead.

Parameters

[out]	hptilde	Frequency-domain waveform h+
[out]	hctilde	Frequency-domain waveform hx
	chi1_l	Dimensionless aligned spin on companion 1
	chi2_l	Dimensionless aligned spin on companion 2
	chip	Effective spin in the orbital plane
	thetaJ	Angle between J0 and line of sight (z-direction)
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	distance	Distance of source (m)
	alpha0	Initial value of alpha angle (azimuthal precession angle)
	phic	Orbital phase at the peak of the underlying non precessing model (rad)
	deltaF	Sampling frequency (Hz)
	f_min	Starting GW frequency (Hz)
	f_max	End frequency; 0 defaults to ringdown cutoff freq
	f_ref	Reference frequency
	IMRPhenomP_version	IMRPhenomPv1 uses IMRPhenomC, IMRPhenomPv2 uses IMRPhenomD, IMRPhenomPv2_NRTidal uses NRTidal framework with IMRPhenomPv2
	NRTidal_version	either NRTidal or NRTidalv2 for BNS waveform; NoNRT_V for BBH waveform
	extraParams	linked list that may contain the extra testing GR parameters and/or tidal parameters

Definition at line 477 of file LALSimIMRPhenomP.c.

◆ XLALSimIMRPhenomPFrequencySequence()

int XLALSimIMRPhenomPFrequencySequence	(	COMPLEX16FrequencySeries **	hptilde,
		COMPLEX16FrequencySeries **	hctilde,
		const REAL8Sequence *	freqs,
		const REAL8	chi1_l,
		const REAL8	chi2_l,
		const REAL8	chip,
		const REAL8	thetaJ,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	distance,
		const REAL8	alpha0,
		const REAL8	phic,
		const REAL8	f_ref,
		IMRPhenomP_version_type	IMRPhenomP_version,
		NRTidal_version_type	NRTidal_version,
		LALDict *	extraParams
	)

Driver routine to compute the precessing inspiral-merger-ringdown phenomenological waveform IMRPhenomP in the frequency domain.

Reference:

Hannam et al., arXiv:1308.3271 [gr-qc]

XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame should be called first to map LAL parameters into IMRPhenomP intrinsic parameters (chi1_l, chi2_l, chip, thetaJ, alpha0).

This function can be used for user-specified, potentially unequally-spaced frequency series. For equal spacing with a given deltaF, use XLALSimIMRPhenomP instead.

Parameters

[out]	hptilde	Frequency-domain waveform h+
[out]	hctilde	Frequency-domain waveform hx
	freqs	Frequency points at which to evaluate the waveform (Hz)
	chi1_l	Dimensionless aligned spin on companion 1
	chi2_l	Dimensionless aligned spin on companion 2
	chip	Effective spin in the orbital plane
	thetaJ	Angle between J0 and line of sight (z-direction)
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	distance	Distance of source (m)
	alpha0	Initial value of alpha angle (azimuthal precession angle)
	phic	Orbital phase at the peak of the underlying non precessing model (rad)
	f_ref	Reference frequency
	IMRPhenomP_version	IMRPhenomPv1 uses IMRPhenomC, IMRPhenomPv2 uses IMRPhenomD, IMRPhenomPv2_NRTidal uses NRTidal framework with IMRPhenomPv2
	NRTidal_version	either NRTidal or NRTidalv2 for BNS waveform; NoNRT_V for BBH waveform
	extraParams	linked list that may contain the extra testing GR parameters and/or tidal parameters

Definition at line 534 of file LALSimIMRPhenomP.c.

Detailed Description

Modules

Routines for IMR Phenomenological Model "A"

Routines for IMR Phenomenological Model "B"

Routines for IMR Phenomenological Model "C"

Routines for IMR Phenomenological Model "D"

Routines for IMR Phenomenological Model "HM"

Routines for IMR Phenomenological Model "NSBH"

Routines for IMR Phenomenological Model "P"

Function Documentation

◆ XLALSimIMRPhenomAGenerateFD()

◆ XLALSimIMRPhenomAGenerateTD()

◆ XLALSimIMRPhenomAGetFinalFreq()

◆ XLALSimIMRPhenomBComputeChi()

◆ XLALSimIMRPhenomBGetFinalFreq()

◆ XLALSimIMRPhenomBGenerateTD()

◆ XLALSimIMRPhenomBGenerateFD()

◆ XLALSimIMRPhenomBMetricInMEtaChi()

◆ XLALSimIMRPhenomBMetricInTheta0Theta3Theta3S()

◆ XLALSimIMRPhenomCGenerateFD()

◆ XLALSimIMRPhenomCGetFinalFreq()

◆ XLALSimIMRPhenomCGenerateTD()

◆ XLALSimIMRPhenomDGenerateFD()

◆ XLALSimIMRPhenomDFrequencySequence()

◆ XLALSimIMRPhenomHM()

◆ XLALSimIMRPhenomNSBHFrequencySequence()

◆ XLALSimIMRPhenomNSBH()

◆ atan2tol()

◆ XLALSimIMRPhenomPCalculateModelParametersOld()

◆ XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame()

◆ XLALSimIMRPhenomP()

◆ XLALSimIMRPhenomPFrequencySequence()