External (SWIG'd) Auxiliary functions for phenomenological model development. More...

Prototypes
double	XLALSimPhenomUtilsMftoHz (REAL8 Mf, REAL8 Mtot_Msun)
	Convert from geometric frequency to frequency in Hz. More...

double	XLALSimPhenomUtilsHztoMf (REAL8 fHz, REAL8 Mtot_Msun)
	Convert from frequency in Hz to geometric frequency. More...

double	XLALSimPhenomUtilsFDamp0 (REAL8 Mtot_Msun, REAL8 distance)
	compute the frequency domain amplitude pre-factor More...

REAL8	XLALSimPhenomUtilsPhenomPv2FinalSpin (const REAL8 m1, const REAL8 m2, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip)
	Wrapper for final-spin formula based on: More...

double	XLALSimPhenomUtilsIMRPhenomDFinalMass (REAL8 m1, REAL8 m2, REAL8 chi1z, REAL8 chi2z)
	Helper function used in PhenomHM and PhenomPv3HM Returns the final mass from the fit used in PhenomD. More...

REAL8	XLALSimPhenomUtilsPhenomPv3HMFinalSpin (const REAL8 m1, const REAL8 m2, const REAL8 chi1x, const REAL8 chi1y, const REAL8 chi1z, const REAL8 chi2x, const REAL8 chi2y, const REAL8 chi2z)
	Wrapper for final-spin formula based on: More...

REAL8	XLALSimPhenomUtilsChiP (const REAL8 m1, const REAL8 m2, const REAL8 s1x, const REAL8 s1y, const REAL8 s2x, const REAL8 s2y)
	Function to compute the effective precession parameter chi_p (1408.1810) More...

IMRPhenomPv3HMYlmStruct *	XLALSimIMRPhenomPv3HMComputeYlmElements (REAL8 theta, REAL8 phi, INT4 ell)

int	XLALSimIMRPhenomPv3HMComputeAlphaElements (IMRPhenomPv3HMAlphaStruct **p, UINT4 ell, REAL8 alpha)

int	XLALSimIMRPhenomPv3HMComputeWignerdElements (IMRPhenomPv3HMWignderStruct **p, UNUSED UINT4 ell, UNUSED INT4 mprime, UNUSED REAL8 b)
	computes the wigner-d elements for -beta in batches. More...

int	XLALSimPhenomUtilsPhenomPv3HMWignerdElement (REAL8 *wig_d, UINT4 ell, INT4 mprime, INT4 mm, REAL8 b)
	Hard coded expressions for relevant Wignerd matrix elements. More...

Detailed Description

External (SWIG'd) Auxiliary functions for phenomenological model development.

Author: Sebastian Khan

Helper functions for phenomenological waveform models Can be used through python SWIG wrapping NOTE: The convention for naming functions in there is to use the prefix 'XLALSimPhenom_'

Definition in file LALSimIMRPhenomUtils.c.

Go to the source code of this file.

Function Documentation

◆ XLALSimPhenomUtilsMftoHz()

double XLALSimPhenomUtilsMftoHz	(	REAL8	Mf,
		REAL8	Mtot_Msun
	)

Convert from geometric frequency to frequency in Hz.

Parameters

Mf	Geometric frequency
Mtot_Msun	Total mass in solar masses

Definition at line 48 of file LALSimIMRPhenomUtils.c.

◆ XLALSimPhenomUtilsHztoMf()

double XLALSimPhenomUtilsHztoMf	(	REAL8	fHz,
		REAL8	Mtot_Msun
	)

Convert from frequency in Hz to geometric frequency.

Parameters

fHz	Frequency in Hz
Mtot_Msun	Total mass in solar masses

Definition at line 59 of file LALSimIMRPhenomUtils.c.

◆ XLALSimPhenomUtilsFDamp0()

double XLALSimPhenomUtilsFDamp0	(	REAL8	Mtot_Msun,
		REAL8	distance
	)

compute the frequency domain amplitude pre-factor

Parameters

Mtot_Msun	total mass in solar masses
distance	distance (m)

Definition at line 70 of file LALSimIMRPhenomUtils.c.

◆ XLALSimPhenomUtilsPhenomPv2FinalSpin()

REAL8 XLALSimPhenomUtilsPhenomPv2FinalSpin	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi1_l,
		const REAL8	chi2_l,
		const REAL8	chip
	)

Wrapper for final-spin formula based on:

IMRPhenomD's FinalSpin0815() for aligned spins.

We use their convention m1>m2 and put all in-plane spin on the larger BH.

In the aligned limit return the FinalSpin0815 value.

Function should reproduce the function FinalSpinIMRPhenomD_all_in_plane_spin_on_larger_BH

Parameters

m1	Mass of companion 1 (solar masses)
m2	Mass of companion 2 (solar masses)
chi1_l	Aligned spin of BH 1
chi2_l	Aligned spin of BH 2
chip	Dimensionless spin in the orbital plane

Definition at line 90 of file LALSimIMRPhenomUtils.c.

◆ XLALSimPhenomUtilsIMRPhenomDFinalMass()

double XLALSimPhenomUtilsIMRPhenomDFinalMass	(	REAL8	m1,
		REAL8	m2,
		REAL8	chi1z,
		REAL8	chi2z
	)

Helper function used in PhenomHM and PhenomPv3HM Returns the final mass from the fit used in PhenomD.

Parameters

m1	mass of primary in solar masses
m2	mass of secondary in solar masses
chi1z	aligned-spin component on primary
chi2z	aligned-spin component on secondary

Definition at line 121 of file LALSimIMRPhenomUtils.c.

◆ XLALSimPhenomUtilsPhenomPv3HMFinalSpin()

REAL8 XLALSimPhenomUtilsPhenomPv3HMFinalSpin	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi1x,
		const REAL8	chi1y,
		const REAL8	chi1z,
		const REAL8	chi2x,
		const REAL8	chi2y,
		const REAL8	chi2z
	)

