Prototypes
static int	XLALSimInspiralVectorCrossProduct (REAL8 **vout, REAL8 v1x, REAL8 v1y, REAL8 v1z, REAL8 v2x, REAL8 v2y, REAL8 v2z)

static REAL8	cdot (REAL8 v1x, REAL8 v1y, REAL8 v1z, REAL8 v2x, REAL8 v2y, REAL8 v2z)

static REAL8	normsq (REAL8 vx, REAL8 vy, REAL8 vz)

static int	XLALSimInspiralSpinTaylorStoppingTest (double t, const double values[], double dvalues[], void *mparams)

static int	XLALSimInspiralSpinTaylorT1DerivativesAvg (double t, const double values[], double dvalues[], void *mparams)

static int	XLALSimInspiralSpinTaylorT5DerivativesAvg (double t, const double values[], double dvalues[], void *mparams)

static int	XLALSimInspiralSpinTaylorPNEvolveOrbitIrregularIntervals (REAL8Array **yout, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fEnd, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALSimInspiralSpinOrder spinO, LALSimInspiralTidalOrder tideO, INT4 phaseO, Approximant approx)
	This function evolves the orbital equations for a precessing binary using the "TaylorT5/T4" approximant for solving the orbital dynamics (see arXiv:0907.0700 for a review of the various PN approximants). More...

static int	XLALSimInspiralSpinTaylorDriverFourier (COMPLEX16FrequencySeries hplus, COMPLEX16FrequencySeries hcross, REAL8 fMin, REAL8 fMax, REAL8 deltaF, INT4 kMax, REAL8 phiRef, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 r, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams, INT4 phaseO, INT4 amplitudeO, Approximant approx, INT4 phiRefAtEnd)

static REAL8Array *	appendTAandFree (REAL8Array start, REAL8Array end, REAL8Array *combined)

static REAL8Array *	removeDuplicates (REAL8Array *series)

INT4	XLALSimSpinTaylorEnergySpinDerivativeSetup (XLALSimInspiralSpinTaylorTxCoeffs **params, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fStart, const REAL8 fEnd, const LALSimInspiralSpinOrder spinO, const LALSimInspiralTidalOrder tideO, const INT4 phaseO, const REAL8 lambda1, const REAL8 lambda2, const REAL8 quadparam1, const REAL8 quadparam2, const INT4 lscorr, const INT4 phenomtp)

INT4	XLALSimInspiralSpinDerivativesAvg (REAL8 dLNhx, REAL8 dLNhy, REAL8 dLNhz, REAL8 dE1x, REAL8 dE1y, REAL8 dE1z, REAL8 dS1x, REAL8 dS1y, REAL8 dS1z, REAL8 dS2x, REAL8 dS2y, REAL8 dS2z, const REAL8 v, const REAL8 LNhx, const REAL8 LNhy, const REAL8 LNhz, const REAL8 E1x, const REAL8 E1y, const REAL8 E1z, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 LNhdotS1, const REAL8 LNhdotS2, XLALSimInspiralSpinTaylorTxCoeffs *params)
	Function computing spin precession equations, common to all member of the SpinTaylor family. More...

INT4	XLALSimInspiralSpinTaylorT4Setup (XLALSimInspiralSpinTaylorTxCoeffs **params, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fStart, const REAL8 fEnd, const REAL8 lambda1, const REAL8 lambda2, const REAL8 quadparam1, const REAL8 quadparam2, const LALSimInspiralSpinOrder spinO, const LALSimInspiralTidalOrder tideO, const INT4 phaseO, const INT4 lscorr, const INT4 phenomtp)
	See arXiv:0907.0700 for TaylorT4 definition. More...

int	XLALSimInspiralSpinTaylorT1Setup (XLALSimInspiralSpinTaylorTxCoeffs **params, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fStart, const REAL8 fEnd, const REAL8 lambda1, const REAL8 lambda2, const REAL8 quadparam1, const REAL8 quadparam2, const LALSimInspiralSpinOrder spinO, const LALSimInspiralTidalOrder tideO, const INT4 phaseO, const INT4 lscorr)
	See arXiv:0907.0700 for TaylorT1 definition. More...

int	XLALSimInspiralSpinTaylorT5Setup (XLALSimInspiralSpinTaylorTxCoeffs **params, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fStart, const REAL8 fEnd, const REAL8 lambda1, const REAL8 lambda2, const REAL8 quadparam1, const REAL8 quadparam2, const LALSimInspiralSpinOrder spinO, const LALSimInspiralTidalOrder tideO, const INT4 phaseO, const INT4 lscorr)
	See arXiv:1107.1267 for TaylorT5 approximant definition. More...

INT4	XLALSimInspiralSetEnergyPNTermsAvg (REAL8 Espin3, REAL8 Espin4, REAL8 Espin5, REAL8 Espin6, REAL8 Espin7, XLALSimInspiralSpinTaylorTxCoeffs params, const REAL8 LNhdotS1, const REAL8 LNhdotS2, const REAL8 S1sq, const REAL8 S2sq, const REAL8 S1dotS2)

static int	XLALSimInspiralSpinTaylorStoppingTest (double UNUSED t, const double values[], double dvalues[], void *mparams)

static REAL8	omegashift (REAL8 S1sq, REAL8 S2sq, REAL8 S1S2, REAL8 LNhS1, REAL8 LNhS2, REAL8 OmS1, REAL8 OmS2)

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

static int	XLALSimInspiralSpinTaylorT1DerivativesAvg (double UNUSED t, const double values[], double dvalues[], void *mparams)

static int	XLALSimInspiralSpinTaylorT5DerivativesAvg (double UNUSED t, const double values[], double dvalues[], void *mparams)

static REAL8TimeSeries *	appendTSandFree (REAL8TimeSeries start, REAL8TimeSeries end)

int	XLALSimInspiralSpinTaylorDriver (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8TimeSeries Vout, REAL8TimeSeries Phiout, REAL8TimeSeries S1xout, REAL8TimeSeries S1yout, REAL8TimeSeries S1zout, REAL8TimeSeries S2xout, REAL8TimeSeries S2yout, REAL8TimeSeries S2zout, REAL8TimeSeries LNhxout, REAL8TimeSeries LNhyout, REAL8TimeSeries LNhzout, REAL8TimeSeries E1xout, REAL8TimeSeries E1yout, REAL8TimeSeries E1zout, const REAL8 phiRef, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fStart, const REAL8 fRef, const REAL8 r, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, const REAL8 lnhatx, const REAL8 lnhaty, const REAL8 lnhatz, const REAL8 e1x, const REAL8 e1y, const REAL8 e1z, LALDict *LALparams, const Approximant approx)
	Driver function to generate any of SpinTaylorT1/T5/T4 If the output entries are not null the relative variables are returned. More...

