LALSimIMRSpinEOBHamiltonian.c File Reference

Prototypes
static void	fresnel_sincos_0_8 (double x, double output[2])
static void	fresnel_sincos_8_inf (double x, double output[2])
static void	fresnel_sc (double x, double output[2])
static double	f_keffresonant (double x, double x5_3)
	Function to compute k2tidal, k3tidal: resonant terms f(x) with x=omega0l/(m*Omega) (with m=l here) is the sum of first two terms of the bracket in (11) of https://arxiv.org/pdf/1702.02053.pdf (note typo: mOmega^2->(mOmega)^2) More...
static double	df_keffresonant (double x, double x5_3)
static double	f_keffresonant_pert (REAL8 x)
static double	df_keffresonant_pert (REAL8 x)
static REAL8	XLALSimIMRSpinEOBHamiltonianDeltaR (SpinEOBHCoeffs *coeffs, const REAL8 r, const REAL8 eta, const REAL8 a)
	This function calculates the DeltaR potential function in the spin EOB Hamiltonian. More...
static REAL8	XLALSimIMRSpinEOBHamiltonian (const REAL8 eta, REAL8Vector *restrict x, REAL8Vector *restrict p, REAL8Vector *restrict s1Vec, REAL8Vector *restrict s2Vec, REAL8Vector *restrict sigmaKerr, REAL8Vector *restrict sigmaStar, int tortoise, SpinEOBHCoeffs *coeffs)
static int	XLALSimIMRCalculateSpinEOBHCoeffs (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 REAL8	XLALSimIMRSpinEOBHamiltonianDeltaT (SpinEOBHCoeffs *coeffs, const REAL8 r, const REAL8 eta, const REAL8 a)
	This function calculates the function \(\Delta_t(r)\) which appears in the spinning EOB potential function. More...
static REAL8	XLALSimIMRSpinAlignedEOBCalcOmega (const REAL8 values[], SpinEOBParams *funcParams, REAL8 STEP_SIZE)
	Function to calculate the value of omega for the spin-aligned EOB waveform. More...
static REAL8	XLALSimIMRSpinAlignedEOBNonKeplerCoeff (const REAL8 values[], SpinEOBParams *funcParams)
	Function to calculate the non-Keplerian coefficient for the spin-aligned EOB model. More...
static double	GSLSpinAlignedHamiltonianWrapper (double x, void *params)
static REAL8	XLALSimIMRTEOBkleff (INT4 l, REAL8 u, REAL8 eta, TidalEOBParams *tidal)
	Function to compute the enhancement of kltidal due to the presence of f-mode resonance Implements (11) of https://arxiv.org/pdf/1702.02053.pdf (note typo: mOmega^2->(mOmega)^2) f(x) with x=omega0l/(m*Omega) (with m=l here) is the sum of first two terms of the bracket there Near resonance (x-1<1e-2) f(x) is replaced by a perturbative expansion Expected numerical precision: |Deltaf/f| normal: 1e-10 | perturbative: 1e-10. More...
static int	XLALSimIMRTEOBkleff_and_kleff_u (INT4 l, REAL8 u, REAL8 eta, TidalEOBParams *tidal, REAL8 output[2])
	Function to compute the enhancement of kltidal and its u-derivative due to the presence of f-mode resonance Implements (11) of https://arxiv.org/pdf/1702.02053.pdf (note typo: mOmega^2->(mOmega)^2) f(x) with x=omega0l/(m*Omega) (with m=l here) is the sum of first two terms of the bracket there Near resonance (x-1<1e-2) f(x) and f'(x) are replaced by a perturbative expansion Expected numerical precision: |Deltaf/f| normal: 1e-10 | perturbative: 1e-10 Expected numerical precision: |Deltaf'/f'| normal: 1e-8 | perturbative: 1e-10. More...
static REAL8	XLALSimIMRTEOBdeltaUTidalQuadSingleNS (REAL8 u, REAL8 u2, REAL8 u6, REAL8 XNS, REAL8 XCompanion, REAL8 lambda2TidalNS, REAL8 k2TidalNSeff)
	Function to compute the quadrupolar tidal contribution to the EOB Delta_u potential for just one NS. More...
static REAL8	XLALSimIMRTEOBdeltaUTidalQuadSingleNS_u (REAL8 u, REAL8 u2, REAL8 u6, REAL8 XNS, REAL8 XCompanion, REAL8 lambda2TidalNS, REAL8 k2TidalNSeff, REAL8 k2TidalNSeff_u)
	Function to compute the u-derivative of the quadrupolar tidal contribution to the EOB Delta_u potential for just one NS. More...
static REAL8	XLALSimIMRTEOBdeltaUTidalQuad (REAL8 u, REAL8 u2, REAL8 u6, REAL8 eta, TidalEOBParams *tidal1, TidalEOBParams *tidal2)
	Function to compute the quadrupolar tidal contribution to the EOB Delta_u potential. More...
static REAL8	XLALSimIMRTEOBdeltaUTidalQuad_u (REAL8 u, REAL8 u2, REAL8 u6, REAL8 eta, TidalEOBParams *tidal1, TidalEOBParams *tidal2)
	Function to compute the u-derivative of the quadrupolar tidal contribution to the EOB Delta_u potential. More...
static REAL8	XLALSimIMRTEOBdeltaUTidalOctuSingleNS (REAL8 u, REAL8 u2, REAL8 u8, REAL8 XNS, REAL8 XCompanion, REAL8 lambda3TidalNS, REAL8 k3TidalNSeff)
	Function to compute the octupolar tidal contribution to the EOB Delta_u potential for just one NS. More...
static REAL8	XLALSimIMRTEOBdeltaUTidalOctuSingleNS_u (REAL8 u, REAL8 u2, REAL8 u8, REAL8 XNS, REAL8 XCompanion, REAL8 lambda3TidalNS, REAL8 k3TidalNSeff, REAL8 k3TidalNSeff_u)
	Function to compute the u-derivative of the octupolar tidal contribution to the EOB Delta_u potential for just one NS. More...
static REAL8	XLALSimIMRTEOBdeltaUTidalOctu (REAL8 u, REAL8 u2, REAL8 u8, REAL8 eta, TidalEOBParams *tidal1, TidalEOBParams *tidal2)
	Function to compute the octupolar tidal contribution to the EOB Delta_u potential. More...
static REAL8	XLALSimIMRTEOBdeltaUTidalOctu_u (REAL8 u, REAL8 u2, REAL8 u8, REAL8 eta, TidalEOBParams *tidal1, TidalEOBParams *tidal2)
	Function to compute the u-derivative of the octupolar tidal contribution to the EOB Delta_u potential. More...
static REAL8	XLALSimIMRTEOBdeltaUTidal (REAL8 u, REAL8 eta, TidalEOBParams *tidal1, TidalEOBParams *tidal2)
	Function to compute the tidal contribution to the EOB Delta_u potential. More...
static REAL8	XLALSimIMRTEOBdeltaUTidal_u (REAL8 u, REAL8 eta, TidalEOBParams *tidal1, TidalEOBParams *tidal2)
	Function to compute the u-derivative of the tidal contribution to the EOB Delta_u potential. More...
static REAL8	XLALSimIMRTEOBdeltaHssQuadMonLO (const REAL8 eta, REAL8 u, REAL8Vector *restrict s1Vec, REAL8Vector *restrict s2Vec, REAL8 nx, REAL8 ny, REAL8 nz, TidalEOBParams *tidal1, TidalEOBParams *tidal2)
	Function to compute the leading-order 2PN spin-induced quadrupole contribution to Heff/mu consistently with code in the function XLALSimIMRSpinEOBHamiltonian, written for generic Cartesian spin components, although used so far only for spin aligned. More...
static REAL8	XLALSimIMRSpinEOBHamiltonian (const REAL8 eta, REAL8Vector *restrict x, REAL8Vector *restrict p, REAL8Vector *restrict s1Vec, REAL8Vector *restrict s2Vec, REAL8Vector *restrict sigmaKerr, REAL8Vector *restrict sigmaStar, INT4 tortoise, SpinEOBHCoeffs *coeffs)
	Function to calculate the value of the spinning Hamiltonian for given values of the dynamical variables (in a Cartesian co-ordinate system). More...
static REAL8 UNUSED	XLALSimIMRSpinEOBNonKeplerCoeff (const REAL8 values[], SpinEOBParams *funcParams)
	Function to calculate the non-Keplerian coefficient for the spin-aligned EOB model. More...

Go to the source code of this file.

Macros
#define	_LALSIMIMRSPINEOBHAMILTONIAN_C
#define	TwoToOneThird   1.25992104989487316476721060728
#define	ThreeToOneThird   1.44224957030740838232163831078

Variables
static const REAL8	STEP_SIZE_CALCOMEGA = 1.0e-4
static const double	sqrt_pi_2 = 1.2533141373155002512078826424
static const double	sqrt_2_pi = 0.7978845608028653558798921199
static const double	_1_sqrt_2pi = 0.3989422804014326779399460599
static const double	pi_2 = 1.5707963267948966192313216916
static const double	f_data_a [18]
static const double	f_data_b2 [18]
static double	f_data_e [41]
static double	f_data_f [35]
static const double	f_keffresonant_pertdata [5]
static const double	df_keffresonant_pertdata [5]

Macro Definition Documentation

_LALSIMIMRSPINEOBHAMILTONIAN_C

#define _LALSIMIMRSPINEOBHAMILTONIAN_C

Author

Craig Robinson, Yi Pan, Andrea Taracchini

Functions for calculating the effective one-body Hamiltonian 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. This code borrows hugely from a C implementation originally written by Enrico Barausse, following Barausse and Buonanno PRD 81, 084024 (2010) and PRD 84, 104027 (2011), henceforth BB1 and BB2

Definition at line 34 of file LALSimIMRSpinEOBHamiltonian.c.

TwoToOneThird

#define TwoToOneThird   1.25992104989487316476721060728

Definition at line 48 of file LALSimIMRSpinEOBHamiltonian.c.

ThreeToOneThird

#define ThreeToOneThird   1.44224957030740838232163831078

Definition at line 49 of file LALSimIMRSpinEOBHamiltonian.c.

Function Documentation

fresnel_sincos_0_8()

static void fresnel_sincos_0_8 ( double  x, double  output[2]  )

static

Definition at line 109 of file LALSimIMRSpinEOBHamiltonian.c.

fresnel_sincos_8_inf()

static void fresnel_sincos_8_inf ( double  x, double  output[2]  )

static

Definition at line 224 of file LALSimIMRSpinEOBHamiltonian.c.

fresnel_sc()

static void fresnel_sc ( double  x, double  output[2]  )

static

Definition at line 258 of file LALSimIMRSpinEOBHamiltonian.c.

f_keffresonant()

static double f_keffresonant ( double  x, double  x5_3  )

static

Function to compute k2tidal, k3tidal: resonant terms f(x) with x=omega0l/(m*Omega) (with m=l here) is the sum of first two terms of the bracket in (11) of https://arxiv.org/pdf/1702.02053.pdf (note typo: mOmega^2->(mOmega)^2)

Definition at line 279 of file LALSimIMRSpinEOBHamiltonian.c.

df_keffresonant()

static double df_keffresonant ( double  x, double  x5_3  )

static

Definition at line 285 of file LALSimIMRSpinEOBHamiltonian.c.

f_keffresonant_pert()

static double f_keffresonant_pert ( REAL8  x )

static

Definition at line 299 of file LALSimIMRSpinEOBHamiltonian.c.

df_keffresonant_pert()

static double df_keffresonant_pert ( REAL8  x )

static

Definition at line 317 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRSpinEOBHamiltonianDeltaR()

static UNUSED REAL8 XLALSimIMRSpinEOBHamiltonianDeltaR ( SpinEOBHCoeffs *  coeffs, const REAL8  r, const REAL8  eta, const REAL8  a  )

static

This function calculates the DeltaR potential function in the spin EOB Hamiltonian.

This function calculates the function \(\Delta_r(r)\) which appears in the spinning EOB potential function.

Eqs. 10a and 10b

Parameters

coeffs	< Pre-computed coefficients which appear in the function
r	< Current orbital radius (in units of total mass)
eta	< Symmetric mass ratio
a	< Normalized deformed Kerr spin

Definition at line 1485 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRSpinEOBHamiltonian() [1/2]

static REAL8 XLALSimIMRSpinEOBHamiltonian ( const REAL8  eta, REAL8Vector *restrict  x, REAL8Vector *restrict  p, REAL8Vector *restrict  s1Vec, REAL8Vector *restrict  s2Vec, REAL8Vector *restrict  sigmaKerr, REAL8Vector *restrict  sigmaStar, int  tortoise, SpinEOBHCoeffs *  coeffs  )

static

XLALSimIMRCalculateSpinEOBHCoeffs()

static UNUSED int XLALSimIMRCalculateSpinEOBHCoeffs ( 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.

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 1260 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRSpinEOBHamiltonianDeltaT()

static REAL8 XLALSimIMRSpinEOBHamiltonianDeltaT ( SpinEOBHCoeffs *  coeffs, const REAL8  r, const REAL8  eta, const REAL8  a  )

static

This function calculates the function \(\Delta_t(r)\) which appears in the spinning EOB potential function.

Eqs. 7a and 8.

Parameters

coeffs	< Pre-computed coefficients which appear in the function
r	< Current orbital radius (in units of total mass)
eta	< Symmetric mass ratio
a	< Normalized deformed Kerr spin

Definition at line 1426 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRSpinAlignedEOBCalcOmega()

static REAL8 XLALSimIMRSpinAlignedEOBCalcOmega ( const REAL8  values[], SpinEOBParams *  funcParams, REAL8  STEP_SIZE  )

static

Function to calculate the value of omega for the spin-aligned EOB waveform.

Can NOT be used in precessing cases. This omega is defined as \(\dot{y}/r\) by setting \(y=0\). The function calculates omega = v/r, by first converting (r,phi,pr,pphi) to Cartesian coordinates in which rVec={r,0,0} and pVec={0,pphi/r,0}, i.e. the effective-test-particle is positioned at x=r, and its velocity along y-axis. Then it computes omega, which is now given by dydt/r = (dH/dp_y)/r.

Parameters

values	< Dynamical variables
funcParams	< EOB parameters
STEP_SIZE	< Step size for numerical derivation of H

Definition at line 1521 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRSpinAlignedEOBNonKeplerCoeff()

static UNUSED REAL8 XLALSimIMRSpinAlignedEOBNonKeplerCoeff ( const REAL8  values[], SpinEOBParams *  funcParams  )

static

Function to calculate the non-Keplerian coefficient for the spin-aligned EOB model.

radius \(r\) times the cuberoot of the returned number is \(r_\Omega\) defined in Eq. A2. i.e. the function returns \((r_{\Omega} / r)^3\).

Parameters

values	< Dynamical variables
funcParams	< EOB parameters

Definition at line 1579 of file LALSimIMRSpinEOBHamiltonian.c.

GSLSpinAlignedHamiltonianWrapper()

static double GSLSpinAlignedHamiltonianWrapper ( double  x, void *  params  )

static

Definition at line 1660 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBkleff()

static REAL8 XLALSimIMRTEOBkleff ( INT4  l, REAL8  u, REAL8  eta, TidalEOBParams *  tidal  )

static

Function to compute the enhancement of kltidal due to the presence of f-mode resonance Implements (11) of https://arxiv.org/pdf/1702.02053.pdf (note typo: mOmega^2->(mOmega)^2) f(x) with x=omega0l/(m*Omega) (with m=l here) is the sum of first two terms of the bracket there Near resonance (x-1<1e-2) f(x) is replaced by a perturbative expansion Expected numerical precision: |Deltaf/f| normal: 1e-10 | perturbative: 1e-10.

Parameters

l	< Mode number l - the function is valid only for l=2 or l=3 and for m=l
u	< Inverse of radial separation in units of M
eta	< Symmetric mass ratio
tidal	< Tidal parameters

Definition at line 392 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBkleff_and_kleff_u()

static int XLALSimIMRTEOBkleff_and_kleff_u ( INT4  l, REAL8  u, REAL8  eta, TidalEOBParams *  tidal, REAL8  output[2]  )

static

Function to compute the enhancement of kltidal and its u-derivative due to the presence of f-mode resonance Implements (11) of https://arxiv.org/pdf/1702.02053.pdf (note typo: mOmega^2->(mOmega)^2) f(x) with x=omega0l/(m*Omega) (with m=l here) is the sum of first two terms of the bracket there Near resonance (x-1<1e-2) f(x) and f'(x) are replaced by a perturbative expansion Expected numerical precision: |Deltaf/f| normal: 1e-10 | perturbative: 1e-10 Expected numerical precision: |Deltaf'/f'| normal: 1e-8 | perturbative: 1e-10.

Parameters

l	< Mode number l - the function is valid only for l=2 or l=3 and for m=l
u	< Inverse of radial separation in units of M
eta	< Symmetric mass ratio
tidal	< Tidal parameters
output	< Output array

Definition at line 453 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidalQuadSingleNS()

static REAL8 XLALSimIMRTEOBdeltaUTidalQuadSingleNS ( REAL8  u, REAL8  u2, REAL8  u6, REAL8  XNS, REAL8  XCompanion, REAL8  lambda2TidalNS, REAL8  k2TidalNSeff  )

static

Function to compute the quadrupolar tidal contribution to the EOB Delta_u potential for just one NS.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
u2	< Inverse of radial separation^2 in units of M
u6	< Inverse of radial separation^6 in units of M
XNS	< NS mass by M
XCompanion	< Companion mass by M
lambda2TidalNS	< NS dimensionless quadrupolar tidal deformability
k2TidalNSeff	< Dynamical enhancement of k2TidalNS

Definition at line 521 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidalQuadSingleNS_u()

static REAL8 XLALSimIMRTEOBdeltaUTidalQuadSingleNS_u ( REAL8  u, REAL8  u2, REAL8  u6, REAL8  XNS, REAL8  XCompanion, REAL8  lambda2TidalNS, REAL8  k2TidalNSeff, REAL8  k2TidalNSeff_u  )

static

Function to compute the u-derivative of the quadrupolar tidal contribution to the EOB Delta_u potential for just one NS.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
u2	< Inverse of radial separation^2 in units of M
u6	< Inverse of radial separation^6 in units of M
XNS	< NS mass by M
XCompanion	< Companion mass by M
lambda2TidalNS	< NS dimensionless quadrupolar tidal deformability
k2TidalNSeff	< Dynamical enhancement of k2TidalNS
k2TidalNSeff_u	< u-derivative of the dynamical enhancement of k2TidalNS

Definition at line 538 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidalQuad()

static REAL8 XLALSimIMRTEOBdeltaUTidalQuad ( REAL8  u, REAL8  u2, REAL8  u6, REAL8  eta, TidalEOBParams *  tidal1, TidalEOBParams *  tidal2  )

static

Function to compute the quadrupolar tidal contribution to the EOB Delta_u potential.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
u2	< Inverse of radial separation^2 in units of M
u6	< Inverse of radial separation^6 in units of M
eta	< Symmetric mass ratio
tidal1	< Tidal parameters of body 1
tidal2	< Tidal parameters of body 2

Definition at line 558 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidalQuad_u()

static REAL8 XLALSimIMRTEOBdeltaUTidalQuad_u ( REAL8  u, REAL8  u2, REAL8  u6, REAL8  eta, TidalEOBParams *  tidal1, TidalEOBParams *  tidal2  )

static

Function to compute the u-derivative of the quadrupolar tidal contribution to the EOB Delta_u potential.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
u2	< Inverse of radial separation^2 in units of M
u6	< Inverse of radial separation^6 in units of M
eta	< Symmetric mass ratio
tidal1	< Tidal parameters of body 1
tidal2	< Tidal parameters of body 2

Definition at line 585 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidalOctuSingleNS()

static REAL8 XLALSimIMRTEOBdeltaUTidalOctuSingleNS ( REAL8  u, REAL8  u2, REAL8  u8, REAL8  XNS, REAL8  XCompanion, REAL8  lambda3TidalNS, REAL8  k3TidalNSeff  )

static

Function to compute the octupolar tidal contribution to the EOB Delta_u potential for just one NS.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
u2	< Inverse of radial separation^2 in units of M
u8	< Inverse of radial separation^8 in units of M
XNS	< NS mass by M
XCompanion	< Companion mass by M
lambda3TidalNS	< NS dimensionless octupolar tidal deformability
k3TidalNSeff	< Dynamical enhancement of k3TidalNS

Definition at line 621 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidalOctuSingleNS_u()

static REAL8 XLALSimIMRTEOBdeltaUTidalOctuSingleNS_u ( REAL8  u, REAL8  u2, REAL8  u8, REAL8  XNS, REAL8  XCompanion, REAL8  lambda3TidalNS, REAL8  k3TidalNSeff, REAL8  k3TidalNSeff_u  )

static

Function to compute the u-derivative of the octupolar tidal contribution to the EOB Delta_u potential for just one NS.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
u2	< Inverse of radial separation^2 in units of M
u8	< Inverse of radial separation^8 in units of M
XNS	< NS mass by M
XCompanion	< Companion mass by M
lambda3TidalNS	< NS dimensionless octupolar tidal deformability
k3TidalNSeff	< Dynamical enhancement of k3TidalNS
k3TidalNSeff_u	< u-derivative of dynamical enhancement of k3TidalNS

Definition at line 638 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidalOctu()

static REAL8 XLALSimIMRTEOBdeltaUTidalOctu ( REAL8  u, REAL8  u2, REAL8  u8, REAL8  eta, TidalEOBParams *  tidal1, TidalEOBParams *  tidal2  )

static

Function to compute the octupolar tidal contribution to the EOB Delta_u potential.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
u2	< Inverse of radial separation^2 in units of M
u8	< Inverse of radial separation^8 in units of M
eta	< Symmetric mass ratio
tidal1	< Tidal parameters of body 1
tidal2	< Tidal parameters of body 2

Definition at line 657 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidalOctu_u()

static REAL8 XLALSimIMRTEOBdeltaUTidalOctu_u ( REAL8  u, REAL8  u2, REAL8  u8, REAL8  eta, TidalEOBParams *  tidal1, TidalEOBParams *  tidal2  )

static

Function to compute the u-derivative of the octupolar tidal contribution to the EOB Delta_u potential.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
u2	< Inverse of radial separation^2 in units of M
u8	< Inverse of radial separation^8 in units of M
eta	< Symmetric mass ratio
tidal1	< Tidal parameters of body 1
tidal2	< Tidal parameters of body 2

Definition at line 684 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidal()

static REAL8 XLALSimIMRTEOBdeltaUTidal ( REAL8  u, REAL8  eta, TidalEOBParams *  tidal1, TidalEOBParams *  tidal2  )

static

Function to compute the tidal contribution to the EOB Delta_u potential.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
eta	< Symmetric mass ratio
tidal1	< Tidal parameters of body 1
tidal2	< Tidal parameters of body 2

Definition at line 721 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaUTidal_u()

static REAL8 XLALSimIMRTEOBdeltaUTidal_u ( REAL8  u, REAL8  eta, TidalEOBParams *  tidal1, TidalEOBParams *  tidal2  )

static

Function to compute the u-derivative of the tidal contribution to the EOB Delta_u potential.

This implements the model of Phys.Rev.Lett. 116 (2016) no.18, 181101

Parameters

u	< Inverse of radial separation in units of M
eta	< Symmetric mass ratio
tidal1	< Tidal parameters of body 1
tidal2	< Tidal parameters of body 2

Definition at line 743 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRTEOBdeltaHssQuadMonLO()

static REAL8 XLALSimIMRTEOBdeltaHssQuadMonLO ( const REAL8  eta, REAL8  u, REAL8Vector *restrict  s1Vec, REAL8Vector *restrict  s2Vec, REAL8  nx, REAL8  ny, REAL8  nz, TidalEOBParams *  tidal1, TidalEOBParams *  tidal2  )

static

Function to compute the leading-order 2PN spin-induced quadrupole contribution to Heff/mu consistently with code in the function XLALSimIMRSpinEOBHamiltonian, written for generic Cartesian spin components, although used so far only for spin aligned.

Parameters

eta	< Symmetric mass ratio
u	< Inverse of radial separation in units of M
s1Vec	< Spin vector 1
s2Vec	< Spin vector 2
nx	< Cartesian component of unit separation vector n
ny	< Cartesian component of unit separation vector n
nz	< Cartesian component of unit separation vector n
tidal1	< Tidal parameters of body 1
tidal2	< Tidal parameters of body 2

Definition at line 765 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRSpinEOBHamiltonian() [2/2]

static REAL8 XLALSimIMRSpinEOBHamiltonian ( const REAL8  eta, REAL8Vector *restrict  x, REAL8Vector *restrict  p, REAL8Vector *restrict  s1Vec, REAL8Vector *restrict  s2Vec, REAL8Vector *restrict  sigmaKerr, REAL8Vector *restrict  sigmaStar, INT4  tortoise, SpinEOBHCoeffs *  coeffs  )

static

Function to calculate the value of the spinning Hamiltonian for given values of the dynamical variables (in a Cartesian co-ordinate system).

The inputs are as follows:

x - the separation vector r expressed in Cartesian co-ordinates p - the momentum vector (with the radial component tortoise pr*) sigmaKerr - spin of the effective Kerr background (a combination of the individual spin vectors) sigmaStar - spin of the effective particle (a different combination of the individual spins). coeffs - coefficients which crop up in the Hamiltonian. These can be calculated using the XLALCalculateSpinEOBParams() function.

The function returns a REAL8, which will be the value of the Hamiltonian if all goes well; otherwise, it will return the XLAL REAL8 failure NaN.

Parameters

eta	< Symmetric mass ratio
x	< Position vector
p	< Momentum vector (tortoise radial component pr*)
s1Vec	< Spin vector 1
s2Vec	< Spin vector 2
sigmaKerr	< Spin vector sigma_kerr
sigmaStar	< Spin vector sigma_star
tortoise	< flag to state whether the momentum is the tortoise co-ord
coeffs	< Structure containing various coefficients

Definition at line 814 of file LALSimIMRSpinEOBHamiltonian.c.

XLALSimIMRSpinEOBNonKeplerCoeff()

static REAL8 UNUSED XLALSimIMRSpinEOBNonKeplerCoeff ( const REAL8  values[], SpinEOBParams *  funcParams  )

static

Function to calculate the non-Keplerian coefficient for the spin-aligned EOB model.

radius \(r\) times the cuberoot of the returned number is \(r_\Omega\) defined in Eq. A2. i.e. the function returns \((r_{\Omega} / r)^3\). This is the generic precessing version

Parameters

values	< Dynamical variables
funcParams	< EOB parameters

Definition at line 1617 of file LALSimIMRSpinEOBHamiltonian.c.

Variable Documentation

STEP_SIZE_CALCOMEGA

const REAL8 STEP_SIZE_CALCOMEGA = 1.0e-4

static

Definition at line 51 of file LALSimIMRSpinEOBHamiltonian.c.

sqrt_pi_2

const double sqrt_pi_2 = 1.2533141373155002512078826424

static

Definition at line 53 of file LALSimIMRSpinEOBHamiltonian.c.

sqrt_2_pi

const double sqrt_2_pi = 0.7978845608028653558798921199

static

Definition at line 54 of file LALSimIMRSpinEOBHamiltonian.c.

_1_sqrt_2pi

const double _1_sqrt_2pi = 0.3989422804014326779399460599

static

Definition at line 55 of file LALSimIMRSpinEOBHamiltonian.c.

pi_2

const double pi_2 = 1.5707963267948966192313216916

static

Definition at line 56 of file LALSimIMRSpinEOBHamiltonian.c.

f_data_a

const double f_data_a[18]

static

Initial value:

=
{
  0.76435138664186000189,
  -0.43135547547660179313,
  0.43288199979726653054,
  -0.26973310338387111029,
  0.08416045320876935378,
  -0.01546524484461381958,
  0.00187855423439822018,
  -0.00016264977618887547,
  0.00001057397656383260,
  -0.00000053609339889243,
  0.00000002181658454933,
  -0.00000000072901621186,
  0.00000000002037332546,
  -0.00000000000048344033,
  0.00000000000000986533,
  -0.00000000000000017502,
  0.00000000000000000272,
  -0.00000000000000000004
}

Definition at line 58 of file LALSimIMRSpinEOBHamiltonian.c.

f_data_b2

const double f_data_b2[18]

static

Initial value:

=
{
  0.63041404314570539241,
  -0.42344511405705333544,
  0.37617172643343656625,
  -0.16249489154509567415,
  0.03822255778633008694,
  -0.00564563477132190899,
  0.00057454951976897367,
  -0.00004287071532102004,
  0.00000245120749923299,
  -0.00000011098841840868,
  0.00000000408249731696,
  -0.00000000012449830219,
  0.00000000000320048425,
  -0.00000000000007032416,
  0.00000000000000133638,
  -0.00000000000000002219,
  0.00000000000000000032,
  0.0
}

Definition at line 84 of file LALSimIMRSpinEOBHamiltonian.c.

f_data_e

double f_data_e[41]

static

Definition at line 137 of file LALSimIMRSpinEOBHamiltonian.c.

f_data_f

double f_data_f[35]

static

Definition at line 182 of file LALSimIMRSpinEOBHamiltonian.c.

f_keffresonant_pertdata

const double f_keffresonant_pertdata[5]

static

Initial value:

=
{
  -0.0833333333333333,
  -0.1157407407407407,
  -0.006944444444444445,
  0.01122256515775034,
  -0.007120198902606311
}

Definition at line 291 of file LALSimIMRSpinEOBHamiltonian.c.

df_keffresonant_pertdata

const double df_keffresonant_pertdata[5]

static

Initial value:

=
{
  -0.1157407407407407,
  -0.01388888888888889,
  0.03366769547325102,
  -0.02848079561042524,
  0.01919764200071127
}

Definition at line 309 of file LALSimIMRSpinEOBHamiltonian.c.