LALSimIMRPhenomP.h File Reference

Prototypes
static REAL8	atan2tol (REAL8 x, REAL8 y, REAL8 tol)
static BBHPhenomCParams *	ComputeIMRPhenomCParamsRDmod (const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 chip, LALDict *extraParams)
static void	ComputeNNLOanglecoeffs (NNLOanglecoeffs *angcoeffs, const REAL8 q, const REAL8 chil, const REAL8 chip)
static int	PhenomPCore (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8 chi1_l_in, const REAL8 chi2_l_in, const REAL8 chip, const REAL8 thetaJ, const REAL8 m1_SI_in, const REAL8 m2_SI_in, const REAL8 distance, const REAL8 alpha0, const REAL8 phic, const REAL8 f_ref, const REAL8Sequence *freqs, double deltaF, IMRPhenomP_version_type IMRPhenomP_version, NRTidal_version_type NRTidal_version, LALDict *extraParams)
static int	PhenomPCoreOneFrequency (const REAL8 fHz, const REAL8 eta, const REAL8 distance, const REAL8 M, const REAL8 phic, IMRPhenomDAmplitudeCoefficients *pAmp, IMRPhenomDPhaseCoefficients *pPhi, BBHPhenomCParams *PCparams, PNPhasingSeries *PNparams, COMPLEX16 *hPhenom, REAL8 *phasing, const UINT4 IMRPhenomP_version, AmpInsPrefactors *amp_prefactors, PhiInsPrefactors *phi_prefactors)
static int	PhenomPCoreTwistUp (const REAL8 fHz, COMPLEX16 hPhenom, const REAL8 eta, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip, const REAL8 M, NNLOanglecoeffs *angcoeffs, SpinWeightedSphericalHarmonic_l2 *Y2m, const REAL8 alphaoffset, const REAL8 epsilonoffset, COMPLEX16 *hp, COMPLEX16 *hc, IMRPhenomP_version_type IMRPhenomP_version)
static REAL8	L2PNR (const REAL8 v, const REAL8 eta)
static REAL8	L2PNR_v1 (const REAL8 v, const REAL8 eta)
static void	WignerdCoefficients (REAL8 *cos_beta_half, REAL8 *sin_beta_half, const REAL8 v, const REAL8 SL, const REAL8 eta, const REAL8 Sp)
static void	WignerdCoefficients_SmallAngleApproximation (REAL8 *cos_beta_half, REAL8 *sin_beta_half, const REAL8 v, const REAL8 SL, const REAL8 eta, const REAL8 Sp)
static void	CheckMaxOpeningAngle (const REAL8 m1, const REAL8 m2, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip)
static REAL8	FinalSpinIMRPhenomD_all_in_plane_spin_on_larger_BH (const REAL8 m1, const REAL8 m2, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip)
static REAL8	FinalSpinBarausse2009_all_spin_on_larger_BH (const REAL8 nu, const REAL8 chi, const REAL8 chip)
static REAL8	FinalSpinBarausse2009 (const REAL8 nu, const REAL8 a1, const REAL8 a2, const REAL8 cos_alpha, const REAL8 cos_beta_tilde, const REAL8 cos_gamma_tilde)
static bool	approximately_equal (REAL8 x, REAL8 y, REAL8 epsilon)
static void	nudge (REAL8 *x, REAL8 X, REAL8 epsilon)
static int	PhenomPCoreOneFrequency_withTides (const REAL8 fHz, const REAL8 window, const REAL8 ampTidal, const REAL8 phaseTidal, const REAL8 distance, const REAL8 M, const REAL8 phic, IMRPhenomDAmplitudeCoefficients *pAmp, IMRPhenomDPhaseCoefficients *pPhi, PNPhasingSeries *PNparams, COMPLEX16 *hPhenom, REAL8 *phasing, AmpInsPrefactors *amp_prefactors, PhiInsPrefactors *phi_prefactors)

Go to the source code of this file.

Data Structures
struct	NNLOanglecoeffs
struct	SpinWeightedSphericalHarmonic_l2

Macros
#define	MAX_TOL_ATAN   1.0e-15
	Tolerance used below which numbers are treated as zero for the calculation of atan2. More...

Macro Definition Documentation

MAX_TOL_ATAN

#define MAX_TOL_ATAN   1.0e-15

Tolerance used below which numbers are treated as zero for the calculation of atan2.

Definition at line 39 of file LALSimIMRPhenomP.h.

Function Documentation

atan2tol()

static REAL8 atan2tol ( REAL8  x, REAL8  y, REAL8  tol  )

static

ComputeIMRPhenomCParamsRDmod()

static BBHPhenomCParams* ComputeIMRPhenomCParamsRDmod ( const REAL8  m1, const REAL8  m2, const REAL8  chi, const REAL8  chip, LALDict *  extraParams  )

static

Parameters

m1	Mass of companion 1 (solar masses)
m2	Mass of companion 2 (solar masses)
chi	Reduced aligned spin of the binary chi = (m1*chi1 + m2*chi2)/M
chip	Dimensionless spin in the orbital plane
extraParams	linked list containing the extra testing GR parameters

