LALSimIMRCalculateSpinPrecEOBHCoeffs.c File Reference

Prototypes
static int	XLALSimIMRCalculateSpinPrecEOBHCoeffs (SpinEOBHCoeffs *coeffs, const REAL8 eta, const REAL8 a, const UINT4 SpinAlignedEOBversion)
	This function is used to calculate some coefficients which will be used in the spinning EOB Hamiltonian. More...
static int	XLALSimIMRCalculateSpinPrecEOBHCoeffs_v2 (SpinEOBHCoeffs *coeffs, const REAL8 eta, REAL8 a, REAL8 chi, const UINT4 SpinAlignedEOBversion)
	This function is used to calculate some coefficients which will be used in the spinning EOB Hamiltonian. More...

Go to the source code of this file.

Macros
#define	_LALSimIMRCalculateSpinPrecEOBHCoeffs_C
#define	ifthenelse(cond, ifvalue, elsevalue)   ((elsevalue) + (0.5 + copysign(0.5, cond)) * ((ifvalue)-(elsevalue)))
#define	ifthenelsezero(cond, ifvalue)   ((0.5 + copysign(0.5, cond)) * (ifvalue))

Macro Definition Documentation

_LALSimIMRCalculateSpinPrecEOBHCoeffs_C

#define _LALSimIMRCalculateSpinPrecEOBHCoeffs_C

Definition at line 2 of file LALSimIMRCalculateSpinPrecEOBHCoeffs.c.

ifthenelse

#define ifthenelse	(		cond,
			ifvalue,
			elsevalue
	)		((elsevalue) + (0.5 + copysign(0.5, cond)) * ((ifvalue)-(elsevalue)))

ifthenelsezero

#define ifthenelsezero	(		cond,
			ifvalue
	)		((0.5 + copysign(0.5, cond)) * (ifvalue))

Function Documentation

XLALSimIMRCalculateSpinPrecEOBHCoeffs()

static int XLALSimIMRCalculateSpinPrecEOBHCoeffs ( SpinEOBHCoeffs *  coeffs, const REAL8  eta, const REAL8  a, const UINT4  SpinAlignedEOBversion  )

static

This function is used to calculate some coefficients which will be used in the spinning EOB Hamiltonian.

Author

Craig Robinson, Yi Pan, Stas Babak, Prayush Kumar, Andrea Taracchini

This function was originally part of LALSimIMRSpinEOBHamiltonianPrec.c, and moved here during the development of v3_opt. Function relocation implemented by R. Devine, Z. Etienne, D. Buch, and T. Knowles. In comments, R.H. refers to Roland Hass.

It takes the following inputs:

coeffs - a (non-null) pointer to a SpinEOBParams structure. This will be populated with the output. eta - the symmetric mass ratio. sigmaKerr - the spin of the effective Kerr background (a combination of the individual spins).

If all goes well, the function will return XLAL_SUCCESS. Otherwise, XLAL_FAILURE is returned.

Parameters

coeffs	< OUTPUT, EOB parameters including pre-computed coefficients
eta	< symmetric mass ratio
a	< Normalized deformed Kerr spin
SpinAlignedEOBversion	< 1 for SEOBNRv1; 2 for SEOBNRv2

Definition at line 52 of file LALSimIMRCalculateSpinPrecEOBHCoeffs.c.

XLALSimIMRCalculateSpinPrecEOBHCoeffs_v2()

static int XLALSimIMRCalculateSpinPrecEOBHCoeffs_v2 ( SpinEOBHCoeffs *  coeffs, const REAL8  eta, REAL8  a, REAL8  chi, const UINT4  SpinAlignedEOBversion  )

static

This function is used to calculate some coefficients which will be used in the spinning EOB Hamiltonian.

It was specifically designed for precessing binaries, such that it allows the spin parameter chi that enters the NR-calibrated terms (like KK) to be different from a that enters derived coefficients like k0,k1,... If all goes well, the function will return XLAL_SUCCESS. Otherwise, XLAL_FAILURE is returned. The paper references are:

1. Barausse and Buonanno - PRD 81, 084024 (2010) [arXiv:0912.3517]
2. Bohe et al - Phys. Rev. D 95, 044028 – (2017) [arXiv:1611.03703]
3. Steinhoff et al - Phys. Rev. D 94, 104028 (2016) [arXiv:1608.01907]

Parameters

coeffs	< OUTPUT, EOB parameters including pre-computed coefficients
eta	< symmetric mass ratio
a	< Normalized deformed Kerr spin
chi	< The augmented spin, with correct aligned-spin limit
SpinAlignedEOBversion	< 4 for SEOBNRv4P; Possible to extend this later later

Definition at line 189 of file LALSimIMRCalculateSpinPrecEOBHCoeffs.c.