int	XLALSimInspiralSpinTaylorOrbitalDriver (REAL8TimeSeries Vout, REAL8TimeSeries Phiout, REAL8TimeSeries S1xout, REAL8TimeSeries S1yout, REAL8TimeSeries S1zout, REAL8TimeSeries S2xout, REAL8TimeSeries S2yout, REAL8TimeSeries S2zout, REAL8TimeSeries LNhxout, REAL8TimeSeries LNhyout, REAL8TimeSeries LNhzout, REAL8TimeSeries E1xout, REAL8TimeSeries E1yout, REAL8TimeSeries E1zout, const REAL8 phiRef, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fStart, const REAL8 fRef, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, const REAL8 lnhatx, const REAL8 lnhaty, const REAL8 lnhatz, const REAL8 e1x, const REAL8 e1y, const REAL8 e1z, LALDict *LALparams, const Approximant approx)
	Driver function wrapper for XLALSimInspiralSpinTaylorDriver() with the same output except for h+ and hx time series. More...

INT4	XLALSimInspiralSpinTaylorHlmModesFromOrbit (SphHarmTimeSeries *hlm, REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8TimeSeries LNhx, REAL8TimeSeries LNhy, REAL8TimeSeries LNhz, REAL8TimeSeries E1x, REAL8TimeSeries E1y, REAL8TimeSeries E1z, REAL8TimeSeries S1x, REAL8TimeSeries S1y, REAL8TimeSeries S1z, REAL8TimeSeries S2x, REAL8TimeSeries S2y, REAL8TimeSeries S2z, REAL8 m1_SI, REAL8 m2_SI, REAL8 dist_SI, int ampO, LALValue modearray)

INT4	XLALSimInspiralSpinTaylorHlmModes (SphHarmTimeSeries *hlm, REAL8 phiRef, REAL8 dT, REAL8 m1_SI, REAL8 m2_SI, REAL8 fStart, REAL8 fRef, REAL8 dist_SI, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, int ampO, LALValue modearray, LALDict *LALparams, Approximant approx)

int	XLALSimInspiralTransformPrecessingObsoleteInitialConditions (REAL8 incl, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 *S2z, REAL8 thetaJN, REAL8 phiJL, REAL8 theta1, REAL8 theta2, REAL8 phi12, REAL8 chi1, REAL8 chi2, REAL8 m1, REAL8 m2, REAL8 fRef)
	Function to specify the desired orientation of a precessing binary in terms of several angles and then compute the vector components in the so-called "radiation frame" (with the z-axis along the direction of propagation) as needed to specify binary configuration for ChooseTDWaveform. More...

int	XLALSimInspiralInitialConditionsPrecessingApproxs (REAL8 inc, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 *S2z, const REAL8 inclIn, const REAL8 S1xIn, const REAL8 S1yIn, const REAL8 S1zIn, const REAL8 S2xIn, const REAL8 S2yIn, const REAL8 S2zIn, const REAL8 m1, const REAL8 m2, const REAL8 fRef, const REAL8 phiRef, LALSimInspiralFrameAxis frameChoice)
	Function to specify the desired orientation of the spin components of a precessing binary. More...

int	XLALSimInspiralSpinTaylorPNEvolveOrbit (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8TimeSeries S1x, REAL8TimeSeries S1y, REAL8TimeSeries S1z, REAL8TimeSeries S2x, REAL8TimeSeries S2y, REAL8TimeSeries S2z, REAL8TimeSeries LNhatx, REAL8TimeSeries LNhaty, REAL8TimeSeries LNhatz, REAL8TimeSeries E1x, REAL8TimeSeries E1y, REAL8TimeSeries E1z, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fStart, const REAL8 fEnd, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, const REAL8 lnhatx, const REAL8 lnhaty, const REAL8 lnhatz, const REAL8 e1x, const REAL8 e1y, const REAL8 e1z, const REAL8 lambda1, const REAL8 lambda2, const REAL8 quadparam1, const REAL8 quadparam2, const LALSimInspiralSpinOrder spinO, const LALSimInspiralTidalOrder tideO, const INT4 phaseO, const INT4 lscorr, const Approximant approx)
	This function evolves the orbital equations for a precessing binary using the "TaylorT1/T5/T4" approximant for solving the orbital dynamics (see arXiv:0907.0700 for a review of the various PN approximants). More...

int	XLALSimInspiralSpinTaylorPNEvolveOrbitOnlyFinal (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8TimeSeries S1x, REAL8TimeSeries S1y, REAL8TimeSeries S1z, REAL8TimeSeries S2x, REAL8TimeSeries S2y, REAL8TimeSeries S2z, REAL8TimeSeries LNhatx, REAL8TimeSeries LNhaty, REAL8TimeSeries LNhatz, REAL8TimeSeries E1x, REAL8TimeSeries E1y, REAL8TimeSeries E1z, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fStart, const REAL8 fEnd, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, const REAL8 lnhatx, const REAL8 lnhaty, const REAL8 lnhatz, const REAL8 e1x, const REAL8 e1y, const REAL8 e1z, const REAL8 lambda1, const REAL8 lambda2, const REAL8 quadparam1, const REAL8 quadparam2, const LALSimInspiralSpinOrder spinO, const LALSimInspiralTidalOrder tideO, const INT4 phaseO, const INT4 lscorr, const Approximant approx)
	This function evolves the orbital equations for a precessing binary using the "TaylorT1/T5/T4" approximant for solving the orbital dynamics (see arXiv:0907.0700 for a review of the various PN approximants). More...

int	XLALSimInspiralSpinTaylorT4OLD (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 phiRef, REAL8 UNUSED v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 r, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams, int phaseO, int amplitudeO)
	Driver routine to compute a precessing post-Newtonian inspiral waveform with phasing computed from energy balance using the so-called "T4" method. More...

int	XLALSimInspiralSpinTaylorT4 (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 r, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, LALDict *LALparams)