ComputeNNLOanglecoeffs()

static void ComputeNNLOanglecoeffs ( NNLOanglecoeffs *  angcoeffs, const REAL8  q, const REAL8  chil, const REAL8  chip  )

static

Parameters

angcoeffs	Output: Structure to store results
q	Mass-ratio (convention q>1)
chil	Dimensionless aligned spin of the largest BH
chip	Dimensionless spin component in the orbital plane

PhenomPCore()

static int PhenomPCore ( COMPLEX16FrequencySeries **  hptilde, COMPLEX16FrequencySeries **  hctilde, const REAL8  chi1_l_in, const REAL8  chi2_l_in, const REAL8  chip, const REAL8  thetaJ, const REAL8  m1_SI_in, const REAL8  m2_SI_in, const REAL8  distance, const REAL8  alpha0, const REAL8  phic, const REAL8  f_ref, const REAL8Sequence *  freqs, double  deltaF, IMRPhenomP_version_type  IMRPhenomP_version, NRTidal_version_type  NRTidal_version, LALDict *  extraParams  )

static

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
chi1_l_in	Dimensionless aligned spin on companion 1
chi2_l_in	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_in	Mass of companion 1 (kg)
m2_SI_in	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
freqs	Frequency points at which to evaluate the waveform (Hz)
deltaF	Sampling frequency (Hz). If deltaF > 0, the frequency points given in freqs are uniformly spaced with spacing deltaF. Otherwise, the frequency points are spaced non-uniformly. Then we will use deltaF = 0 to create the frequency series we return.
IMRPhenomP_version	IMRPhenomPv1 uses IMRPhenomC, IMRPhenomPv2 uses IMRPhenomD, IMRPhenomPv2_NRTidal is a tidal version of IMRPhenomPv2
NRTidal_version	either NRTidal or NRTidalv2 for BNS waveform; NoNRT_V for BBH waveform
extraParams	linked list containing the extra testing GR parameters

PhenomPCoreOneFrequency()

static int PhenomPCoreOneFrequency ( const REAL8  fHz, const REAL8  eta, const REAL8  distance, const REAL8  M, const REAL8  phic, IMRPhenomDAmplitudeCoefficients *  pAmp, IMRPhenomDPhaseCoefficients *  pPhi, BBHPhenomCParams *  PCparams, PNPhasingSeries *  PNparams, COMPLEX16 *  hPhenom, REAL8 *  phasing, const UINT4  IMRPhenomP_version, AmpInsPrefactors *  amp_prefactors, PhiInsPrefactors *  phi_prefactors  )

static

Parameters

fHz	Frequency (Hz)
eta	Symmetric mass ratio
distance	Distance of source (m)
M	Total mass (Solar masses)
phic	Orbital phase at the peak of the underlying non precessing model (rad)
pAmp	Internal IMRPhenomD amplitude coefficients
pPhi	Internal IMRPhenomD phase coefficients
PCparams	Internal PhenomC parameters
PNparams	PN inspiral phase coefficients
hPhenom	Output: IMRPhenom waveform (before precession)
phasing	Output: overall phasing
IMRPhenomP_version	Version number: 1 uses IMRPhenomC, 2 uses IMRPhenomD, NRTidal uses IMRPhenomPv2 with the NRTidal framework
amp_prefactors	pre-calculated (cached for saving runtime) coefficients for amplitude. See LALSimIMRPhenomD_internals.c
phi_prefactors	pre-calculated (cached for saving runtime) coefficients for phase. See LALSimIMRPhenomD_internals.

PhenomPCoreTwistUp()

static int PhenomPCoreTwistUp ( const REAL8  fHz, COMPLEX16  hPhenom, const REAL8  eta, const REAL8  chi1_l, const REAL8  chi2_l, const REAL8  chip, const REAL8  M, NNLOanglecoeffs *  angcoeffs, SpinWeightedSphericalHarmonic_l2 *  Y2m, const REAL8  alphaoffset, const REAL8  epsilonoffset, COMPLEX16 *  hp, COMPLEX16 *  hc, IMRPhenomP_version_type  IMRPhenomP_version  )

static

Parameters

	fHz	Frequency (Hz)
[in]	hPhenom	IMRPhenom waveform (before precession)
	eta	Symmetric mass ratio
	chi1_l	Dimensionless aligned spin on companion 1
	chi2_l	Dimensionless aligned spin on companion 2
	chip	Dimensionless spin in the orbital plane
	M	Total mass (Solar masses)
	angcoeffs	Struct with PN coeffs for the NNLO angles
	Y2m	Struct of l=2 spherical harmonics of spin weight -2
	alphaoffset	f_ref dependent offset for alpha angle (azimuthal precession angle)
	epsilonoffset	f_ref dependent offset for epsilon angle
[out]	hp	plus polarization \(\tilde h_+\)
[out]	hc	cross polarization \(\tilde h_x\)
	IMRPhenomP_version	IMRPhenomP(v1) uses IMRPhenomC, IMRPhenomPv2 uses IMRPhenomD, IMRPhenomPv2_NRTidal uses NRTidal framework with IMRPhenomPv2

