Prototypes
static UNUSED int	InitializeSystem (sysq *system, const double m1, const double m2, const double mul, const double phl, const double mu1, const double ph1, const double ch1, const double mu2, const double ph2, const double ch2, const double f_0, const int ExpansionOrder)
	InitializeSystem computes all the prefactors needed to generate precession angles from Chatziioannou et al., arXiv 1703.03967 [gr-qc]. More...

static UNUSED vector	compute_phiz_zeta_costhetaL3PN (const double xi, const sysq *system)
	Internal function that computes phiz, zeta, and costhetaL at 3PN. More...

static UNUSED vector	compute_phiz_zeta_costhetaL2PNNonSpinning (const double xi, const sysq *system)
	Internal function that computes phiz, zeta, and costhetaL at 2PN NonSpinning. More...

static UNUSED vector	compute_phiz_zeta_costhetaL (const double xi, const sysq *system)
	Internal function that computes phiz, zeta, and costhetaL at Newtonian order. More...

static vector	Roots (const double L_norm, const double J_norm, const sysq *system)
	Internal function that computes the roots of Eq. More...

static vector	BCDcoeff (const double L_norm, const double J_norm, const sysq *system)
	Internal function that computes the B,C,D coefficients of Eq. More...

static double	J_norm_of_xi (const double L_norm, const sysq *system)
	Internal function that returns the magnitude of J to Newtonian order Equation 41 (1703.03967) More...

static double	S_norm_of_xi (const double xi, const double xi_2, const vector roots, const sysq *system)
	Internal function that returns the magnitude of S divided by GMsquare_over_c Equation 23 (1703.03967) More...

static double	L_norm_2PN_NonSpinning_of_xi (const double xi_2, const double L_norm, const sysq *system)
	Internal function that returns the magnitude of L divided by GMsquare_over_c to 2PN order, non-spinning terms from 0605140 and Blanchet LRR and 1212.5520 Eq. More...

static double	L_norm_3PN_of_xi (const double xi, const double xi_2, const double L_norm, const sysq *system)
	Internal function that returns the magnitude of L divided by GMsquare_over_c to 3PN order from 0605140 and Blanchet LRR and 1212.5520 Eq. More...

static vector	c (const double xi, const double xi_2, const double J_norm, const vector roots, const sysq *system)
	Internal function that returns the coefficients "c_0", "c_2" and "c_4" from 1703.03967 corresponding to equations B6, B7 and B8 in 1703.03967 respectively out.x = c_0 out.y = c_2 out.z = c_4. More...

static vector	d (const double L_norm, const double J_norm, const vector roots)
	Internal function that returns the coefficients "d_0", "d_2" and "d_4" from 1703.03967 corresponding to equations B9, B10 and B11 in 1703.03967 respectively out.x = d_0 out.y = d_2 out.z = d_4. More...

static double	costhetaL (const double J_norm, const double L_norm, const double S_norm)
	Internal function that returns the cosine of the angle between L and J equation 8 1703.03967. More...

static double	u_of_xi (const double xi, const double xi_2, const sysq *system)
	Internal function that returns the phase of the magnitude of S given by equation 51 in arxiv:1703.03967. More...

static double	psidot (const double xi, const double xi_2, const vector roots, const sysq *system)
	Internal function that returns the derivative of the phase of the magnitude of S given by equation 24 in arxiv:1703.03967. More...

static double	phiz_of_xi (const double xi, const double xi_2, const double J_norm, const sysq *system)
	Internal function that returns phiz equation 66 in 1703.03967. More...

static double	zeta_of_xi (const double xi, const double xi_2, const sysq *system)
	Internal function that returns zeta eq. More...

static vector	computeMScorrections (const double xi, const double xi_2, const double L_norm, const double J_norm, const vector roots, const sysq *system)
	Internal function that computes the MS corrections for phiz and zeta eq. More...