Wrapper for final-spin formula based on:

IMRPhenomD's FinalSpin0815() for aligned spins.

We use their convention m1>m2 and use all in-plane spin components to determine the final spin magnitude.

In the aligned limit return the FinalSpin0815 value.

Parameters

m1	Mass of companion 1 (solar masses)
m2	Mass of companion 2 (solar masses)
chi1x	x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1)
chi1y	y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1)
chi1z	z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1)
chi2x	x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1)
chi2y	y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1)
chi2z	z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1)

Definition at line 152 of file LALSimIMRPhenomUtils.c.

◆ XLALSimPhenomUtilsChiP()

REAL8 XLALSimPhenomUtilsChiP	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	s1x,
		const REAL8	s1y,
		const REAL8	s2x,
		const REAL8	s2y
	)

Function to compute the effective precession parameter chi_p (1408.1810)

Parameters

m1	Mass of companion 1 (solar masses)
m2	Mass of companion 2 (solar masses)
s1x	x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1)
s1y	y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1)
s2x	x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1)
s2y	y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1)

Definition at line 190 of file LALSimIMRPhenomUtils.c.

◆ XLALSimIMRPhenomPv3HMComputeYlmElements()

IMRPhenomPv3HMYlmStruct* XLALSimIMRPhenomPv3HMComputeYlmElements	(	REAL8	theta,
		REAL8	phi,
		INT4	ell
	)

Definition at line 222 of file LALSimIMRPhenomUtils.c.

◆ XLALSimIMRPhenomPv3HMComputeAlphaElements()

int XLALSimIMRPhenomPv3HMComputeAlphaElements	(	IMRPhenomPv3HMAlphaStruct **	p,
		UINT4	ell,
		REAL8	alpha
	)

Definition at line 275 of file LALSimIMRPhenomUtils.c.

◆ XLALSimIMRPhenomPv3HMComputeWignerdElements()

int XLALSimIMRPhenomPv3HMComputeWignerdElements	(	IMRPhenomPv3HMWignderStruct **	p,
		UNUSED UINT4	ell,
		UNUSED INT4	mprime,
		UNUSED REAL8	b
	)

computes the wigner-d elements for -beta in batches.

mprime - only takes positive values as the negative values are added automatically according to the symmetry d^{ell}_{-m',-m} = (-1)^{m'+m} d^{ell}_{m',m}.

Definition at line 355 of file LALSimIMRPhenomUtils.c.

◆ XLALSimPhenomUtilsPhenomPv3HMWignerdElement()

int XLALSimPhenomUtilsPhenomPv3HMWignerdElement	(	REAL8 *	wig_d,
		UINT4	ell,
		INT4	mprime,
		INT4	mm,
		REAL8	b
	)

Hard coded expressions for relevant Wignerd matrix elements.

Only certain elements are coded up. These were obtained using sympy and cross checked numerically against the LAL XLALWignerdMatrix function

Parameters

[out]	wig_d	element of Wignerd Matrix
	ell	spherical harmonics ell mode
	mprime	spherical harmonics m prime mode
	mm	spherical harmonics m mode
	b	beta angle (rad)

Definition at line 635 of file LALSimIMRPhenomUtils.c.

Prototypes

Detailed Description

Function Documentation

◆ XLALSimPhenomUtilsMftoHz()

◆ XLALSimPhenomUtilsHztoMf()

◆ XLALSimPhenomUtilsFDamp0()

◆ XLALSimPhenomUtilsPhenomPv2FinalSpin()

◆ XLALSimPhenomUtilsIMRPhenomDFinalMass()

◆ XLALSimPhenomUtilsPhenomPv3HMFinalSpin()

◆ XLALSimPhenomUtilsChiP()

◆ XLALSimIMRPhenomPv3HMComputeYlmElements()

◆ XLALSimIMRPhenomPv3HMComputeAlphaElements()

◆ XLALSimIMRPhenomPv3HMComputeWignerdElements()

◆ XLALSimPhenomUtilsPhenomPv3HMWignerdElement()