int	XLALSimInspiralSpinTaylorT1OLD (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 phiRef, REAL8 UNUSED v0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 r, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams, int phaseO, int amplitudeO)
	Driver routine to compute a precessing post-Newtonian inspiral waveform with phasing computed from energy balance using the so-called "T1" method. More...

int	XLALSimInspiralSpinTaylorT1 (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 r, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, LALDict *LALparams)

int	XLALSimInspiralSpinTaylorT5 (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 r, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, LALDict *LALparams)
	Driver routine to compute a precessing post-Newtonian inspiral waveform with phasing computed from energy balance using the so-called "T5" method. More...

int	XLALSimInspiralPrecessingPTFQWaveforms (REAL8TimeSeries Q1, REAL8TimeSeries Q2, REAL8TimeSeries Q3, REAL8TimeSeries Q4, REAL8TimeSeries *Q5, REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8TimeSeries S1x, REAL8TimeSeries S1y, REAL8TimeSeries S1z, REAL8TimeSeries S2x, REAL8TimeSeries S2y, REAL8TimeSeries S2z, REAL8TimeSeries LNhatx, REAL8TimeSeries LNhaty, REAL8TimeSeries LNhatz, REAL8TimeSeries E1x, REAL8TimeSeries E1y, REAL8TimeSeries *E1z, REAL8 m1, REAL8 m2, REAL8 r)
	Compute the physical template family "Q" vectors for a spinning, precessing binary when provided time series of all the dynamical quantities. More...

int	XLALSimInspiralSpinTaylorT4PTFQVecs (REAL8TimeSeries Q1, REAL8TimeSeries Q2, REAL8TimeSeries Q3, REAL8TimeSeries Q4, REAL8TimeSeries **Q5, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 chi1, REAL8 kappa1, REAL8 fStart, REAL8 lambda1, REAL8 lambda2, LALSimInspiralSpinOrder spinO, LALSimInspiralTidalOrder tideO, int phaseO)
	Driver routine to compute the physical template family "Q" vectors using the "T4" method. More...

int	XLALSimInspiralSpinTaylorT4Fourier (COMPLEX16FrequencySeries hplus, COMPLEX16FrequencySeries hcross, REAL8 fMin, REAL8 fMax, REAL8 deltaF, INT4 kMax, REAL8 phiRef, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 r, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams, INT4 phaseO, INT4 amplitudeO, INT4 phiRefAtEnd)
	Driver routine to compute a precessing post-Newtonian inspiral waveform in the Fourier domain with phasing computed from energy balance using the so-called "T4" method. More...

int	XLALSimInspiralSpinTaylorT5Fourier (COMPLEX16FrequencySeries hplus, COMPLEX16FrequencySeries hcross, REAL8 fMin, REAL8 fMax, REAL8 deltaF, INT4 kMax, REAL8 phiRef, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 fStart, REAL8 fRef, REAL8 r, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhatx, REAL8 lnhaty, REAL8 lnhatz, REAL8 e1x, REAL8 e1y, REAL8 e1z, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams, INT4 phaseO, INT4 amplitudeO, INT4 phiRefAtEnd)
	Driver routine to compute a precessing post-Newtonian inspiral waveform in the Fourier domain with phasing computed from energy balance using the so-called "T2" method see arXiv: 0907.0700 for its definition, but in its "T5" variant, see arXiv: 1107.1267. More...

Macros
#define	XLAL_BEGINGSL

#define	XLAL_ENDGSL

#define	LALSIMINSPIRAL_ST_TEST_ENERGY 1025

#define	LALSIMINSPIRAL_ST_TEST_OMEGADOUBLEDOT 1026

#define	LALSIMINSPIRAL_ST_TEST_COORDINATE 1027

#define	LALSIMINSPIRAL_ST_TEST_OMEGANAN 1028

#define	LALSIMINSPIRAL_ST_TEST_FREQBOUND 1029

#define	LALSIMINSPIRAL_ST_DERIVATIVE_OMEGANONPOS 1030

#define	LALSIMINSPIRAL_ST_TEST_LARGEV 1031

#define	LAL_MAX_PN_ORDER 8

#define	LAL_NUM_ST4_VARIABLES 14

#define	LAL_ST4_ABSOLUTE_TOLERANCE 1.e-12

#define	LAL_ST4_RELATIVE_TOLERANCE 1.e-12

#define	ROTATEZ(angle, vx, vy, vz)

#define	ROTATEY(angle, vx, vy, vz)

Macro Definition Documentation

◆ XLAL_BEGINGSL

#define XLAL_BEGINGSL

Value:

        { \
          gsl_error_handler_t *saveGSLErrorHandler_; \
          saveGSLErrorHandler_ = gsl_set_error_handler_off();

Definition at line 31 of file LALSimInspiralSpinTaylor.c.

◆ XLAL_ENDGSL

#define XLAL_ENDGSL

Value:

gsl_set_error_handler( saveGSLErrorHandler_ ); \

}

Definition at line 36 of file LALSimInspiralSpinTaylor.c.

◆ LALSIMINSPIRAL_ST_TEST_ENERGY

#define LALSIMINSPIRAL_ST_TEST_ENERGY 1025

Definition at line 41 of file LALSimInspiralSpinTaylor.c.

◆ LALSIMINSPIRAL_ST_TEST_OMEGADOUBLEDOT

#define LALSIMINSPIRAL_ST_TEST_OMEGADOUBLEDOT 1026

Definition at line 42 of file LALSimInspiralSpinTaylor.c.

◆ LALSIMINSPIRAL_ST_TEST_COORDINATE

#define LALSIMINSPIRAL_ST_TEST_COORDINATE 1027

Definition at line 43 of file LALSimInspiralSpinTaylor.c.

◆ LALSIMINSPIRAL_ST_TEST_OMEGANAN

#define LALSIMINSPIRAL_ST_TEST_OMEGANAN 1028

Definition at line 44 of file LALSimInspiralSpinTaylor.c.

◆ LALSIMINSPIRAL_ST_TEST_FREQBOUND

#define LALSIMINSPIRAL_ST_TEST_FREQBOUND 1029

Definition at line 45 of file LALSimInspiralSpinTaylor.c.

◆ LALSIMINSPIRAL_ST_DERIVATIVE_OMEGANONPOS

#define LALSIMINSPIRAL_ST_DERIVATIVE_OMEGANONPOS 1030

Definition at line 46 of file LALSimInspiralSpinTaylor.c.

◆ LALSIMINSPIRAL_ST_TEST_LARGEV