static double	beta (const double a, const double b, const sysq *system)
	Internal function that computes the spin-orbit couplings. More...

static double	sigma (const double a, const double b, const sysq *system)
	Internal function that computes the spin-spin couplings. More...

static double	tau (const double a, const double b, const sysq *system)
	Internal function that computes the spin-spin couplings. More...

static double	DotProd (const vector vec1, const vector vec2)
	Internal function that returns the dot product of two vectors. More...

static double	Norm (const vector vec)
	Internal function that returns the norm of a vector. More...

static vector	CreateSphere (const double r, const double th, const double ph)
	Internal function that calculates a vector fro its spherical components. More...

static vector	ScalarProd (double c, vector vec)
	Internal function that returns the scalar product of a vector with a scalar. More...

static vector	Sum (vector vec1, vector vec2)
	Internal function that returns the sum of two vectors. More...

static vector	CrossProd (vector vec1, vector vec2)
	Internal function that returns the cross product of two vectors. More...

Function Documentation

◆ InitializeSystem()

static UNUSED int InitializeSystem	(	sysq *	system,
		const double	m1,
		const double	m2,
		const double	mul,
		const double	phl,
		const double	mu1,
		const double	ph1,
		const double	ch1,
		const double	mu2,
		const double	ph2,
		const double	ch2,
		const double	f_0,
		const int	ExpansionOrder
	)

static

InitializeSystem computes all the prefactors needed to generate precession angles from Chatziioannou et al., arXiv 1703.03967 [gr-qc].

Parameters

[out]	system	Pointer to sysq struct
	m1	Primary mass in SI (kg)
	m2	Secondary mass in SI (kg)
	mul	Cosine of Polar angle of orbital angular momentum
	phl	Azimuthal angle of orbital angular momentum
	mu1	Cosine of Polar angle of primary spin w.r.t. orbital angular momentum
	ph1	Azimuthal angle of primary spin
	ch1	Dimensionless spin magnitude of primary spin
	mu2	Cosine of Polar angle of secondary spin w.r.t. orbital angular momentum
	ph2	Azimuthal angle of secondary spin
	ch2	Dimensionless spin magnitude of secondary spin
	f_0	Reference Gravitational Wave frequency (Hz)
	ExpansionOrder	Keep terms upto ExpansionOrder in precession angles phi_z and zeta (1,2,3,4,5 or -1 for all orders)

Definition at line 28 of file LALSimInspiralFDPrecAngles_internals.c.

◆ compute_phiz_zeta_costhetaL3PN()

static UNUSED vector compute_phiz_zeta_costhetaL3PN	(	const double	xi,
		const sysq *	system
	)

static

Internal function that computes phiz, zeta, and costhetaL at 3PN.

Definition at line 365 of file LALSimInspiralFDPrecAngles_internals.c.

◆ compute_phiz_zeta_costhetaL2PNNonSpinning()

static UNUSED vector compute_phiz_zeta_costhetaL2PNNonSpinning	(	const double	xi,
		const sysq *	system
	)

static

Internal function that computes phiz, zeta, and costhetaL at 2PN NonSpinning.

Definition at line 391 of file LALSimInspiralFDPrecAngles_internals.c.

◆ compute_phiz_zeta_costhetaL()

static UNUSED vector compute_phiz_zeta_costhetaL	(	const double	xi,
		const sysq *	system
	)

static

Internal function that computes phiz, zeta, and costhetaL at Newtonian order.

Definition at line 418 of file LALSimInspiralFDPrecAngles_internals.c.

◆ Roots()

static vector Roots	(	const double	L_norm,
		const double	J_norm,
		const sysq *	system
	)

static

Internal function that computes the roots of Eq.

22 in arxiv:1703.03967 out.x = A1 = S_{3}^2 out.y = A2 = S_{-}^2 out.z = A3 = S_{+}^2

Definition at line 445 of file LALSimInspiralFDPrecAngles_internals.c.

