Prototypes
static INT4	XLALSpinDominatedWaveformStoppingTest (UNUSED REAL8 t, const REAL8 values[], REAL8 dvalues[], UNUSED void *mparams)
	Stopping test for the Spin-Dominated waveforms. More...

static INT4	XLALSpinDominatedWaveformDerivatives (UNUSED REAL8 t, const REAL8 values[], REAL8 dvalues[], void *mparams)
	Function calculating the derivatives of the three time dependent variables of the Spin-Dominated waveforms (SDW) The first paramter is phi_n, Eq 27 of Arxiv:1005.5330, taken for 1 spin case, and integrated over an orbital period. More...

int	XLALSpinDominatedWaveformBuild (LALSDWaveformParams params, REAL8 expr[], REAL8TimeSeries hplus, REAL8TimeSeries *hcross, int idx)
	Function building the wavefrom from the calculated parameters at a given time For the formulae see the appendix of Arxiv:1209.1722. More...

int	XLALSpinDominatedWaveformConstantCoefficients (LALSDWaveformParams *params)
	Function for calculating the constant coefficients of Spin-Dominated waveforms See tables 1 to 5 in the appendix of Arxiv:1209.1722. More...

static REAL8 *	XLALDmatrix (INT8 nrh, INT8 nch)
	Function for allocating memory for a matrix. More...

static void	XLALFreeDmatrix (REAL8 *m)
	Function for freeing memory for a matrix. More...

int	XLALSimInspiralSpinDominatedWaveformInterfaceTD (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 D, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 incl, int phaseO, int amplitudeO, REAL8 phiRef)
	Interface routine, calculating the prefered variables for the Spin-dominated waveforms. More...

int	XLALSimInspiralSpinDominatedWaveformDriver (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 totalmass, REAL8 nu, REAL8 chi1, REAL8 D, REAL8 kappa1, REAL8 beta1, REAL8 theta, REAL8 fStart, REAL8 fRef, int phaseO, int amplitudeO, REAL8 deltaT, REAL8 phiRef, REAL8 phin0, REAL8 polarizationangle)
	Function calculating the Spin-Dominated waveforms This waveform is an inspiral only, 1 spin, precessing waveform. More...

Data Structures
struct	LALSDWaveformParams
	Structure containing the prefered variabloes for Spin-Dominated waveforms. More...

Macros
#define	LAL_SDW_ABSOLUTE_TOLERANCE 1.e-12

#define	LAL_SDW_RELATIVE_TOLERANCE 1.e-12

#define	LAL_SDW_NUM_VARIABLES 3

#define	LAL_SDW_MAX_PN_PARAM 0.8

#define	vectorProd(lhs, rhs, denominator, result)

Enumerations
enum	{ PNDEF = -1 , PN00 = 0 , PN05 = 1 , PN10 = 2 , PN15 =3 , PN20 =4 , PN25 =5 , PN3 =6 , PN_ORDER =7 }

enum	TIME_DEPENDANT { PHI , OMEGA , PSI , PHASE = PSI }

enum	COMPONENTS { PLUS_ = 0 , MINUS = 1 , CROSS_ = 1 , PLUS_MINUS_DIM = 2 , PLUS_CROSS_DIM = 2 }

enum	COEFFICIENT_DIMENSIONS { PN00DIM = 2 , PN05DIM = 11 , PN10DIM = 15 , PN15DIM = 17 }

enum	CONSTANTS { TRIGONOMETRIC_POWER = 5 , AMPCOEFF_DIM = 11 , OMEGA_POWER_DIM = 6 , PHI_PSI_DIM = 6 }

Variables
static const REAL8	G_CP2 = LAL_G_SI / LAL_C_SI / LAL_C_SI

Macro Definition Documentation

◆ LAL_SDW_ABSOLUTE_TOLERANCE

#define LAL_SDW_ABSOLUTE_TOLERANCE 1.e-12

Definition at line 34 of file LALSimInspiralSpinDominatedWaveform.c.

◆ LAL_SDW_RELATIVE_TOLERANCE

#define LAL_SDW_RELATIVE_TOLERANCE 1.e-12

Definition at line 35 of file LALSimInspiralSpinDominatedWaveform.c.

◆ LAL_SDW_NUM_VARIABLES

#define LAL_SDW_NUM_VARIABLES 3

Definition at line 36 of file LALSimInspiralSpinDominatedWaveform.c.