#define LALSIMINSPIRAL_ST_TEST_LARGEV 1031

Definition at line 47 of file LALSimInspiralSpinTaylor.c.

◆ LAL_MAX_PN_ORDER

#define LAL_MAX_PN_ORDER 8

Definition at line 50 of file LALSimInspiralSpinTaylor.c.

◆ LAL_NUM_ST4_VARIABLES

#define LAL_NUM_ST4_VARIABLES 14

Definition at line 52 of file LALSimInspiralSpinTaylor.c.

◆ LAL_ST4_ABSOLUTE_TOLERANCE

#define LAL_ST4_ABSOLUTE_TOLERANCE 1.e-12

Definition at line 58 of file LALSimInspiralSpinTaylor.c.

◆ LAL_ST4_RELATIVE_TOLERANCE

#define LAL_ST4_RELATIVE_TOLERANCE 1.e-12

Definition at line 59 of file LALSimInspiralSpinTaylor.c.

◆ ROTATEZ

#define ROTATEZ	(	angle,
		vx,
		vy,
		vz
	)

Value:

        tmp1 = vx*cos(angle) - vy*sin(angle);\
        tmp2 = vx*sin(angle) + vy*cos(angle);\
        vx = tmp1;\
        vy = tmp2

Definition at line 62 of file LALSimInspiralSpinTaylor.c.

◆ ROTATEY

#define ROTATEY	(	angle,
		vx,
		vy,
		vz
	)

Value:

        tmp1 = vx*cos(angle) + vz*sin(angle);\
        tmp2 = - vx*sin(angle) + vz*cos(angle);\
        vx = tmp1;\
        vz = tmp2

Definition at line 68 of file LALSimInspiralSpinTaylor.c.

Function Documentation

◆ XLALSimInspiralVectorCrossProduct()

static int XLALSimInspiralVectorCrossProduct	(	REAL8 **	vout,
		REAL8	v1x,
		REAL8	v1y,
		REAL8	v1z,
		REAL8	v2x,
		REAL8	v2y,
		REAL8	v2z
	)

static

Definition at line 75 of file LALSimInspiralSpinTaylor.c.

◆ cdot()

static REAL8 cdot	(	REAL8	v1x,
		REAL8	v1y,
		REAL8	v1z,
		REAL8	v2x,
		REAL8	v2y,
		REAL8	v2z
	)

static

Definition at line 83 of file LALSimInspiralSpinTaylor.c.

◆ normsq()

static REAL8 normsq	(	REAL8	vx,
		REAL8	vy,
		REAL8	vz
	)

static

Definition at line 87 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorStoppingTest() [1/2]

static int XLALSimInspiralSpinTaylorStoppingTest	(	double	t,
		const double	values[],
		double	dvalues[],
		void *	mparams
	)

static

◆ XLALSimInspiralSpinTaylorT1DerivativesAvg() [1/2]

static int XLALSimInspiralSpinTaylorT1DerivativesAvg	(	double	t,
		const double	values[],
		double	dvalues[],
		void *	mparams
	)

static

◆ XLALSimInspiralSpinTaylorT5DerivativesAvg() [1/2]

static int XLALSimInspiralSpinTaylorT5DerivativesAvg	(	double	t,
		const double	values[],
		double	dvalues[],
		void *	mparams
	)

static

◆ XLALSimInspiralSpinTaylorPNEvolveOrbitIrregularIntervals()

static int XLALSimInspiralSpinTaylorPNEvolveOrbitIrregularIntervals	(	REAL8Array **	yout,
		REAL8	m1,
		REAL8	m2,
		REAL8	fStart,
		REAL8	fEnd,
		REAL8	s1x,
		REAL8	s1y,
		REAL8	s1z,
		REAL8	s2x,
		REAL8	s2y,
		REAL8	s2z,
		REAL8	lnhatx,
		REAL8	lnhaty,
		REAL8	lnhatz,
		REAL8	e1x,
		REAL8	e1y,
		REAL8	e1z,
		REAL8	lambda1,
		REAL8	lambda2,
		REAL8	quadparam1,
		REAL8	quadparam2,
		LALSimInspiralSpinOrder	spinO,
		LALSimInspiralTidalOrder	tideO,
		INT4	phaseO,
		Approximant	approx
	)

static

This function evolves the orbital equations for a precessing binary using the "TaylorT5/T4" approximant for solving the orbital dynamics (see arXiv:0907.0700 for a review of the various PN approximants).

It returns time series of the "orbital velocity", orbital phase, and components for both individual spin vectors, the "Newtonian" orbital angular momentum (which defines the instantaneous plane) and "E1", a basis vector in the instantaneous orbital plane, as well as the time derivative of the orbital frequency. Note that LNhat and E1 completely specify the instantaneous orbital plane.

For input, the function takes the two masses, the initial orbital phase, Values of S1, S2, LNhat, E1 vectors at starting time, the desired time step size, the starting GW frequency, and PN order at which to evolve the phase,

NOTE: All vectors are given in the so-called "radiation frame", where the direction of propagation is the z-axis, the principal "+" polarization axis is the x-axis, and the y-axis is given by the RH rule. You must give the initial values in this frame, and the time series of the vector components will also be returned in this frame

!!!UNREVIEWED!!!

Parameters

yout	array holding the unevenly sampled output [returned]
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
fStart	starting GW frequency
fEnd	ending GW frequency, fEnd=0 means integrate as far forward as possible
s1x	initial value of S1x
s1y	initial value of S1y
s1z	initial value of S1z
s2x	initial value of S2x
s2y	initial value of S2y
s2z	initial value of S2z
lnhatx	initial value of LNhatx
lnhaty	initial value of LNhaty
lnhatz	initial value of LNhatz
e1x	initial value of E1x
e1y	initial value of E1y
e1z	initial value of E1z
lambda1	(tidal deformability of mass 1) / (mass of body 1)^5 (dimensionless)
lambda2	(tidal deformability of mass 2) / (mass of body 2)^5 (dimensionless)
quadparam1	phenom. parameter describing induced quad. moment of body 1 (=1 for BHs, ~2-12 for NSs)
quadparam2	phenom. parameter describing induced quad. moment of body 2 (=1 for BHs, ~2-12 for NSs)
spinO	twice PN order of spin effects
tideO	twice PN order of tidal effects
phaseO	twice post-Newtonian order
approx	PN approximant (SpinTaylorT1/T5/T4)