L2PNR()

static REAL8 L2PNR ( const REAL8  v, const REAL8  eta  )

static

Parameters

v	Cubic root of (Pi * Frequency (geometric))
eta	Symmetric mass-ratio

L2PNR_v1()

static REAL8 L2PNR_v1 ( const REAL8  v, const REAL8  eta  )

static

Parameters

v	Cubic root of (Pi * Frequency (geometric))
eta	Symmetric mass-ratio

WignerdCoefficients()

static void WignerdCoefficients ( REAL8 *  cos_beta_half, REAL8 *  sin_beta_half, const REAL8  v, const REAL8  SL, const REAL8  eta, const REAL8  Sp  )

static

Parameters

cos_beta_half	Output: cos(beta/2)
sin_beta_half	Output: sin(beta/2)
v	Cubic root of (Pi * Frequency (geometric))
SL	Dimensionfull aligned spin
eta	Symmetric mass-ratio
Sp	Dimensionfull spin component in the orbital plane

WignerdCoefficients_SmallAngleApproximation()

static void WignerdCoefficients_SmallAngleApproximation ( REAL8 *  cos_beta_half, REAL8 *  sin_beta_half, const REAL8  v, const REAL8  SL, const REAL8  eta, const REAL8  Sp  )

static

Parameters

cos_beta_half	Output: cos(beta/2)
sin_beta_half	Output: sin(beta/2)
v	Cubic root of (Pi * Frequency (geometric))
SL	Dimensionfull aligned spin
eta	Symmetric mass-ratio
Sp	Dimensionfull spin component in the orbital plane

CheckMaxOpeningAngle()

static void CheckMaxOpeningAngle ( const REAL8  m1, const REAL8  m2, const REAL8  chi1_l, const REAL8  chi2_l, const REAL8  chip  )

static

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

FinalSpinIMRPhenomD_all_in_plane_spin_on_larger_BH()

static REAL8 FinalSpinIMRPhenomD_all_in_plane_spin_on_larger_BH ( const REAL8  m1, const REAL8  m2, const REAL8  chi1_l, const REAL8  chi2_l, const REAL8  chip  )

static

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

FinalSpinBarausse2009_all_spin_on_larger_BH()

static REAL8 FinalSpinBarausse2009_all_spin_on_larger_BH ( const REAL8  nu, const REAL8  chi, const REAL8  chip  )

static

Parameters

nu	Symmetric mass-ratio
chi	Effective aligned spin of the binary: chi = (m1*chi1 + m2*chi2)/M
chip	Dimensionless spin in the orbital plane

FinalSpinBarausse2009()

static REAL8 FinalSpinBarausse2009 ( const REAL8  nu, const REAL8  a1, const REAL8  a2, const REAL8  cos_alpha, const REAL8  cos_beta_tilde, const REAL8  cos_gamma_tilde  )

static

Parameters

nu	Symmetric mass-ratio
a1	|a_1| norm of dimensionless spin vector for BH 1
a2	|a_2| norm of dimensionless spin vector for BH 2
cos_alpha	cos(alpha) = \hat a_1 . \hat a_2 (Eq. 7)
cos_beta_tilde	cos(\tilde beta) = \hat a_1 . \hat L (Eq. 9)
cos_gamma_tilde	cos(\tilde gamma) = \hat a_2 . \hat L (Eq. 9)

approximately_equal()

static bool approximately_equal ( REAL8  x, REAL8  y, REAL8  epsilon  )

static

nudge()

static void nudge ( REAL8 *  x, REAL8  X, REAL8  epsilon  )

static

PhenomPCoreOneFrequency_withTides()

static int PhenomPCoreOneFrequency_withTides ( const REAL8  fHz, const REAL8  window, const REAL8  ampTidal, const REAL8  phaseTidal, const REAL8  distance, const REAL8  M, const REAL8  phic, IMRPhenomDAmplitudeCoefficients *  pAmp, IMRPhenomDPhaseCoefficients *  pPhi, PNPhasingSeries *  PNparams, COMPLEX16 *  hPhenom, REAL8 *  phasing, AmpInsPrefactors *  amp_prefactors, PhiInsPrefactors *  phi_prefactors  )

static

Parameters

	fHz	Frequency (Hz)
	window	planck window
	ampTidal	tidal amplitude at a frequency sample
	phaseTidal	tidal phasing at a frequency sample from NRTidal infrastructure
	distance	Distance of source (m)
	M	Total mass (Solar masses)
	phic	Orbital phase at the peak of the underlying non precessing model (rad)
	pAmp	Internal IMRPhenomD amplitude coefficients
	pPhi	Internal IMRPhenomD phase coefficients
	PNparams	PN inspiral phase coefficients
[out]	hPhenom	IMRPhenom waveform (before precession)
[out]	phasing	overall phasing
	amp_prefactors	pre-calculated (cached for saving runtime) coefficients for amplitude. See LALSimIMRPhenomD_internals.c
	phi_prefactors	pre-calculated (cached for saving runtime) coefficients for phase. See LALSimIMRPhenomD_internals.