◆ LAL_SDW_MAX_PN_PARAM

#define LAL_SDW_MAX_PN_PARAM 0.8

Definition at line 37 of file LALSimInspiralSpinDominatedWaveform.c.

◆ vectorProd

#define vectorProd	(	lhs,
		rhs,
		denominator,
		result
	)

Value:

    result[X] = (lhs[Y] * rhs[Z] - lhs[Z] * rhs[Y]) / denominator;    \
    result[Y] = (lhs[Z] * rhs[X] - lhs[X] * rhs[Z]) / denominator;    \
    result[Z] = (lhs[X] * rhs[Y] - lhs[Y] * rhs[X]) / denominator;

Definition at line 69 of file LALSimInspiralSpinDominatedWaveform.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
PNDEF
PN00
PN05
PN10
PN15
PN20
PN25
PN3
PN_ORDER

Definition at line 49 of file LALSimInspiralSpinDominatedWaveform.c.

◆ TIME_DEPENDANT

enum TIME_DEPENDANT

Enumerator
PHI
OMEGA
PSI
PHASE

Definition at line 53 of file LALSimInspiralSpinDominatedWaveform.c.

◆ COMPONENTS

enum COMPONENTS

Enumerator
PLUS_
MINUS
CROSS_
PLUS_MINUS_DIM
PLUS_CROSS_DIM

Definition at line 57 of file LALSimInspiralSpinDominatedWaveform.c.

◆ COEFFICIENT_DIMENSIONS

enum COEFFICIENT_DIMENSIONS

Enumerator
PN00DIM
PN05DIM
PN10DIM
PN15DIM

Definition at line 61 of file LALSimInspiralSpinDominatedWaveform.c.

◆ CONSTANTS

enum CONSTANTS

Enumerator
TRIGONOMETRIC_POWER
AMPCOEFF_DIM
OMEGA_POWER_DIM
PHI_PSI_DIM

Definition at line 65 of file LALSimInspiralSpinDominatedWaveform.c.

Function Documentation

◆ XLALSpinDominatedWaveformStoppingTest()

static INT4 XLALSpinDominatedWaveformStoppingTest	(	UNUSED REAL8	t,
		const REAL8	values[],
		REAL8	dvalues[],
		UNUSED void *	mparams
	)

static

Stopping test for the Spin-Dominated waveforms.

Using MECO, or the desired ending frequency. The maximum value of the PN parameter is set to 0.8.

Definition at line 1583 of file LALSimInspiralSpinDominatedWaveform.c.

◆ XLALSpinDominatedWaveformDerivatives()

static INT4 XLALSpinDominatedWaveformDerivatives	(	UNUSED REAL8	t,
		const REAL8	values[],
		REAL8	dvalues[],
		void *	mparams
	)

static

Function calculating the derivatives of the three time dependent variables of the Spin-Dominated waveforms (SDW) The first paramter is phi_n, Eq 27 of Arxiv:1005.5330, taken for 1 spin case, and integrated over an orbital period.

The second parameter is omega, the derivative is taken from Arxiv: astro-ph/0504538, up to 2 PN orders with 1 spin. (In order to stay consistent with SDW) The thirs parameter is the phase.

Definition at line 1498 of file LALSimInspiralSpinDominatedWaveform.c.

◆ XLALSpinDominatedWaveformBuild()

int XLALSpinDominatedWaveformBuild	(	LALSDWaveformParams *	params,
		REAL8	expr[],
		REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		int	idx
	)

Function building the wavefrom from the calculated parameters at a given time For the formulae see the appendix of Arxiv:1209.1722.

Parameters

params	The SDW parameters
expr	The 3 time dependent variables of the waveform at the time indexed by idx
hplus	+-polarization waveform
hcross	x-polarization waveform
idx	index of the time dependent variables

Definition at line 612 of file LALSimInspiralSpinDominatedWaveform.c.

◆ XLALSpinDominatedWaveformConstantCoefficients()

int XLALSpinDominatedWaveformConstantCoefficients ( LALSDWaveformParams * params )

Function for calculating the constant coefficients of Spin-Dominated waveforms See tables 1 to 5 in the appendix of Arxiv:1209.1722.

Definition at line 132 of file LALSimInspiralSpinDominatedWaveform.c.

◆ XLALDmatrix()

static REAL8* XLALDmatrix	(	INT8	nrh,
		INT8	nch
	)