Definition at line 3596 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorDriverFourier()

static int XLALSimInspiralSpinTaylorDriverFourier	(	COMPLEX16FrequencySeries **	hplus,
		COMPLEX16FrequencySeries **	hcross,
		REAL8	fMin,
		REAL8	fMax,
		REAL8	deltaF,
		INT4	kMax,
		REAL8	phiRef,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	fStart,
		REAL8	fRef,
		REAL8	r,
		REAL8	s1x,
		REAL8	s1y,
		REAL8	s1z,
		REAL8	s2x,
		REAL8	s2y,
		REAL8	s2z,
		REAL8	lnhatx,
		REAL8	lnhaty,
		REAL8	lnhatz,
		REAL8	e1x,
		REAL8	e1y,
		REAL8	e1z,
		REAL8	lambda1,
		REAL8	lambda2,
		REAL8	quadparam1,
		REAL8	quadparam2,
		LALDict *	LALparams,
		INT4	phaseO,
		INT4	amplitudeO,
		Approximant	approx,
		INT4	phiRefAtEnd
	)

static

minimum index for the a_k's adefined in Eq. (40) of arXiv: 1408.5158.

constants a_k defined in Eq. (40) of arXiv: 1408.5158.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
fMin	minimum frequency of the returned series
fMax	maximum frequency of the returned series
deltaF	frequency interval of the returned series
kMax	k_max as described in arXiv: 1408.5158 (min 0, max 10).
phiRef	orbital phase at reference pt.
v0	tail gauge term (default = 1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
fStart	start GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
s1x	initial value of S1x
s1y	initial value of S1y
s1z	initial value of S1z
s2x	initial value of S2x
s2y	initial value of S2y
s2z	initial value of S2z
lnhatx	initial value of LNhatx
lnhaty	initial value of LNhaty
lnhatz	initial value of LNhatz
e1x	initial value of E1x
e1y	initial value of E1y
e1z	initial value of E1z
lambda1	(tidal deformability of mass 1) / (mass of body 1)^5 (dimensionless)
lambda2	(tidal deformability of mass 2) / (mass of body 2)^5 (dimensionless)
quadparam1	phenom. parameter describing induced quad. moment of body 1 (=1 for BHs, ~2-12 for NSs)
quadparam2	phenom. parameter describing induced quad. moment of body 2 (=1 for BHs, ~2-12 for NSs)
LALparams	LAL dictionary containing accessory parameters
phaseO	twice PN phase order
amplitudeO	twice PN amplitude order
approx	PN approximant (SpinTaylorT1/T5/T4)
phiRefAtEnd	whether phiRef corresponds to the end of the inspiral

Definition at line 1423 of file LALSimInspiralSpinTaylor.c.

◆ appendTAandFree()

static REAL8Array* appendTAandFree	(	REAL8Array *	start,
		REAL8Array *	end,
		REAL8Array *	combined
	)

static

Definition at line 120 of file LALSimInspiralSpinTaylor.c.

◆ removeDuplicates()

static REAL8Array* removeDuplicates ( REAL8Array * series )

static

Definition at line 176 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimSpinTaylorEnergySpinDerivativeSetup()

INT4 XLALSimSpinTaylorEnergySpinDerivativeSetup	(	XLALSimInspiralSpinTaylorTxCoeffs **	params,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	fStart,
		const REAL8	fEnd,
		const LALSimInspiralSpinOrder	spinO,
		const LALSimInspiralTidalOrder	tideO,
		const INT4	phaseO,
		const REAL8	lambda1,
		const REAL8	lambda2,
		const REAL8	quadparam1,
		const REAL8	quadparam2,
		const INT4	lscorr,
		const INT4	phenomtp
	)

Parameters

params	OUTPUT
m1_SI	mass of body 1 (kg)
m2_SI	mass of body 2 (kg)
fStart	Starting GW freq. (Hz)
fEnd	Ending GW freq. (Hz), 0 means integrate forwards as far as possible
spinO	twice PN order of spin effects
tideO	twice PN order of tidal effects
phaseO	twice PN order of spin effects
lambda1	(tidal deformability of mass 1) / (mass of body 1)^5 (dimensionless)
lambda2	(tidal deformability of mass 2) / (mass of body 2)^5 (dimensionless)
quadparam1	phenom. parameter describing induced quad. moment of body 1 (=1 for BHs, ~2-12 for NSs)
quadparam2	phenom. parameter describing induced quad. moment of body 2 (=1 for BHs, ~2-12 for NSs)
lscorr	flag to include spin corrections to orbital angular momentum
phenomtp	flag for using spinO=7 and not spinO=6 terms with orbital-averaged quantities for phenomtphm approx

Definition at line 253 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinDerivativesAvg()

INT4 XLALSimInspiralSpinDerivativesAvg	(	REAL8 *	dLNhx,
		REAL8 *	dLNhy,
		REAL8 *	dLNhz,
		REAL8 *	dE1x,
		REAL8 *	dE1y,
		REAL8 *	dE1z,
		REAL8 *	dS1x,
		REAL8 *	dS1y,
		REAL8 *	dS1z,
		REAL8 *	dS2x,
		REAL8 *	dS2y,
		REAL8 *	dS2z,
		const REAL8	v,
		const REAL8	LNhx,
		const REAL8	LNhy,
		const REAL8	LNhz,
		const REAL8	E1x,
		const REAL8	E1y,
		const REAL8	E1z,
		const REAL8	S1x,
		const REAL8	S1y,
		const REAL8	S1z,
		const REAL8	S2x,
		const REAL8	S2y,
		const REAL8	S2z,
		const REAL8	LNhdotS1,
		const REAL8	LNhdotS2,
		XLALSimInspiralSpinTaylorTxCoeffs *	params
	)

Function computing spin precession equations, common to all member of the SpinTaylor family.

Orbit averaged dynamics.

Definition at line 483 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorT4Setup()

INT4 XLALSimInspiralSpinTaylorT4Setup	(	XLALSimInspiralSpinTaylorTxCoeffs **	params,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	fStart,
		const REAL8	fEnd,
		const REAL8	lambda1,
		const REAL8	lambda2,
		const REAL8	quadparam1,
		const REAL8	quadparam2,
		const LALSimInspiralSpinOrder	spinO,
		const LALSimInspiralTidalOrder	tideO,
		const INT4	phaseO,
		const INT4	lscorr,
		const INT4	phenomtp
	)

See arXiv:0907.0700 for TaylorT4 definition.

Parameters

params	OUTPUT
m1_SI	mass of body 1 (kg)
m2_SI	mass of body 2 (kg)
fStart	Starting GW freq. (Hz)
fEnd	Ending GW freq. (Hz), 0 means integrate forwards as far as possible
lambda1	(tidal deformability of mass 1) / (mass of body 1)^5 (dimensionless)
lambda2	(tidal deformability of mass 2) / (mass of body 2)^5 (dimensionless)
quadparam1	phenom. parameter describing induced quad. moment of body 1 (=1 for BHs, ~2-12 for NSs)
quadparam2	phenom. parameter describing induced quad. moment of body 2 (=1 for BHs, ~2-12 for NSs)
spinO	twice PN order of spin effects
tideO	twice PN order of tidal effects
phaseO	twice post-Newtonian order
lscorr	flag to include spin corrections to orbital angular momentum
phenomtp	flag for using spinO=7 and not spinO=6 terms with orbital-averaged quantities for phenomtphm approx

Definition at line 790 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorT1Setup()

int XLALSimInspiralSpinTaylorT1Setup	(	XLALSimInspiralSpinTaylorTxCoeffs **	params,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	fStart,
		const REAL8	fEnd,
		const REAL8	lambda1,
		const REAL8	lambda2,
		const REAL8	quadparam1,
		const REAL8	quadparam2,
		const LALSimInspiralSpinOrder	spinO,
		const LALSimInspiralTidalOrder	tideO,
		const INT4	phaseO,
		const INT4	lscorr
	)

See arXiv:0907.0700 for TaylorT1 definition.

Parameters

params	OUTPUT
m1_SI	mass of body 1 (kg)
m2_SI	mass of body 2 (kg)
fStart	Starting GW freq. (Hz)
fEnd	Ending GW freq. (Hz), 0 means integrate forwards as far as possible
lambda1	(tidal deformability of mass 1) / (mass of body 1)^5 (dimensionless)
lambda2	(tidal deformability of mass 2) / (mass of body 2)^5 (dimensionless)
quadparam1	phenom. parameter describing induced quad. moment of body 1 (=1 for BHs, ~2-12 for NSs)
quadparam2	phenom. parameter describing induced quad. moment of body 2 (=1 for BHs, ~2-12 for NSs)
spinO	twice PN order of spin effects
tideO	twice PN order of tidal effects
phaseO	twice post-Newtonian order
lscorr	flag to include spin corrections to orbital angular momentum

Definition at line 1007 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorT5Setup()

int XLALSimInspiralSpinTaylorT5Setup	(	XLALSimInspiralSpinTaylorTxCoeffs **	params,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	fStart,
		const REAL8	fEnd,
		const REAL8	lambda1,
		const REAL8	lambda2,
		const REAL8	quadparam1,
		const REAL8	quadparam2,
		const LALSimInspiralSpinOrder	spinO,
		const LALSimInspiralTidalOrder	tideO,
		const INT4	phaseO,
		const INT4	lscorr
	)

See arXiv:1107.1267 for TaylorT5 approximant definition.

It is a variant of TaylorT2 (see arXiv:0907.0700). SpinTaylorT5 as implemented in this code was previously (earlier than June 2019) named SpinTaylorT2.

Parameters

params	OUTPUT
m1_SI	mass of body 1 (kg)
m2_SI	mass of body 2 (kg)
fStart	Starting GW freq. (Hz)
fEnd	Ending GW freq. (Hz), 0 means integrate forwards as far as possible
lambda1	(tidal deformability of mass 1) / (mass of body 1)^5 (dimensionless)
lambda2	(tidal deformability of mass 2) / (mass of body 2)^5 (dimensionless)
quadparam1	phenom. parameter describing induced quad. moment of body 1 (=1 for BHs, ~2-12 for NSs)
quadparam2	phenom. parameter describing induced quad. moment of body 2 (=1 for BHs, ~2-12 for NSs)
spinO	twice PN order of spin effects
tideO	twice PN order of tidal effects
phaseO	twice post-Newtonian order
lscorr	flag to include spin corrections to orbital angular momentum

Definition at line 1214 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSetEnergyPNTermsAvg()

INT4 XLALSimInspiralSetEnergyPNTermsAvg	(	REAL8 *	Espin3,
		REAL8 *	Espin4,
		REAL8 *	Espin5,
		REAL8 *	Espin6,
		REAL8 *	Espin7,
		XLALSimInspiralSpinTaylorTxCoeffs *	params,
		const REAL8	LNhdotS1,
		const REAL8	LNhdotS2,
		const REAL8	S1sq,
		const REAL8	S2sq,
		const REAL8	S1dotS2
	)

Definition at line 2340 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorStoppingTest() [2/2]

static int XLALSimInspiralSpinTaylorStoppingTest	(	double UNUSED	t,
		const double	values[],
		double	dvalues[],
		void *	mparams
	)

static

Definition at line 2428 of file LALSimInspiralSpinTaylor.c.

◆ omegashift()

static REAL8 omegashift	(	REAL8	S1sq,
		REAL8	S2sq,
		REAL8	S1S2,
		REAL8	LNhS1,
		REAL8	LNhS2,
		REAL8	OmS1,
		REAL8	OmS2
	)

static

Definition at line 2516 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorT4DerivativesAvg()

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

Definition at line 2540 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorT1DerivativesAvg() [2/2]

static int XLALSimInspiralSpinTaylorT1DerivativesAvg	(	double UNUSED	t,
		const double	values[],
		double	dvalues[],
		void *	mparams
	)

static

Definition at line 2685 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorT5DerivativesAvg() [2/2]

static int XLALSimInspiralSpinTaylorT5DerivativesAvg	(	double UNUSED	t,
		const double	values[],
		double	dvalues[],
		void *	mparams
	)

static

Definition at line 2840 of file LALSimInspiralSpinTaylor.c.

◆ appendTSandFree()

static REAL8TimeSeries* appendTSandFree	(	REAL8TimeSeries *	start,
		REAL8TimeSeries *	end
	)

static

Definition at line 2978 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorDriver()

int XLALSimInspiralSpinTaylorDriver	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8TimeSeries **	Vout,
		REAL8TimeSeries **	Phiout,
		REAL8TimeSeries **	S1xout,
		REAL8TimeSeries **	S1yout,
		REAL8TimeSeries **	S1zout,
		REAL8TimeSeries **	S2xout,
		REAL8TimeSeries **	S2yout,
		REAL8TimeSeries **	S2zout,
		REAL8TimeSeries **	LNhxout,
		REAL8TimeSeries **	LNhyout,
		REAL8TimeSeries **	LNhzout,
		REAL8TimeSeries **	E1xout,
		REAL8TimeSeries **	E1yout,
		REAL8TimeSeries **	E1zout,
		const REAL8	phiRef,
		const REAL8	deltaT,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	fStart,
		const REAL8	fRef,
		const REAL8	r,
		const REAL8	s1x,
		const REAL8	s1y,
		const REAL8	s1z,
		const REAL8	s2x,
		const REAL8	s2y,
		const REAL8	s2z,
		const REAL8	lnhatx,
		const REAL8	lnhaty,
		const REAL8	lnhatz,
		const REAL8	e1x,
		const REAL8	e1y,
		const REAL8	e1z,
		LALDict *	LALparams,
		const Approximant	approx
	)

