LALSimIMRSpinAlignedEOB.c

Detailed Description

Functions for producing SEOBNRv1 and v2 waveforms.

Author

Craig Robinson, Yi Pan

Functions for producing SEOBNRv1 waveforms for spinning binaries, as described in Taracchini et al. ( PRD 86, 024011 (2012), arXiv 1202.0790 ). All equation numbers in this file refer to equations of this paper, unless otherwise specified.

Review status:

SEOBNRv1 has been reviewd by Riccardo Sturani, B. Sathyaprakash and Prayush Kumar. The review concluded in fall 2012.

Functions for producing SEOBNRv2 waveforms for spinning binaries, as described in Taracchini et al. ( arXiv 1311.2544 ).

Review status:

SEOBNRv2 has been reviewed by Riccardo Sturani, Prayush Kumar and Stas Babak. The review concluded with git hash 5bc6bb861de2eb72ca403b9e0f529d83080490fe (August 2014).

Prototypes
double	XLALSimIMRSpinAlignedEOBPeakFrequency (REAL8 m1SI, REAL8 m2SI, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion)
	This function returns the frequency at which the peak amplitude occurs in SEOBNRv(x) More...
int	XLALSimIMRSpinAlignedEOBWaveform (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, LALDict *LALParams)
int	XLALSimIMRSpinAlignedEOBModes (SphHarmTimeSeries **hlmmode, REAL8Vector **dynamics_out, REAL8Vector **dynamicsHi_out, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, const REAL8 lambda2Tidal1, const REAL8 lambda2Tidal2, const REAL8 omega02Tidal1, const REAL8 omega02Tidal2, const REAL8 lambda3Tidal1, const REAL8 lambda3Tidal2, const REAL8 omega03Tidal1, const REAL8 omega03Tidal2, const REAL8 quadparam1, const REAL8 quadparam2, REAL8Vector *nqcCoeffsInput, const INT4 nqcFlag, LALDict *PAParams, LALDict *TGRParams)
	This function generates spin-aligned SEOBNRv1,2,2opt,4,4opt,2T,4T,4HM complex modes hlm. More...
int	XLALSimIMRSpinAlignedEOBWaveformAll (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, const REAL8 lambda2Tidal1, const REAL8 lambda2Tidal2, const REAL8 omega02Tidal1, const REAL8 omega02Tidal2, const REAL8 lambda3Tidal1, const REAL8 lambda3Tidal2, const REAL8 omega03Tidal1, const REAL8 omega03Tidal2, const REAL8 quadparam1, const REAL8 quadparam2, REAL8Vector *nqcCoeffsInput, const INT4 nqcFlag, LALValue *ModeArray, LALDict *TGRParams)
	This function takes the modes from the function XLALSimIMRSpinAlignedEOBModes and combine them into h+ and hx. More...

Function Documentation

XLALSimIMRSpinAlignedEOBPeakFrequency()

double XLALSimIMRSpinAlignedEOBPeakFrequency	(	REAL8	m1SI,
		REAL8	m2SI,
		const REAL8	spin1z,
		const REAL8	spin2z,
		UINT4	SpinAlignedEOBversion
	)

This function returns the frequency at which the peak amplitude occurs in SEOBNRv(x)

Parameters

m1SI	mass of companion 1 (kg)
m2SI	mass of companion 2 (kg)
spin1z	z-component of the dimensionless spin of object 1
spin2z	z-component of the dimensionless spin of object 2
SpinAlignedEOBversion	1 for SEOBNRv1, 2 for SEOBNRv2, 4 for SEOBNRv4

Definition at line 493 of file LALSimIMRSpinAlignedEOB.c.

XLALSimIMRSpinAlignedEOBWaveform()

int XLALSimIMRSpinAlignedEOBWaveform	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		const REAL8	phiC,
		REAL8	deltaT,
		const REAL8	m1SI,
		const REAL8	m2SI,
		const REAL8	fMin,
		const REAL8	r,
		const REAL8	inc,
		const REAL8	spin1z,
		const REAL8	spin2z,
		UINT4	SpinAlignedEOBversion,
		LALDict *	LALParams
	)

Parameters

hplus	< OUTPUT, +-polarization waveform
hcross	< OUTPUT, x-polarization waveform
phiC	< coalescence orbital phase (rad)
deltaT	< sampling time step
m1SI	< mass-1 in SI unit
m2SI	< mass-2 in SI unit
fMin	< starting frequency of the 22 mode (Hz)
r	< distance in SI unit
inc	< inclination angle
spin1z	< z-component of spin-1, dimensionless
spin2z	< z-component of spin-2, dimensionless
SpinAlignedEOBversion	< 1 for SEOBNRv1, 2 for SEOBNRv2, 4 for SEOBNRv4, 201 for SEOBNRv2T,401 for SEOBNRv4T, 41 for SEOBNRv4HM, 4111 for SEOBNRv4HM_PA, 4112 for pSEOBNRv4HM_PA
LALParams	< Dictionary of additional wf parameters, including tidal and nonGR