static

Function for allocating memory for a matrix.

Definition at line 111 of file LALSimInspiralSpinDominatedWaveform.c.

◆ XLALFreeDmatrix()

static void XLALFreeDmatrix ( REAL8 * m )

static

Function for freeing memory for a matrix.

Definition at line 124 of file LALSimInspiralSpinDominatedWaveform.c.

◆ XLALSimInspiralSpinDominatedWaveformInterfaceTD()

int XLALSimInspiralSpinDominatedWaveformInterfaceTD	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	deltaT,
		REAL8	m1,
		REAL8	m2,
		REAL8	fStart,
		REAL8	fRef,
		REAL8	D,
		REAL8	s1x,
		REAL8	s1y,
		REAL8	s1z,
		REAL8	lnhatx,
		REAL8	lnhaty,
		REAL8	lnhatz,
		REAL8	incl,
		int	phaseO,
		int	amplitudeO,
		REAL8	phiRef
	)

Interface routine, calculating the prefered variables for the Spin-dominated waveforms.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
fStart	start GW frequency (Hz)
fRef	end GW frequency (Hz)
D	distance of source (m)
s1x	initial value of S1x
s1y	initial value of S1y
s1z	initial value of S1z
lnhatx	initial value of LNhatx
lnhaty	initial value of LNhaty
lnhatz	initial value of LNhatz
incl	inclination, angle between L and line of sight N
phaseO	twice PN phase order
amplitudeO	twice PN amplitude order
phiRef	Reference phase at the Reference Frequency

Definition at line 1190 of file LALSimInspiralSpinDominatedWaveform.c.

◆ XLALSimInspiralSpinDominatedWaveformDriver()

int XLALSimInspiralSpinDominatedWaveformDriver	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	totalmass,
		REAL8	nu,
		REAL8	chi1,
		REAL8	D,
		REAL8	kappa1,
		REAL8	beta1,
		REAL8	theta,
		REAL8	fStart,
		REAL8	fRef,
		int	phaseO,
		int	amplitudeO,
		REAL8	deltaT,
		REAL8	phiRef,
		REAL8	phin0,
		REAL8	polarizationangle
	)

Function calculating the Spin-Dominated waveforms This waveform is an inspiral only, 1 spin, precessing waveform.

For the formulae see the appendix of Arxiv:1209.1722

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
totalmass	total mass of the binary
nu	mass ratio
chi1	dimensionless spin paramter
D	Distance to the source
kappa1	Angle span by S_1 and L
beta1	Angle span by J and S_1
theta	Angle span by the line of sight and J
fStart	Starting gravitational wave frequency
fRef	Ending gravitational wave frequency
phaseO	twice PN phase order
amplitudeO	twice PN amplitude order
deltaT	Sampling time interval
phiRef	Reference phase at the Reference Frequency
phin0	Starting value of the phi_n parameter
polarizationangle	Angle to rotate the radiaton frame to the default LALSimulation radiation frame

Definition at line 1346 of file LALSimInspiralSpinDominatedWaveform.c.

Variable Documentation

◆ G_CP2

const REAL8 G_CP2 = LAL_G_SI / LAL_C_SI / LAL_C_SI

static

Definition at line 47 of file LALSimInspiralSpinDominatedWaveform.c.

Prototypes

Data Structures

Macros

Enumerations

Variables

Macro Definition Documentation

◆ LAL_SDW_ABSOLUTE_TOLERANCE

◆ LAL_SDW_RELATIVE_TOLERANCE

◆ LAL_SDW_NUM_VARIABLES

◆ LAL_SDW_MAX_PN_PARAM

◆ vectorProd

Enumeration Type Documentation

◆ anonymous enum

◆ TIME_DEPENDANT

◆ COMPONENTS

◆ COEFFICIENT_DIMENSIONS

◆ CONSTANTS

Function Documentation

◆ XLALSpinDominatedWaveformStoppingTest()

◆ XLALSpinDominatedWaveformDerivatives()

◆ XLALSpinDominatedWaveformBuild()

◆ XLALSpinDominatedWaveformConstantCoefficients()

◆ XLALDmatrix()

◆ XLALFreeDmatrix()

◆ XLALSimInspiralSpinDominatedWaveformInterfaceTD()

◆ XLALSimInspiralSpinDominatedWaveformDriver()

Variable Documentation

◆ G_CP2