LALSimIMREOBNewtonianMultipole.c File Reference

Prototypes
static REAL8	XLALAssociatedLegendreXIsZero (const int l, const int m)
	Function to calculate associated Legendre function used by the spherical harmonics function. More...
static int	XLALScalarSphHarmThetaPiBy2 (COMPLEX16 *y, INT4 l, INT4 m, REAL8 phi)
static int	XLALAbsScalarSphHarmThetaPiBy2 (COMPLEX16 *y, INT4 l, INT4 m)
static int	CalculateThisMultipolePrefix (COMPLEX16 *prefix, const REAL8 m1, const REAL8 m2, const INT4 l, const INT4 m)
	Function to calculate the numerical prefix in the Newtonian amplitude. More...
static UNUSED int	XLALSimIMREOBComputeNewtonMultipolePrefixes (NewtonMultipolePrefixes *prefix, const REAL8 m1, const REAL8 m2)
	Function which computes the various coefficients in the Newtonian multipole. More...
static UNUSED int	XLALSimIMREOBCalculateNewtonianMultipole (COMPLEX16 *multipole, REAL8 x, UNUSED REAL8 r, REAL8 phi, UINT4 l, INT4 m, EOBParams *params)
	This function calculates the Newtonian multipole part of the factorized waveform for the EOBNRv2 model. More...
static UNUSED int	XLALSimIMRSpinEOBCalculateNewtonianMultipole (COMPLEX16 *multipole, REAL8 x, UNUSED REAL8 r, REAL8 phi, UINT4 l, INT4 m, EOBParams *params)
	This function calculates the Newtonian multipole part of the factorized waveform for the SEOBNRv1 model. More...
static UNUSED int	XLALSimIMRSpinEOBFluxCalculateNewtonianMultipole (COMPLEX16 *multipole, REAL8 x, UNUSED REAL8 r, UNUSED REAL8 phi, UINT4 l, INT4 m, EOBParams *params)
	This function calculates the Newtonian multipole part of the factorized waveform for the SEOBNRv1 model. More...

Go to the source code of this file.

Macros
#define	_LALSIMIMRNEWTONIANMULTIPOLE_C

Macro Definition Documentation

_LALSIMIMRNEWTONIANMULTIPOLE_C

#define _LALSIMIMRNEWTONIANMULTIPOLE_C

Author

Craig Robinson, Prayush Kumar

Functions to construct the Newtonian multipolar waveform as given by Damour et al, Phys.Rev.D79:064004,2009. All equation numbers in this file refer to equations of this paper, unless otherwise specified.

In addition to the function used to do this, XLALCalculateNewtonianMultipole(), this file also contains a function for calculating the standard scalar spherical harmonics Ylm.

Also functions to return only the absolute value of the Newtonian multipolar waveform, ignoring the complex argument that dependens on the orbital phase. These functions are used in the flux calculation.

Definition at line 45 of file LALSimIMREOBNewtonianMultipole.c.

Function Documentation

XLALAssociatedLegendreXIsZero()

static REAL8 XLALAssociatedLegendreXIsZero ( const int  l, const int  m  )

static

Function to calculate associated Legendre function used by the spherical harmonics function.

Definition at line 313 of file LALSimIMREOBNewtonianMultipole.c.

XLALScalarSphHarmThetaPiBy2()

static int XLALScalarSphHarmThetaPiBy2 ( COMPLEX16 *  y, INT4  l, INT4  m, REAL8  phi  )

static

Parameters

y	< OUTPUT, Ylm(0,phi)
l	< Mode l
m	< Mode m
phi	< Orbital phase (in radians)

Definition at line 229 of file LALSimIMREOBNewtonianMultipole.c.

XLALAbsScalarSphHarmThetaPiBy2()

static int XLALAbsScalarSphHarmThetaPiBy2 ( COMPLEX16 *  y, INT4  l, INT4  m  )

static

Parameters

y	< OUTPUT, Ylm(0,phi)
l	< Mode l
m	< Mode m

Definition at line 273 of file LALSimIMREOBNewtonianMultipole.c.