Driver function to generate any of SpinTaylorT1/T5/T4 If the output entries are not null the relative variables are returned.

The dictionary LALparams is searched for PNAmplitudeOrder, amplitude PN order, default -1, i.e. maximum order available PNPhaseOrder, phasing PN order, default -1, i.e. maximum order available PNSpinOrder, spin-dependent term maximum order in PN-phasing, default -1, they start at 1.5PN order PNtidalOrder, tidal PN order, default -1, they start at 5PN order (spin-less case only) Lscorr, flag to include spin correction to orbital angular momentum (1), default value 0, i.e. spin corrections not included QuadMon1, value of quadrupole-monopole dimension-less coupling for component 1 diminished by 1, default 0 (BH case in GR) QuadMon2, value of quadrupole-monopole dimension-less coupling for component 2 diminished by 1, default 0 (BH case in GR) Lambda1, value of the dimension-less tidal parameter for component 1, default 0 (BH in GR) Lambda2, value of the dimension-less tidal parameter for component 2, default 0 (BH in GR) FinalFreq, value of the final frequency to integrate to, in Hz OnlyFinal, flag to only output the final values and not output the waveform (1), default value 0, i.e., intermediate values and waveform output To insert a value named "NAME" into the LALDict dictionary use the instruction XLALSimInspiralWaveformParamsInsertNAME(LALparams, value) to read a value named "NAME" from the LALDict dictionary use the instruction XLALSimInspiralWaveformParamsLookupNAME(LALparams, value) NAMEs checked over are