Definition at line 583 of file LALSimIMRSpinAlignedEOB.c.

XLALSimIMRSpinAlignedEOBModes()

int XLALSimIMRSpinAlignedEOBModes	(	SphHarmTimeSeries **	hlmmode,
		REAL8Vector **	dynamics_out,
		REAL8Vector **	dynamicsHi_out,
		REAL8	deltaT,
		const REAL8	m1SI,
		const REAL8	m2SI,
		const REAL8	fMin,
		const REAL8	r,
		const REAL8	spin1z,
		const REAL8	spin2z,
		UINT4	SpinAlignedEOBversion,
		const REAL8	lambda2Tidal1,
		const REAL8	lambda2Tidal2,
		const REAL8	omega02Tidal1,
		const REAL8	omega02Tidal2,
		const REAL8	lambda3Tidal1,
		const REAL8	lambda3Tidal2,
		const REAL8	omega03Tidal1,
		const REAL8	omega03Tidal2,
		const REAL8	quadparam1,
		const REAL8	quadparam2,
		REAL8Vector *	nqcCoeffsInput,
		const INT4	nqcFlag,
		LALDict *	PAParams,
		LALDict *	TGRParams
	)

This function generates spin-aligned SEOBNRv1,2,2opt,4,4opt,2T,4T,4HM complex modes hlm.

Currently, only the h22 harmonic is available for all the models with the exception of SEOBNRv4HM which contains also the modes hlm = ((2,1),(3,3),(4,4),(5,5)) besides the (2,2). For this model all available harmonics are generated, one cannot choose which harmonic to generate. STEP 0) Prepare parameters, including pre-computed coefficients for EOB Hamiltonian, flux and waveform STEP 1) Solve for initial conditions STEP 2) Evolve EOB trajectory until reaching the peak of orbital frequency STEP 3) Step back in time by tStepBack and volve EOB trajectory again using high sampling rate, stop at 0.3M out of the "EOB horizon". STEP 4) Locate the peak of orbital frequency for NQC and QNM calculations STEP 5) Calculate NQC correction using hi-sampling data STEP 6) Calculate QNM excitation coefficients using hi-sampling data STEP 7) Generate full inspiral mode using desired sampling frequency STEP 8) Generate full IMR modes – attaching ringdown to inspiral STEP 9) Generate full IMR modes Note that sanity checks on merger for SEOBNRv4 have revealed that for eta<=0.15 and chi1>0.95 about 0.04% of the waveforms display either very shallow double amplitude peak or slightly negave time-derivative of the GW freq at merger. Note that SEOBNRv2T and SEOBNRv4T can display similar features. The model was validated on the range q=[1,3], Sz=[-0.5,0.5], Lambda2=[0,5000]. Waveforms will not fail on Sz=[-0.7,0.7], but with possibly stronger unwanted features. The initial conditions solver can also fail for low starting frequencies, with a failure rate of ~0.3% at fmin=10Hz for M=3Msol.

Parameters

hlmmode	< OUTPUT, mode hlm
dynamics_out	< OUTPUT, low-sampling dynamics
dynamicsHi_out	< OUTPUT, high-sampling dynamics
deltaT	< sampling time step
m1SI	< mass-1 in SI unit
m2SI	< mass-2 in SI unit
fMin	< starting frequency of the 22 mode (Hz)
r	< distance in SI unit
spin1z	< z-component of spin-1, dimensionless
spin2z	< z-component of spin-2, dimensionless
SpinAlignedEOBversion	< 1 for SEOBNRv1, 2 for SEOBNRv2, 4 for SEOBNRv4, 201 for SEOBNRv2T, 401 for SEOBNRv4T, 41 for SEOBNRv4HM, 4111 for SEOBNRv4HM_PA, 4112 for pSEOBNRv4HM_PA
lambda2Tidal1	< dimensionless adiabatic quadrupole tidal deformability for body 1 (2/3 k2/C^5)
lambda2Tidal2	< dimensionless adiabatic quadrupole tidal deformability for body 2 (2/3 k2/C^5)
omega02Tidal1	< quadrupole f-mode angular freq for body 1 m_1*omega_{02,1}
omega02Tidal2	< quadrupole f-mode angular freq for body 2 m_2*omega_{02,2}
lambda3Tidal1	< dimensionless adiabatic octupole tidal deformability for body 1 (2/15 k3/C^7)
lambda3Tidal2	< dimensionless adiabatic octupole tidal deformability for body 2 (2/15 k3/C^7)
omega03Tidal1	< octupole f-mode angular freq for body 1 m_1*omega_{03,1}
omega03Tidal2	< octupole f-mode angular freq for body 2 m_2*omega_{03,2}
quadparam1	< parameter kappa_1 of the spin-induced quadrupole for body 1, quadrupole is Q_A = -kappa_A m_A^3 chi_A^2
quadparam2	< parameter kappa_2 of the spin-induced quadrupole for body 2, quadrupole is Q_A = -kappa_A m_A^3 chi_A^2
nqcCoeffsInput	< Input NQC coeffs
nqcFlag	< Flag to tell the code to use the NQC coeffs input thorugh nqcCoeffsInput
PAParams	< Dictionary containing parameters for the post-adiabatic routine
TGRParams	< Dictionary containing parameters for tests of General Relativity

