LALSimInspiral.h File Reference

#include <lal/LALDatatypes.h>

Include dependency graph for LALSimInspiral.h:

Go to the source code of this file.

Defines
#define	LAL_PN_MODE_L_MAX   3
Functions
	NRCSID (LALSIMINSPIRALH,"$Id: LALSimInspiral.h,v 1.4 2008/03/20 00:31:57 jolien Exp $")
COMPLEX16	XLALSimInspiralPNMode22 (REAL8 x, REAL8 phi, REAL8 logx, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(2,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.
COMPLEX16	XLALSimInspiralPNMode21 (REAL8 x, REAL8 phi, REAL8 logx, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(2,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.
COMPLEX16	XLALSimInspiralPNMode33 (REAL8 x, REAL8 phi, REAL8 logx, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(3,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.
COMPLEX16	XLALSimInspiralPNMode32 (REAL8 x, REAL8 phi, REAL8 logx, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(3,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.
COMPLEX16	XLALSimInspiralPNMode31 (REAL8 x, REAL8 phi, REAL8 logx, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(3,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.
COMPLEX16	XLALSpinWeightedSphericalHarmonic (REAL8 theta, REAL8 phi, int s, int l, int m)
	Computes the (s)Y(l,m) spin-weighted spherical harmonic.
int	XLALSimAddMode (REAL8TimeSeries *hplus, REAL8TimeSeries *hcross, COMPLEX16TimeSeries *hmode, REAL8 theta, REAL8 phi, int l, int m, int sym)
	Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series.
REAL8	XLALSimInspiralPNAngularAcceleration (REAL8 x, REAL8 m1, REAL8 m2, int O)
	Computes the rate of increase of the orbital frequency for a post-Newtonian inspiral.
REAL8	XLALSimInspiralPNAngularVelocity (REAL8 x, REAL8 m1, REAL8 m2)
	Computes the orbital angular velocity from the quantity x.
REAL8	XLALSimInspiralPNEnergy (REAL8 x, REAL8 m1, REAL8 m2, int O)
	Computes the orbital energy at a fixed frequency and pN order.
int	XLALSimInspiralPNEvolveOrbitTaylorT4 (REAL8TimeSeries **x, REAL8TimeSeries **phi, LIGOTimeGPS *tc, REAL8 phic, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fmin, int O)
	Evolves a post-Newtonian orbit using the Taylor T4 method.
COMPLEX16TimeSeries *	XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries (REAL8TimeSeries *x, REAL8TimeSeries *phi, REAL8 x0, REAL8 m1, REAL8 m2, REAL8 r, int O, int l, int m)
	Computes h(l,m) mode timeseries of spherical harmonic decomposition of the post-Newtonian inspiral waveform.
int	XLALSimInspiralPNPolarizationWaveforms (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8TimeSeries *x, REAL8TimeSeries *phi, REAL8 x0, REAL8 m1, REAL8 m2, REAL8 r, REAL8 i, int O)
	Given an orbit evolution phasing, construct the waveform h+ and hx.
int	XLALSimInspiralPN (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, LIGOTimeGPS *tc, REAL8 phic, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fmin, REAL8 r, REAL8 i, int O)
	Driver routine to compute the post-Newtonian inspiral waveform.
int	XLALSimInspiralPNRestricted (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, LIGOTimeGPS *tc, REAL8 phic, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fmin, REAL8 r, REAL8 i, int O)
	Driver routine to compute the restricted post-Newtonian inspiral waveform.

---

Define Documentation

#define LAL_PN_MODE_L_MAX   3

Definition at line 22 of file LALSimInspiral.h.

---

Function Documentation

NRCSID	(	LALSIMINSPIRALH	,
		"$Id: LALSimInspiral.	h,
		v 1.4 2008/03/20 00:31:57 jolien Exp $"
	)

COMPLEX16 XLALSimInspiralPNMode22	(	REAL8	x,
		REAL8	phi,
		REAL8	logx,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(2,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (79) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters:

x	post-Newtonian parameter
phi	orbital phase
logx	log(x/x0) tail gauge parameter
m1	mass of companion 1
m2	mass of companion 2
r	distance of source
O	twice post-Newtonian order

Definition at line 38 of file LALSimInspiralPNMode.c.

COMPLEX16 XLALSimInspiralPNMode21	(	REAL8	x,
		REAL8	phi,
		REAL8	logx,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(2,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (80) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters:

x	post-Newtonian parameter
phi	orbital phase
logx	log(x/x0) tail gauge parameter
m1	mass of companion 1
m2	mass of companion 2
r	distance of source
O	twice post-Newtonian order

Definition at line 92 of file LALSimInspiralPNMode.c.

COMPLEX16 XLALSimInspiralPNMode33	(	REAL8	x,
		REAL8	phi,
		REAL8	logx,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(3,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (82) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters:

x	post-Newtonian parameter
phi	orbital phase
logx	log(x/x0) tail gauge parameter
m1	mass of companion 1
m2	mass of companion 2
r	distance of source
O	twice post-Newtonian order

Definition at line 143 of file LALSimInspiralPNMode.c.

COMPLEX16 XLALSimInspiralPNMode32	(	REAL8	x,
		REAL8	phi,
		REAL8	logx,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(3,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (83) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters:

x	post-Newtonian parameter
phi	orbital phase
logx	log(x/x0) tail gauge parameter
m1	mass of companion 1
m2	mass of companion 2
r	distance of source
O	twice post-Newtonian order

Definition at line 195 of file LALSimInspiralPNMode.c.

COMPLEX16 XLALSimInspiralPNMode31	(	REAL8	x,
		REAL8	phi,
		REAL8	logx,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(3,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (84) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters:

x	post-Newtonian parameter
phi	orbital phase
logx	log(x/x0) tail gauge parameter
m1	mass of companion 1
m2	mass of companion 2
r	distance of source
O	twice post-Newtonian order

Definition at line 244 of file LALSimInspiralPNMode.c.

COMPLEX16 XLALSpinWeightedSphericalHarmonic	(	REAL8	theta,
		REAL8	phi,
		int	s,
		int	l,
		int	m
	)

Computes the (s)Y(l,m) spin-weighted spherical harmonic.

From somewhere ....

See also: Implements Equations (II.9)-(II.13) of D. A. Brown, S. Fairhurst, B. Krishnan, R. A. Mercer, R. K. Kopparapu, L. Santamaria, and J. T. Whelan, "Data formats for numerical relativity waves", arXiv:0709.0093v1 (2007).

Currently only supports s=-2, l=2,3,4,5 modes.

Parameters:

theta	polar angle (rad)
phi	azimuthal angle (rad)
s	spin weight
l	mode number l
m	mode number m

Definition at line 53 of file LALSimInspiral.c.

int XLALSimAddMode	(	REAL8TimeSeries *	hplus,
		REAL8TimeSeries *	hcross,
		COMPLEX16TimeSeries *	hmode,
		REAL8	theta,
		REAL8	phi,
		int	l,
		int	m,
		int	sym
	)

Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series.

Implements the sum of a single term of Eq. (11) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

If sym is non-zero, symmetrically add the m and -m terms assuming that h(l,-m) = (-1)^l h(l,m)*; see Eq. (78) ibid.

Parameters:

hplus	+-polarization waveform
hcross	x-polarization waveform
hmode	complex mode h(l,m)
theta	polar angle (rad)
phi	azimuthal angle (rad)
l	mode number l
m	mode number m
sym	flag to add -m mode too

Definition at line 240 of file LALSimInspiral.c.

REAL8 XLALSimInspiralPNAngularAcceleration	(	REAL8	x,
		REAL8	m1,
		REAL8	m2,
		int	O
	)

Computes the rate of increase of the orbital frequency for a post-Newtonian inspiral.

This function returns dx/dt rather than the true angular acceleration.

Implements Equation (6) of Yi Pan, Alessandra Buonanno, Yanbei Chen, and Michele Vallisneri, "A physical template family for gravitational waves from precessing binaries of spinning compact objects: Application to single-spin binaries" arXiv:gr-qc/0310034v3 (2007).

Note: this equation is actually dx/dt rather than (domega/dt)/(omega)^2 so the leading coefficient is different. Also, this function applies for non-spinning objects.

Compare the overall coefficient, with nu=1/4, to Equation (45) of Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsky "High-accuracy comparison of numerical relativity simulations with post-Newtonian expansions" arXiv:0710.0158v1 (2007).

Parameters:

x	post-Newtonian parameter
m1	mass of companion 1
m2	mass of companion 2
O	twice post-Newtonian order

Definition at line 305 of file LALSimInspiral.c.

REAL8 XLALSimInspiralPNAngularVelocity	(	REAL8	x,
		REAL8	m1,
		REAL8	m2
	)

Computes the orbital angular velocity from the quantity x.

This is from the definition of x.

Implements Equation (46) of Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsky "High-accuracy comparison of numerical relativity simulations with post-Newtonian expansions" arXiv:0710.0158v1 (2007).

Parameters:

x	post-Newtonian parameter
m1	mass of companion 1
m2	mass of companion 2

Definition at line 356 of file LALSimInspiral.c.

REAL8 XLALSimInspiralPNEnergy	(	REAL8	x,
		REAL8	m1,
		REAL8	m2,
		int	O
	)

Computes the orbital energy at a fixed frequency and pN order.

Implements Equation (152) of Luc Blanchet, "Gravitational Radiation from Post-Newtonian Sources and Inspiralling Compact Binaries", http://www.livingreviews.org/lrr-2006-4/index.html

This is the same as Equation (10) (where the spin of the objects is zero) of: Yi Pan, Alessandra Buonanno, Yanbei Chen, and Michele Vallisneri, "A physical template family for gravitational waves from precessing binaries of spinning compact objects: Application to single-spin binaries" arXiv:gr-qc/0310034v3 (2007). Note: this equation is actually dx/dt rather than (domega/dt)/(omega)^2 so the leading coefficient is different.

Parameters:

x	post-Newtonian parameter
m1	mass of companion 1
m2	mass of companion 2
O	twice post-Newtonian order

Definition at line 387 of file LALSimInspiral.c.

int XLALSimInspiralPNEvolveOrbitTaylorT4	(	REAL8TimeSeries **	x,
		REAL8TimeSeries **	phi,
		LIGOTimeGPS *	tc,
		REAL8	phic,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	fmin,
		int	O
	)

Evolves a post-Newtonian orbit using the Taylor T4 method.

See: Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsky "High-accuracy comparison of numerical relativity simulations with post-Newtonian expansions" arXiv:0710.0158v1 (2007).

Parameters:

x	post-Newtonian parameter [returned]
phi	orbital phase [returned]
tc	coalescence time
phic	coalescence phase
deltaT	sampling interval
m1	mass of companion 1
m2	mass of companion 2
fmin	start frequency
O	twice post-Newtonian order

Definition at line 445 of file LALSimInspiral.c.

COMPLEX16TimeSeries* XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries	(	REAL8TimeSeries *	x,
		REAL8TimeSeries *	phi,
		REAL8	x0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O,
		int	l,
		int	m
	)

Computes h(l,m) mode timeseries of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

See Eqns. (79)-(116) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters:

x	post-Newtonian parameter
phi	orbital phase
x0	tail-term gauge choice thing (if you don't know, just set it to zero)
m1	mass of companion 1
m2	mass of companion 2
r	distance of source
O	twice post-Newtonain order
l	mode number l
m	mode number m

Definition at line 550 of file LALSimInspiral.c.

int XLALSimInspiralPNPolarizationWaveforms	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8TimeSeries *	x,
		REAL8TimeSeries *	phi,
		REAL8	x0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		REAL8	i,
		int	O
	)

Given an orbit evolution phasing, construct the waveform h+ and hx.

Implements Equation (11) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters:

hplus	+-polarization waveform [returned]
hcross	x-polarization waveform [returned]
x	post-Newtonian parameter
phi	orbital phase
x0	tail-term gauge choice thing (if you don't know, just set it to zero)
m1	mass of companion 1
m2	mass of companion 2
r	distance of source
i	inclination of source (rad)
O	twice post-Newtonian order

Definition at line 608 of file LALSimInspiral.c.

int XLALSimInspiralPN	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		LIGOTimeGPS *	tc,
		REAL8	phic,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	fmin,
		REAL8	r,
		REAL8	i,
		int	O
	)

Driver routine to compute the post-Newtonian inspiral waveform.

This routine uses the same pN order for phasing and amplitude (unless the order is -1 in which case the highest available order is used for both of these -- which might not be the same).

Log terms in amplitudes are ignored. This is a gauge choice.

Parameters:

hplus	+-polarization waveform
hcross	x-polarization waveform
tc	coalescence time
phic	coalescence phase
deltaT	sampling interval
m1	mass of companion 1
m2	mass of companion 2
fmin	start frequency
r	distance of source
i	inclination of source (rad)
O	twice post-Newtonian order

Definition at line 693 of file LALSimInspiral.c.

int XLALSimInspiralPNRestricted	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		LIGOTimeGPS *	tc,
		REAL8	phic,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	fmin,
		REAL8	r,
		REAL8	i,
		int	O
	)

Driver routine to compute the restricted post-Newtonian inspiral waveform.

This routine computes the phasing to the specified order, but only computes the amplitudes to the Newtonian (quadrupole) order.

Log terms in amplitudes are ignored. This is a gauge choice.

Parameters:

hplus	+-polarization waveform
hcross	x-polarization waveform
tc	coalescence time
phic	coalescence phase
deltaT	sampling interval
m1	mass of companion 1
m2	mass of companion 2
fmin	start frequency
r	distance of source
i	inclination of source (rad)
O	twice post-Newtonian phase order

Definition at line 719 of file LALSimInspiral.c.

---