◆ BCDcoeff()

static vector BCDcoeff	(	const double	L_norm,
		const double	J_norm,
		const sysq *	system
	)

static

Internal function that computes the B,C,D coefficients of Eq.

21 in arxiv:1703.03967 The expressions are given in Appendix B. B coefficient = eq. B2 C coefficient = eq. B3 D coefficient = eq. B4

Definition at line 503 of file LALSimInspiralFDPrecAngles_internals.c.

◆ J_norm_of_xi()

static double J_norm_of_xi	(	const double	L_norm,
		const sysq *	system
	)

static

Internal function that returns the magnitude of J to Newtonian order Equation 41 (1703.03967)

Definition at line 522 of file LALSimInspiralFDPrecAngles_internals.c.

◆ S_norm_of_xi()

static double S_norm_of_xi	(	const double	xi,
		const double	xi_2,
		const vector	roots,
		const sysq *	system
	)

static

Internal function that returns the magnitude of S divided by GMsquare_over_c Equation 23 (1703.03967)

Definition at line 531 of file LALSimInspiralFDPrecAngles_internals.c.

◆ L_norm_2PN_NonSpinning_of_xi()

static double L_norm_2PN_NonSpinning_of_xi	(	const double	xi_2,
		const double	L_norm,
		const sysq *	system
	)

static

Internal function that returns the magnitude of L divided by GMsquare_over_c to 2PN order, non-spinning terms from 0605140 and Blanchet LRR and 1212.5520 Eq.

4.7

Definition at line 550 of file LALSimInspiralFDPrecAngles_internals.c.

◆ L_norm_3PN_of_xi()

static double L_norm_3PN_of_xi	(	const double	xi,
		const double	xi_2,
		const double	L_norm,
		const sysq *	system
	)

static

Internal function that returns the magnitude of L divided by GMsquare_over_c to 3PN order from 0605140 and Blanchet LRR and 1212.5520 Eq.

4.7

Definition at line 564 of file LALSimInspiralFDPrecAngles_internals.c.

◆ c()

static vector c	(	const double	xi,
		const double	xi_2,
		const double	J_norm,
		const vector	roots,
		const sysq *	system
	)

static

Internal function that returns the coefficients "c_0", "c_2" and "c_4" from 1703.03967 corresponding to equations B6, B7 and B8 in 1703.03967 respectively out.x = c_0 out.y = c_2 out.z = c_4.

Definition at line 578 of file LALSimInspiralFDPrecAngles_internals.c.

◆ d()

static vector d	(	const double	L_norm,
		const double	J_norm,
		const vector	roots
	)

static

Internal function that returns the coefficients "d_0", "d_2" and "d_4" from 1703.03967 corresponding to equations B9, B10 and B11 in 1703.03967 respectively out.x = d_0 out.y = d_2 out.z = d_4.

Definition at line 604 of file LALSimInspiralFDPrecAngles_internals.c.

◆ costhetaL()

static double costhetaL	(	const double	J_norm,
		const double	L_norm,
		const double	S_norm
	)

static

Internal function that returns the cosine of the angle between L and J equation 8 1703.03967.

Definition at line 619 of file LALSimInspiralFDPrecAngles_internals.c.

◆ u_of_xi()

static double u_of_xi	(	const double	xi,
		const double	xi_2,
		const sysq *	system
	)

static

Internal function that returns the phase of the magnitude of S given by equation 51 in arxiv:1703.03967.

Definition at line 633 of file LALSimInspiralFDPrecAngles_internals.c.

◆ psidot()

static double psidot	(	const double	xi,
		const double	xi_2,
		const vector	roots,
		const sysq *	system
	)

static

Internal function that returns the derivative of the phase of the magnitude of S given by equation 24 in arxiv:1703.03967.

Definition at line 653 of file LALSimInspiralFDPrecAngles_internals.c.

◆ phiz_of_xi()