CalculateThisMultipolePrefix()

static int CalculateThisMultipolePrefix ( COMPLEX16 *  prefix, const REAL8  m1, const REAL8  m2, const INT4  l, const INT4  m  )

static

Function to calculate the numerical prefix in the Newtonian amplitude.

Eqs. 5 - 7.

Parameters

prefix	< OUTPUT, Prefix value
m1	< mass 1
m2	< mass 2
l	< Mode l
m	< Mode m

Definition at line 512 of file LALSimIMREOBNewtonianMultipole.c.

XLALSimIMREOBComputeNewtonMultipolePrefixes()

static UNUSED int XLALSimIMREOBComputeNewtonMultipolePrefixes ( NewtonMultipolePrefixes *  prefix, const REAL8  m1, const REAL8  m2  )

static

Function which computes the various coefficients in the Newtonian multipole.

The definition of this can be found in Pan et al, arXiv:1106.1021v1 [gr-qc]. Note that, although this function gets passed masses measured in Solar masses (which is fine since it is a static function), the units of mass won't matter so long as they are consistent. This is because all uses of the mass within the function are normalized by the total mass. The prefixes of all (l,m) modes are pre-computed and stored in a structure

Parameters

prefix	< OUTPUT Structure containing the coeffs
m1	< Mass of first component
m2	< Nass of second component

Definition at line 81 of file LALSimIMREOBNewtonianMultipole.c.

XLALSimIMREOBCalculateNewtonianMultipole()

static UNUSED int XLALSimIMREOBCalculateNewtonianMultipole ( COMPLEX16 *  multipole, REAL8  x, UNUSED REAL8  r, REAL8  phi, UINT4  l, INT4  m, EOBParams *  params  )

static

This function calculates the Newtonian multipole part of the factorized waveform for the EOBNRv2 model.

This is defined in Eq. 4.

Parameters

multipole	< OUTPUT, Newtonian multipole
x	< Dimensionless parameter \(\equiv v^2\)
r	< Orbital separation (units of total mass M)
phi	< Orbital phase (in radians)
l	< Mode l
m	< Mode m
params	< Pre-computed coefficients, parameters, etc.

Definition at line 107 of file LALSimIMREOBNewtonianMultipole.c.

XLALSimIMRSpinEOBCalculateNewtonianMultipole()

static UNUSED int XLALSimIMRSpinEOBCalculateNewtonianMultipole ( COMPLEX16 *  multipole, REAL8  x, UNUSED REAL8  r, REAL8  phi, UINT4  l, INT4  m, EOBParams *  params  )

static

This function calculates the Newtonian multipole part of the factorized waveform for the SEOBNRv1 model.

This is defined in Eq. 4.

Parameters

multipole	< OUTPUT, Newtonian multipole
x	< Dimensionless parameter \(\equiv v^2\)
r	< Orbital separation (units of total mass M
phi	< Orbital phase (in radians)
l	< Mode l
m	< Mode m
params	< Pre-computed coefficients, parameters, etc.

Definition at line 153 of file LALSimIMREOBNewtonianMultipole.c.

XLALSimIMRSpinEOBFluxCalculateNewtonianMultipole()

static UNUSED int XLALSimIMRSpinEOBFluxCalculateNewtonianMultipole ( COMPLEX16 *  multipole, REAL8  x, UNUSED REAL8  r, UNUSED REAL8  phi, UINT4  l, INT4  m, EOBParams *  params  )

static

This function calculates the Newtonian multipole part of the factorized waveform for the SEOBNRv1 model.

This is defined in Eq. 4. It ignores the \(exp(\ii * phi)\) part, and returns only the absolute value.

Parameters

multipole	< OUTPUT, Newtonian multipole
x	< Dimensionless parameter \(\equiv v^2\)
r	< Orbital separation (units of total mass M
phi	< Orbital phase (in radians)
l	< Mode l
m	< Mode m
params	< Pre-computed coefficients, parameters, etc.

Definition at line 191 of file LALSimIMREOBNewtonianMultipole.c.