PNAmplitudeOrder
PNPhaseOrder
PNSpinOrder
PNTidalOrder
Lscorr
dQuadMon1
dQuadMon2
TidalLambda1
TidalLambda2
FinalFreq
OnlyFinal Next-to-last version REVIEWED completed on git hash 6640e79e60791d5230731acc63351676ce7ce413

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
Vout	PN parameter v
Phiout	main GW phase
S1xout	spin1 x-component
S1yout	spin1 y-component
S1zout	spin1 z-component
S2xout	spin2 x-component
S2yout	spin2 y-component
S2zout	spin2 z-component
LNhxout	Newtonian L unit vector x-component
LNhyout	Newtonian L unit vector y-component
LNhzout	Newtonian L unit vector <-component
E1xout	x-axis triad unit vector x-component
E1yout	x-axis triad unit vector y-component
E1zout	x-axis triad unit vector z-component
phiRef	orbital phase at reference pt.
deltaT	sampling interval (s)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
fStart	start GW frequency (Hz)
fRef	reference GW frequency (Hz)
r	distance of source (m)
s1x	initial value of S1x
s1y	initial value of S1y
s1z	initial value of S1z
s2x	initial value of S2x
s2y	initial value of S2y
s2z	initial value of S2z
lnhatx	initial value of LNhatx
lnhaty	initial value of LNhaty
lnhatz	initial value of LNhatz
e1x	initial value of E1x
e1y	initial value of E1y
e1z	initial value of E1z
LALparams	LAL dictionary containing accessory parameters
approx	PN approximant (SpinTaylorT1/T5/T4)

Definition at line 3027 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorOrbitalDriver()

int XLALSimInspiralSpinTaylorOrbitalDriver	(	REAL8TimeSeries **	Vout,
		REAL8TimeSeries **	Phiout,
		REAL8TimeSeries **	S1xout,
		REAL8TimeSeries **	S1yout,
		REAL8TimeSeries **	S1zout,
		REAL8TimeSeries **	S2xout,
		REAL8TimeSeries **	S2yout,
		REAL8TimeSeries **	S2zout,
		REAL8TimeSeries **	LNhxout,
		REAL8TimeSeries **	LNhyout,
		REAL8TimeSeries **	LNhzout,
		REAL8TimeSeries **	E1xout,
		REAL8TimeSeries **	E1yout,
		REAL8TimeSeries **	E1zout,
		const REAL8	phiRef,
		const REAL8	deltaT,
		const REAL8	m1_SI,
		const REAL8	m2_SI,
		const REAL8	fStart,
		const REAL8	fRef,
		const REAL8	s1x,
		const REAL8	s1y,
		const REAL8	s1z,
		const REAL8	s2x,
		const REAL8	s2y,
		const REAL8	s2z,
		const REAL8	lnhatx,
		const REAL8	lnhaty,
		const REAL8	lnhatz,
		const REAL8	e1x,
		const REAL8	e1y,
		const REAL8	e1z,
		LALDict *	LALparams,
		const Approximant	approx
	)

Driver function wrapper for XLALSimInspiralSpinTaylorDriver() with the same output except for h+ and hx time series.

Parameters

Vout	PN parameter v
Phiout	main GW phase
S1xout	spin1 x-component
S1yout	spin1 y-component
S1zout	spin1 z-component
S2xout	spin2 x-component
S2yout	spin2 y-component
S2zout	spin2 z-component
LNhxout	Newtonian L unit vector x-component
LNhyout	Newtonian L unit vector y-component
LNhzout	Newtonian L unit vector <-component
E1xout	x-axis triad unit vector x-component
E1yout	x-axis triad unit vector y-component
E1zout	x-axis triad unit vector z-component
phiRef	orbital phase at reference pt.
deltaT	sampling interval (s)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
fStart	start GW frequency (Hz)
fRef	reference GW frequency (Hz)
s1x	initial value of S1x
s1y	initial value of S1y
s1z	initial value of S1z
s2x	initial value of S2x
s2y	initial value of S2y
s2z	initial value of S2z
lnhatx	initial value of LNhatx
lnhaty	initial value of LNhaty
lnhatz	initial value of LNhatz
e1x	initial value of E1x
e1y	initial value of E1y
e1z	initial value of E1z
LALparams	LAL dictionary containing accessory parameters
approx	PN approximant (SpinTaylorT1/T5/T4)