Definition at line 823 of file LALSimIMRSpinAlignedEOB.c.

XLALSimIMRSpinAlignedEOBWaveformAll()

int XLALSimIMRSpinAlignedEOBWaveformAll	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		const REAL8	phiC,
		REAL8	deltaT,
		const REAL8	m1SI,
		const REAL8	m2SI,
		const REAL8	fMin,
		const REAL8	r,
		const REAL8	inc,
		const REAL8	spin1z,
		const REAL8	spin2z,
		UINT4	SpinAlignedEOBversion,
		const REAL8	lambda2Tidal1,
		const REAL8	lambda2Tidal2,
		const REAL8	omega02Tidal1,
		const REAL8	omega02Tidal2,
		const REAL8	lambda3Tidal1,
		const REAL8	lambda3Tidal2,
		const REAL8	omega03Tidal1,
		const REAL8	omega03Tidal2,
		const REAL8	quadparam1,
		const REAL8	quadparam2,
		REAL8Vector *	nqcCoeffsInput,
		const INT4	nqcFlag,
		LALValue *	ModeArray,
		LALDict *	TGRParams
	)

This function takes the modes from the function XLALSimIMRSpinAlignedEOBModes and combine them into h+ and hx.

Parameters

hplus	< OUTPUT, real part of the modes
hcross	< OUTPUT, complex part of the modes
phiC	< coalescence orbital phase (rad)
deltaT	< sampling time step
m1SI	< mass-1 in SI unit
m2SI	< mass-2 in SI unit
fMin	< starting frequency of the 22 mode (Hz)
r	< distance in SI unit
inc	< inclination angle
spin1z	< z-component of spin-1, dimensionless
spin2z	< z-component of spin-2, dimensionless
SpinAlignedEOBversion	< 1 for SEOBNRv1, 2 for SEOBNRv2, 4 for SEOBNRv4, 201 for SEOBNRv2T, 401 for SEOBNRv4T, 41 for SEOBNRv4HM
lambda2Tidal1	< dimensionless adiabatic quadrupole tidal deformability for body 1 (2/3 k2/C^5)
lambda2Tidal2	< dimensionless adiabatic quadrupole tidal deformability for body 2 (2/3 k2/C^5)
omega02Tidal1	< quadrupole f-mode angular freq for body 1 m_1*omega_{02,1}
omega02Tidal2	< quadrupole f-mode angular freq for body 2 m_2*omega_{02,2}
lambda3Tidal1	< dimensionless adiabatic octupole tidal deformability for body 1 (2/15 k3/C^7)
lambda3Tidal2	< dimensionless adiabatic octupole tidal deformability for body 2 (2/15 k3/C^7)
omega03Tidal1	< octupole f-mode angular freq for body 1 m_1*omega_{03,1}
omega03Tidal2	< octupole f-mode angular freq for body 2 m_2*omega_{03,2}
quadparam1	< parameter kappa_1 of the spin-induced quadrupole for body 1, quadrupole is Q_A = -kappa_A m_A^3 chi_A^2
quadparam2	< parameter kappa_2 of the spin-induced quadrupole for body 2, quadrupole is Q_A = -kappa_A m_A^3 chi_A^2
nqcCoeffsInput	< Input NQC coeffs
nqcFlag	< Flag to tell the code to use the NQC coeffs input thorugh nqcCoeffsInput
ModeArray	< Structure containing the modes to use in the waveform
TGRParams	< dictionary containing parameters for tests of General Relativity

Definition at line 3824 of file LALSimIMRSpinAlignedEOB.c.