Prototypes
static REAL8	PlanckTaper (const REAL8 t, const REAL8 t1, const REAL8 t2)
	Planck taper window. More...

static int	EnforcePrimaryMassIsm1 (REAL8 m1, REAL8 m2, REAL8 lambda1, REAL8 lambda2)
	function to swap masses and lambda to enforce m1 >= m2 More...

static int	EnforcePrimaryMassIsm1_v3 (REAL8 m1, REAL8 m2, REAL8 lambda1, REAL8 lambda2, REAL8 chi1_AS, REAL8 chi2_AS)
	function to swap masses, spins, and lambda to enforce m1 >= m2, This is mainly for NRTidalv3, which has a merger frequency fit that is dependent on the aligned spin component. More...

double	XLALSimNRTunedTidesComputeKappa2T (REAL8 m1_SI, REAL8 m2_SI, REAL8 lambda1, REAL8 lambda2)
	convenient function to compute tidal coupling constant. More...

double	XLALSimNRTunedTidesMergerFrequency (const REAL8 mtot_MSUN, const REAL8 kappa2T, const REAL8 q)
	compute the merger frequency of a BNS system. More...

double	XLALSimNRTunedTidesMergerFrequency_v3 (const REAL8 mtot_MSUN, REAL8 lambda1, REAL8 lambda2, const REAL8 q, REAL8 chi1_AS, REAL8 chi2_AS)
	compute the merger frequency of a BNS system for NRTidalv3 (https://arxiv.org/pdf/2311.07456.pdf). More...

static double	SimNRTunedTidesFDTidalPhase (const REAL8 fHz, const REAL8 Xa, const REAL8 Xb, const REAL8 mtot, const REAL8 kappa2T)
	Internal function only. More...

static REAL8	SimNRTunedTidesFDTidalAmplitude (const REAL8 fHz, const REAL8 mtot, const REAL8 kappa2T)
	Tidal amplitude corrections; only available for NRTidalv2; Eq 24 of arxiv:1905.06011. More...

int	XLALSimNRTunedTidesSetFDTidalPhase_v2_Coeffs (REAL8 *NRTidalv2_coeffs)
	Set the NRTidalv2 phase coefficients in an array for use here and in the IMRPhenomX*_NRTidalv2 implementation. More...

static double	SimNRTunedTidesFDTidalPhase_v2 (const REAL8 fHz, const REAL8 Xa, const REAL8 Xb, const REAL8 mtot, const REAL8 kappa2T)
	NRTunedTidesFDTidalPhase is Eq 22 of https://arxiv.org/abs/1905.06011 and is a function of x = angular_orb_freq^(2/3) More...

int	XLALSimNRTunedTidesSetFDTidalPhase_PN_Coeffs (REAL8 *PN_coeffs, const REAL8 Xa)
	Coefficients or the PN tidal phase correction, at 7.5PN, to connect with NRTidalv3 Phase post-merger, see Eq. More...

int	XLALSimNRTunedTidesSetFDTidalPhase_v3_Coeffs (REAL8 *NRTidalv3_coeffs, const REAL8 Xa, const REAL8 mtot, const REAL8 lambda1, const REAL8 lambda2, const REAL8 PN_coeffs[10])
	Set the NRTidalv3 effective love number and phase coefficients in an array for use here and in the IMRPhenomX*_NRTidalv3 implementation. More...

static double	SimNRTunedTidesFDTidalPhase_v3 (const REAL8 fHz, const REAL8 mtot, const REAL8 NRTidalv3_coeffs[20], const REAL8 PN_coeffs[10])
	Tidal phase correction for NRTidalv3, Eq. More...

static double	SimNRTunedTidesFDTidalPhase_PN (const REAL8 fHz, const REAL8 Xa, const REAL8 mtot, const REAL8 lambda1, const REAL8 lambda2, const REAL8 PN_coeffs[10])
	PN tidal phase correction, at 7.5PN, to connect with NRTidalv3 Phase post-merger, see Eq. More...

int	XLALSimNRTunedTidesFDTidalAmplitudeFrequencySeries (const REAL8Sequence amp_tidal, const REAL8Sequence fHz, REAL8 m1, REAL8 m2, REAL8 lambda1, REAL8 lambda2)
	Function to call amplitude tidal series only; done for convenience to use for PhenomD_NRTidalv2 and SEOBNRv4_ROM_NRTidalv2. More...

int	XLALSimNRTunedTidesFDTidalPhaseFrequencySeries (const REAL8Sequence phi_tidal, const REAL8Sequence amp_tidal, const REAL8Sequence planck_taper, const REAL8Sequence fHz, REAL8 m1_SI, REAL8 m2_SI, REAL8 lambda1, REAL8 lambda2, REAL8 chi1_AS, REAL8 chi2_AS, NRTidal_version_type NRTidal_version)
	Function to call the frequency domain tidal correction over an array of input frequencies. More...

void	XLALSimInspiralGetHOSpinTerms (REAL8 SS_3p5PN, REAL8 SSS_3p5PN, REAL8 X_A, REAL8 X_B, REAL8 chi1, REAL8 chi2, REAL8 quadparam1, REAL8 quadparam2)
	Function to add 3.5PN spin-squared and 3.5PN spin-cubed terms. More...

Function Documentation

◆ PlanckTaper()

static REAL8 PlanckTaper	(	const REAL8	t,
		const REAL8	t1,
		const REAL8	t2
	)

static

Planck taper window.

Definition at line 44 of file LALSimNRTunedTides.c.

◆ EnforcePrimaryMassIsm1()

static int EnforcePrimaryMassIsm1	(	REAL8 *	m1,
		REAL8 *	m2,
		REAL8 *	lambda1,
		REAL8 *	lambda2
	)

static

function to swap masses and lambda to enforce m1 >= m2

Definition at line 59 of file LALSimNRTunedTides.c.

◆ EnforcePrimaryMassIsm1_v3()

static int EnforcePrimaryMassIsm1_v3	(	REAL8 *	m1,
		REAL8 *	m2,
		REAL8 *	lambda1,
		REAL8 *	lambda2,
		REAL8 *	chi1_AS,
		REAL8 *	chi2_AS
	)

static

function to swap masses, spins, and lambda to enforce m1 >= m2, This is mainly for NRTidalv3, which has a merger frequency fit that is dependent on the aligned spin component.

See Eq. (41) in https://arxiv.org/pdf/2311.07456.pdf.

Definition at line 93 of file LALSimNRTunedTides.c.

◆ XLALSimNRTunedTidesComputeKappa2T()

double XLALSimNRTunedTidesComputeKappa2T	(	REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	lambda1,
		REAL8	lambda2
	)

convenient function to compute tidal coupling constant.

Eq. 2 in arXiv:1706.02969 given masses and lambda numbers

Parameters

m1_SI	Mass of companion 1 (kg)
m2_SI	Mass of companion 2 (kg)
lambda1	(tidal deformability of mass 1) / m1^5 (dimensionless)
lambda2	(tidal deformability of mass 2) / m2^5 (dimensionless)

Definition at line 133 of file LALSimNRTunedTides.c.

◆ XLALSimNRTunedTidesMergerFrequency()

double XLALSimNRTunedTidesMergerFrequency	(	const REAL8	mtot_MSUN,
		const REAL8	kappa2T,
		const REAL8	q
	)

compute the merger frequency of a BNS system.

Tim's new fit that incorporates mass-ratio and asymptotes to zero for large kappa2T.

Parameters

mtot_MSUN	total mass of system (solar masses)
kappa2T	tidal coupling constant. Eq. 2 in arXiv:1706.02969
q	mass-ratio q >= 1

Definition at line 168 of file LALSimNRTunedTides.c.

◆ XLALSimNRTunedTidesMergerFrequency_v3()

double XLALSimNRTunedTidesMergerFrequency_v3	(	const REAL8	mtot_MSUN,
		REAL8	lambda1,
		REAL8	lambda2,
		const REAL8	q,
		REAL8	chi1_AS,
		REAL8	chi2_AS
	)

compute the merger frequency of a BNS system for NRTidalv3 (https://arxiv.org/pdf/2311.07456.pdf).

This uses a new fit from Gonzalez, et. al (2022); Eq. (23) of https://arxiv.org/abs/2210.16366.

< This was not written in 2311.07456, but can be found in Table 2 of 2210.16366.

Parameters

mtot_MSUN	total mass of system (solar masses)
lambda1	dimensionless tidal deformability of star 1
lambda2	dimensionless tidal deformability of star 2
q	mass ratio q>=1
chi1_AS	aligned spin component of star 1
chi2_AS	aligned spin component of star 2

Definition at line 209 of file LALSimNRTunedTides.c.

◆ SimNRTunedTidesFDTidalPhase()

static double SimNRTunedTidesFDTidalPhase	(	const REAL8	fHz,
		const REAL8	Xa,
		const REAL8	Xb,
		const REAL8	mtot,
		const REAL8	kappa2T
	)

static

Internal function only.

Function to call the frequency domain tidal correction. Equation (7) in arXiv:1706.02969

Parameters

fHz	Gravitational wave frequency (Hz)
Xa	Mass of companion 1 divided by total mass
Xb	Mass of companion 2 divided by total mass
mtot	total mass (Msun)
kappa2T	tidal coupling constant. Eq. 2 in arXiv:1706.02969

Definition at line 299 of file LALSimNRTunedTides.c.

◆ SimNRTunedTidesFDTidalAmplitude()

static REAL8 SimNRTunedTidesFDTidalAmplitude	(	const REAL8	fHz,
		const REAL8	mtot,
		const REAL8	kappa2T
	)

static

Tidal amplitude corrections; only available for NRTidalv2; Eq 24 of arxiv:1905.06011.

Parameters

fHz	Gravitational wave frequency (Hz)
mtot	Total mass in solar masses
kappa2T	tidal coupling constant. Eq. 2 in arXiv:1706.02969

Definition at line 344 of file LALSimNRTunedTides.c.

◆ XLALSimNRTunedTidesSetFDTidalPhase_v2_Coeffs()

int XLALSimNRTunedTidesSetFDTidalPhase_v2_Coeffs ( REAL8 * NRTidalv2_coeffs )

Set the NRTidalv2 phase coefficients in an array for use here and in the IMRPhenomX*_NRTidalv2 implementation.

Definition at line 371 of file LALSimNRTunedTides.c.

◆ SimNRTunedTidesFDTidalPhase_v2()

static double SimNRTunedTidesFDTidalPhase_v2	(	const REAL8	fHz,
		const REAL8	Xa,
		const REAL8	Xb,
		const REAL8	mtot,
		const REAL8	kappa2T
	)

static

NRTunedTidesFDTidalPhase is Eq 22 of https://arxiv.org/abs/1905.06011 and is a function of x = angular_orb_freq^(2/3)

Parameters

fHz	Gravitational wave frequency (Hz)
Xa	Mass of companion 1 divided by total mass
Xb	Mass of companion 2 divided by total mass
mtot	total mass (Msun)
kappa2T	tidal coupling constant. Eq. 2 in arXiv:1706.02969

Definition at line 390 of file LALSimNRTunedTides.c.

◆ XLALSimNRTunedTidesSetFDTidalPhase_PN_Coeffs()

int XLALSimNRTunedTidesSetFDTidalPhase_PN_Coeffs	(	REAL8 *	PN_coeffs,
		const REAL8	Xa
	)

Coefficients or the PN tidal phase correction, at 7.5PN, to connect with NRTidalv3 Phase post-merger, see Eq.

(45) of https://arxiv.org/pdf/2311.07456.pdf

Parameters

PN_coeffs	PN coefficients
Xa	Mass of companion 1 divided by total mass

Definition at line 433 of file LALSimNRTunedTides.c.

◆ XLALSimNRTunedTidesSetFDTidalPhase_v3_Coeffs()

int XLALSimNRTunedTidesSetFDTidalPhase_v3_Coeffs	(	REAL8 *	NRTidalv3_coeffs,
		const REAL8	Xa,
		const REAL8	mtot,
		const REAL8	lambda1,
		const REAL8	lambda2,
		const REAL8	PN_coeffs[10]
	)

Set the NRTidalv3 effective love number and phase coefficients in an array for use here and in the IMRPhenomX*_NRTidalv3 implementation.

Parameters

NRTidalv3_coeffs	output of NRTidalv3 parameters to be used in computing the tidal phase corrections
Xa	Mass of companion 1 divided by total mass
mtot	total mass (Msun)
lambda1	dimensionless tidal deformability of companion 1
lambda2	dimensionless tidal deformability of companion 2
PN_coeffs	7.5 PN coefficients to be used for constraints

Definition at line 470 of file LALSimNRTunedTides.c.

◆ SimNRTunedTidesFDTidalPhase_v3()

static double SimNRTunedTidesFDTidalPhase_v3	(	const REAL8	fHz,
		const REAL8	mtot,
		const REAL8	NRTidalv3_coeffs[20],
		const REAL8	PN_coeffs[10]
	)

static

Tidal phase correction for NRTidalv3, Eq.

(27,30), from Abac, et. al. (2023) (https://arxiv.org/pdf/2311.07456.pdf) and is a function of x = angular_orb_freq^(2./3.)

Parameters

fHz	Gravitational wave frequency (Hz)
mtot	total mass (Msun)
NRTidalv3_coeffs	NRTidalv3 coefficients
PN_coeffs	7.5 PN coefficients to be used as constraints

Definition at line 573 of file LALSimNRTunedTides.c.

◆ SimNRTunedTidesFDTidalPhase_PN()

static double SimNRTunedTidesFDTidalPhase_PN	(	const REAL8	fHz,
		const REAL8	Xa,
		const REAL8	mtot,
		const REAL8	lambda1,
		const REAL8	lambda2,
		const REAL8	PN_coeffs[10]
	)

static

PN tidal phase correction, at 7.5PN, to connect with NRTidalv3 Phase post-merger, see Eq.

(22) and (45) of https://arxiv.org/pdf/2311.07456.pdf and is a function of x = angular_orb_freq^(2./3.)

Parameters

fHz	Gravitational wave frequency (Hz)
Xa	Mass of companion 1 divided by total mass
mtot	total mass (Msun)
lambda1	dimensionless tidal deformability of companion 1
lambda2	dimensionless tidal deformability of companion 2
PN_coeffs	7.5 PN coefficients

Definition at line 655 of file LALSimNRTunedTides.c.

◆ XLALSimNRTunedTidesFDTidalAmplitudeFrequencySeries()

int XLALSimNRTunedTidesFDTidalAmplitudeFrequencySeries	(	const REAL8Sequence *	amp_tidal,
		const REAL8Sequence *	fHz,
		REAL8	m1,
		REAL8	m2,
		REAL8	lambda1,
		REAL8	lambda2
	)

Function to call amplitude tidal series only; done for convenience to use for PhenomD_NRTidalv2 and SEOBNRv4_ROM_NRTidalv2.

Parameters

[out]	amp_tidal	tidal amplitude frequency series
	fHz	list of input Gravitational wave Frequency [Hz or dimensionless]
	m1	Mass of companion 1 in solar masses
	m2	Mass of companion 2 in solar masses
	lambda1	(tidal deformability of mass 1) / m1^5 (dimensionless)
	lambda2	(tidal deformability of mass 2) / m2^5 (dimensionless)

Definition at line 705 of file LALSimNRTunedTides.c.

◆ XLALSimNRTunedTidesFDTidalPhaseFrequencySeries()

int XLALSimNRTunedTidesFDTidalPhaseFrequencySeries	(	const REAL8Sequence *	phi_tidal,
		const REAL8Sequence *	amp_tidal,
		const REAL8Sequence *	planck_taper,
		const REAL8Sequence *	fHz,
		REAL8	m1_SI,
		REAL8	m2_SI,
		REAL8	lambda1,
		REAL8	lambda2,
		REAL8	chi1_AS,
		REAL8	chi2_AS,
		NRTidal_version_type	NRTidal_version
	)

Function to call the frequency domain tidal correction over an array of input frequencies.

This is Equation (7) in arXiv:1706.02969 when NRTidal_version is NRTidal_V, or Equations (17)-(21) (for phasing) and Equation (24) (for amplitude) in arXiv:1905.06011 when NRTidal_version is NRTidalv2_V, or Equations (17)-(21) in arXiv:1905.06011 when NRTidal_version is NRTidalv2NoAmpCorr_V. NoNRT_V specifies NO tidal phasing or amplitude is being added. Note internally we use m1>=m2 - this is enforced in the code. So any can be supplied

The model for the tidal phase correction in NRTidal_V/NRTidalv2_V was calibrated up to mass-ratio q=1.5 and kappa2T in [40, 5000]. The upper kappa2T limit is reached roughly for a 1.4+1.4 BNS with lambda = 2700 on both NSs. In the high mass-ratio limit, the BNS merger frequency defined in XLALSimNRTunedTidesMergerFrequency() asymptotes to zero. The waveform amplitude should be tapered away starting at this frequency. Therefore, no explicit limits are enforced.

We also include here NRTidalv3_V, which was calibrated up to mass ratio q = 2.0 and kappa2T in [40, 5000]. The NRTidalv3 tidal phase is connected to the 7.5PN tidal phase to minimize the presence of asymptotes post-merger.

Parameters

[out]	phi_tidal	tidal phase frequency series
[out]	amp_tidal	tidal amplitude frequency series
[out]	planck_taper	planck tapering to be applied on overall signal
	fHz	list of input Gravitational wave Frequency in Hz to evaluate
	m1_SI	Mass of companion 1 (kg)
	m2_SI	Mass of companion 2 (kg)
	lambda1	(tidal deformability of mass 1) / m1^5 (dimensionless)
	lambda2	(tidal deformability of mass 2) / m2^5 (dimensionless)
	chi1_AS	aligned-spin component of mass 1
	chi2_AS	aligned-spin component of mass 2
	NRTidal_version	< one of NRTidal_V, NRTidalv2_V, NRTidalv3_V, NRTidalv3NoAmpCorr_V, NRTidalv2NoAmpCorr_V or NoNRT_V

Definition at line 770 of file LALSimNRTunedTides.c.

◆ XLALSimInspiralGetHOSpinTerms()

void XLALSimInspiralGetHOSpinTerms	(	REAL8 *	SS_3p5PN,
		REAL8 *	SSS_3p5PN,
		REAL8	X_A,
		REAL8	X_B,
		REAL8	chi1,
		REAL8	chi2,
		REAL8	quadparam1,
		REAL8	quadparam2
	)

Function to add 3.5PN spin-squared and 3.5PN spin-cubed terms.

The spin-squared terms occur with the spin-induced quadrupole moment terms while the spin-cubed terms occur with both spin-induced quadrupole as well as octupole moments. The terms are computed in arXiv:1806.01772 and are explicitly written out in Eq 27 of arXiv:1905.06011. The following terms are specifically meant for BNS systems, and are added to the NRTidalv2 extensions of the approximants IMRPhenomPv2, IMRPhenomD and SEOBNRv4_ROM.

Parameters

SS_3p5PN	3.5PN spin-spin tail term containing spin-induced quadrupole moment
SSS_3p5PN	3.5 PN spin cubed term containing spin-induced octupole moment
X_A	Mass fraction m_1/M for first component of binary
X_B	Mass fraction m_2/M for second component of binary
chi1	Aligned component of spin vector of first component of binary
chi2	Aligned component of spin vector of second component of binary
quadparam1	Spin-induced quadrupole moment parameter for component 1
quadparam2	Spin-induced quadrupole moment parameter for component 2

Definition at line 912 of file LALSimNRTunedTides.c.

Prototypes

Function Documentation

◆ PlanckTaper()

◆ EnforcePrimaryMassIsm1()

◆ EnforcePrimaryMassIsm1_v3()

◆ XLALSimNRTunedTidesComputeKappa2T()

◆ XLALSimNRTunedTidesMergerFrequency()

◆ XLALSimNRTunedTidesMergerFrequency_v3()

◆ SimNRTunedTidesFDTidalPhase()

◆ SimNRTunedTidesFDTidalAmplitude()

◆ XLALSimNRTunedTidesSetFDTidalPhase_v2_Coeffs()

◆ SimNRTunedTidesFDTidalPhase_v2()

◆ XLALSimNRTunedTidesSetFDTidalPhase_PN_Coeffs()

◆ XLALSimNRTunedTidesSetFDTidalPhase_v3_Coeffs()

◆ SimNRTunedTidesFDTidalPhase_v3()

◆ SimNRTunedTidesFDTidalPhase_PN()

◆ XLALSimNRTunedTidesFDTidalAmplitudeFrequencySeries()

◆ XLALSimNRTunedTidesFDTidalPhaseFrequencySeries()

◆ XLALSimInspiralGetHOSpinTerms()