Definition at line 3419 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorHlmModesFromOrbit()

INT4 XLALSimInspiralSpinTaylorHlmModesFromOrbit	(	SphHarmTimeSeries **	hlm,
		REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8TimeSeries *	LNhx,
		REAL8TimeSeries *	LNhy,
		REAL8TimeSeries *	LNhz,
		REAL8TimeSeries *	E1x,
		REAL8TimeSeries *	E1y,
		REAL8TimeSeries *	E1z,
		REAL8TimeSeries *	S1x,
		REAL8TimeSeries *	S1y,
		REAL8TimeSeries *	S1z,
		REAL8TimeSeries *	S2x,
		REAL8TimeSeries *	S2y,
		REAL8TimeSeries *	S2z,
		REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	dist_SI,
		int	ampO,
		LALValue *	modearray
	)

Parameters

hlm	OUTPUT
V	PN parameter v
Phi	orbital phase
LNhx	angular momentum unit vector x component
LNhy	angular momentum unit vector y component
LNhz	angular momentum unit vector z components
E1x	x-axis tetrad x component
E1y	x-axis tetrad y component
E1z	x-axis tetrad z component
S1x	spin1-x component
S1y	spin1-y component
S1z	spin1-z component
S2x	spin2-x component
S2y	spin2-y component
S2z	spin2-z component
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
dist_SI	distance of source (m)
ampO	twice post-Newtonian amp-order
modearray	Container for the ell and m modes to generate. To generate all available modes pass NULL

Definition at line 3463 of file LALSimInspiralSpinTaylor.c.

◆ XLALSimInspiralSpinTaylorHlmModes()

INT4 XLALSimInspiralSpinTaylorHlmModes	(	SphHarmTimeSeries **	hlm,
		REAL8	phiRef,
		REAL8	dT,
		REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	fStart,
		REAL8	fRef,
		REAL8	dist_SI,
		REAL8	s1x,
		REAL8	s1y,
		REAL8	s1z,
		REAL8	s2x,
		REAL8	s2y,
		REAL8	s2z,
		REAL8	lnhatx,
		REAL8	lnhaty,
		REAL8	lnhatz,
		REAL8	e1x,
		REAL8	e1y,
		REAL8	e1z,
		int	ampO,
		LALValue *	modearray,
		LALDict *	LALparams,
		Approximant	approx
	)

Parameters

hlm	OUTPUT
phiRef	orbital phase at reference pt.
dT	sampling interval (s)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
fStart	start GW frequency (Hz)
fRef	reference GW frequency (Hz)
dist_SI	distance of source (m)
s1x	ref value of S1x
s1y	ref value of S1y
s1z	ref value of S1z
s2x	ref value of S2x
s2y	ref value of S2y
s2z	ref value of S2z
lnhatx	ref value of LNhatx
lnhaty	ref value of LNhaty
lnhatz	ref value of LNhatz
e1x	ref value of E1x
e1y	ref value of E1y
e1z	ref value of E1z
ampO	twice post-Newtonian amp-order
modearray	Container for the ell and m modes to generate. To generate all available modes pass NULL
LALparams	LAL dictionary containing accessory parameters
approx	PN approximant (SpinTaylorT1/T2/T4)

Definition at line 3521 of file LALSimInspiralSpinTaylor.c.

Prototypes

Macros

Macro Definition Documentation

◆ XLAL_BEGINGSL

◆ XLAL_ENDGSL

◆ LALSIMINSPIRAL_ST_TEST_ENERGY

◆ LALSIMINSPIRAL_ST_TEST_OMEGADOUBLEDOT

◆ LALSIMINSPIRAL_ST_TEST_COORDINATE

◆ LALSIMINSPIRAL_ST_TEST_OMEGANAN

◆ LALSIMINSPIRAL_ST_TEST_FREQBOUND

◆ LALSIMINSPIRAL_ST_DERIVATIVE_OMEGANONPOS

◆ LALSIMINSPIRAL_ST_TEST_LARGEV

◆ LAL_MAX_PN_ORDER

◆ LAL_NUM_ST4_VARIABLES

◆ LAL_ST4_ABSOLUTE_TOLERANCE

◆ LAL_ST4_RELATIVE_TOLERANCE

◆ ROTATEZ

◆ ROTATEY

Function Documentation

◆ XLALSimInspiralVectorCrossProduct()

◆ cdot()

◆ normsq()

◆ XLALSimInspiralSpinTaylorStoppingTest() [1/2]

◆ XLALSimInspiralSpinTaylorT1DerivativesAvg() [1/2]

◆ XLALSimInspiralSpinTaylorT5DerivativesAvg() [1/2]

◆ XLALSimInspiralSpinTaylorPNEvolveOrbitIrregularIntervals()

◆ XLALSimInspiralSpinTaylorDriverFourier()

◆ appendTAandFree()

◆ removeDuplicates()

◆ XLALSimSpinTaylorEnergySpinDerivativeSetup()

◆ XLALSimInspiralSpinDerivativesAvg()

◆ XLALSimInspiralSpinTaylorT4Setup()

◆ XLALSimInspiralSpinTaylorT1Setup()

◆ XLALSimInspiralSpinTaylorT5Setup()

◆ XLALSimInspiralSetEnergyPNTermsAvg()

◆ XLALSimInspiralSpinTaylorStoppingTest() [2/2]

◆ omegashift()

◆ XLALSimInspiralSpinTaylorT4DerivativesAvg()

◆ XLALSimInspiralSpinTaylorT1DerivativesAvg() [2/2]

◆ XLALSimInspiralSpinTaylorT5DerivativesAvg() [2/2]

◆ appendTSandFree()

◆ XLALSimInspiralSpinTaylorDriver()

◆ XLALSimInspiralSpinTaylorOrbitalDriver()

◆ XLALSimInspiralSpinTaylorHlmModesFromOrbit()

◆ XLALSimInspiralSpinTaylorHlmModes()