static double phiz_of_xi	(	const double	xi,
		const double	xi_2,
		const double	J_norm,
		const sysq *	system
	)

static

Internal function that returns phiz equation 66 in 1703.03967.

Definition at line 679 of file LALSimInspiralFDPrecAngles_internals.c.

◆ zeta_of_xi()

static double zeta_of_xi	(	const double	xi,
		const double	xi_2,
		const sysq *	system
	)

static

Internal function that returns zeta eq.

F5 in 1703.03967

Definition at line 712 of file LALSimInspiralFDPrecAngles_internals.c.

◆ computeMScorrections()

static vector computeMScorrections	(	const double	xi,
		const double	xi_2,
		const double	L_norm,
		const double	J_norm,
		const vector	roots,
		const sysq *	system
	)

static

Internal function that computes the MS corrections for phiz and zeta eq.

67 (for phiz) and F19 (for zeta)

Definition at line 728 of file LALSimInspiralFDPrecAngles_internals.c.

◆ beta()

static double beta	(	const double	a,
		const double	b,
		const sysq *	system
	)

static

Internal function that computes the spin-orbit couplings.

Definition at line 798 of file LALSimInspiralFDPrecAngles_internals.c.

◆ sigma()

static double sigma	(	const double	a,
		const double	b,
		const sysq *	system
	)

static

Internal function that computes the spin-spin couplings.

Definition at line 806 of file LALSimInspiralFDPrecAngles_internals.c.

◆ tau()

static double tau	(	const double	a,
		const double	b,
		const sysq *	system
	)

static

Internal function that computes the spin-spin couplings.

Definition at line 814 of file LALSimInspiralFDPrecAngles_internals.c.

◆ DotProd()

static double DotProd	(	const vector	vec1,
		const vector	vec2
	)

static

Internal function that returns the dot product of two vectors.

Definition at line 822 of file LALSimInspiralFDPrecAngles_internals.c.

◆ Norm()

static double Norm ( const vector vec )

static

Internal function that returns the norm of a vector.

Definition at line 831 of file LALSimInspiralFDPrecAngles_internals.c.

◆ CreateSphere()

static vector CreateSphere	(	const double	r,
		const double	th,
		const double	ph
	)

static

Internal function that calculates a vector fro its spherical components.

Definition at line 840 of file LALSimInspiralFDPrecAngles_internals.c.

◆ ScalarProd()

static vector ScalarProd	(	double	c,
		vector	vec
	)

static

Internal function that returns the scalar product of a vector with a scalar.

Definition at line 854 of file LALSimInspiralFDPrecAngles_internals.c.

◆ Sum()

static vector Sum	(	vector	vec1,
		vector	vec2
	)

static

Internal function that returns the sum of two vectors.

Definition at line 867 of file LALSimInspiralFDPrecAngles_internals.c.

◆ CrossProd()

static vector CrossProd	(	vector	vec1,
		vector	vec2
	)

static

Internal function that returns the cross product of two vectors.

Definition at line 880 of file LALSimInspiralFDPrecAngles_internals.c.

Prototypes

Function Documentation

◆ InitializeSystem()

◆ compute_phiz_zeta_costhetaL3PN()

◆ compute_phiz_zeta_costhetaL2PNNonSpinning()

◆ compute_phiz_zeta_costhetaL()

◆ Roots()

◆ BCDcoeff()

◆ J_norm_of_xi()

◆ S_norm_of_xi()

◆ L_norm_2PN_NonSpinning_of_xi()

◆ L_norm_3PN_of_xi()

◆ c()

◆ d()

◆ costhetaL()

◆ u_of_xi()

◆ psidot()

◆ phiz_of_xi()

◆ zeta_of_xi()

◆ computeMScorrections()

◆ beta()

◆ sigma()

◆ tau()

◆ DotProd()

◆ Norm()

◆ CreateSphere()

◆ ScalarProd()

◆ Sum()

◆ CrossProd()