Detailed Description

C code for utility routines for IMRPhenomNSBH phenomenological waveform model.

Utility routines for IMR Phenomenological Model "NSBH"
Author Jonathan Thompson, Edward Fauchon-Jones, Sebastian Khan
double	XLALSimIMRPhenomNSBH_x_D (const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi)
	Convenience function for expression appearing in disruptive merger. More...

double	XLALSimIMRPhenomNSBH_epsilon_ins_with_torus_mass (const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi)
	Correction to the inspiral transition frequency with spin contributions. More...

double	XLALSimIMRPhenomNSBH_x_D_prime (const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi)
	Convinience function for expression appearing in disruptive merger. More...

double	XLALSimIMRPhenomNSBH_sigma_tide_with_torus_mass (const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi)
	Correction to ringdown Lorentzian width for disruptive mergers. More...

double	XLALSimIMRPhenomNSBH_epsilon_tide_ND (const REAL8 x_ND)
	PhenomC parameter delta_1 NSBH correction factor. More...

double	XLALSimIMRPhenomNSBH_sigma_tide_ND (const REAL8 x_ND_prime)
	Correction to ringdown Lorentzian width for nondisruptive mergers. More...

double	XLALSimIMRPhenomNSBH_x_ND (const REAL8 f_tide, const REAL8 f_RD_tilde, const REAL8 C, const REAL8 chi)
	Convinience function for expression appearing in disruptive merger. More...

double	XLALSimIMRPhenomNSBH_x_ND_prime (const REAL8 f_tide, const REAL8 f_RD_tilde, const REAL8 C, const REAL8 chi)
	Convinience function for expression appearing in disruptive merger. More...

double	XLALSimIMRPhenomNSBH_delta2_prime (const REAL8 f_tide, const REAL8 f_RD_tilde)
	Fitted coefficient for PhenomC Lorentzian. More...

double	XLALSimIMRPhenomNSBH_window_plus (const REAL8 f, const REAL8 f0, const REAL8 d)
	Hyperbolic tangent sigmoid function. More...

double	XLALSimIMRPhenomNSBH_window_minus (const REAL8 f, const REAL8 f0, const REAL8 d)
	Hyperbolic tangent sigmoid function. More...

double	XLALSimIMRPhenomNSBH_eta_from_q (const REAL8 q)
	Convenience function to calculate symmetric mass ratio from q. More...

double	XLALSimIMRPhenomNSBH_baryonic_mass_from_C (const REAL8 C, const REAL8 Mg)
	NS baryonic mass as a function of NS gravitational mass. More...

COMPLEX16	XLALSimIMRPhenomNSBH_omega_tilde (const REAL8 a)
	220 quasi-normal mode dimensionless frequency More...

int	XLALSimIMRPhenomNSBHProperties (REAL8 f_RD, REAL8 f_tide, REAL8 torus_mass, REAL8 compactness, REAL8 final_mass, REAL8 chif, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 lambda_NS)

Function Documentation

◆ XLALSimIMRPhenomNSBH_x_D()

double XLALSimIMRPhenomNSBH_x_D	(	const REAL8	Mtorus,
		const REAL8	C,
		const REAL8	q,
		const REAL8	chi
	)

Convenience function for expression appearing in disruptive merger.

Combination of parameters that helps understand and handle disruptive cases which produce tori. This is Eq. (23) in arXiv:1509.00512 on pg. (7).

Parameters

Mtorus	Baryonic mass of the torus remnant of a BH-NS merger in units of the NS baryonic mass.
C	Neutron star compactness
q	Mass ratio of the NSBH system M_BH/M_NS > 1
chi	Dimensionless spin parameter -1 <= chi <= 1

Definition at line 682 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_epsilon_ins_with_torus_mass()

double XLALSimIMRPhenomNSBH_epsilon_ins_with_torus_mass	(	const REAL8	Mtorus,
		const REAL8	C,
		const REAL8	q,
		const REAL8	chi
	)

Correction to the inspiral transition frequency with spin contributions.

Correction factor that multiplies the inspiral transition frequency when the mixed phenom GW is generated. See https://arxiv.org/abs/1509.00512 Eq. (23) (p7) for it's definition.

Parameters

Mtorus	Baryonic mass of the torus remnant of a BH-NS merger in units of the NS baryonic mass.
C	Neutron star compactness
q	Mass ratio of the NSBH system M_BH/M_NS > 1
chi	Dimensionless spin parameter -1 <= chi <= 1

Definition at line 699 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_x_D_prime()

double XLALSimIMRPhenomNSBH_x_D_prime	(	const REAL8	Mtorus,
		const REAL8	C,
		const REAL8	q,
		const REAL8	chi
	)

Convinience function for expression appearing in disruptive merger.

Combination of parameters that helps understand and handle disruptive cases which produce tori.

See Eq. (25) of arXiv:1509:00512

Parameters

Mtorus	Baryonic mass of the torus remnant of a BH-NS merger in units of the NS baryonic mass.
C	Neutron star compactness
q	Mass ratio of the NSBH system M_BH/M_NS > 1
chi	Dimensionless spin parameter -1 <= chi <= 1

Definition at line 716 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_sigma_tide_with_torus_mass()

double XLALSimIMRPhenomNSBH_sigma_tide_with_torus_mass	(	const REAL8	Mtorus,
		const REAL8	C,
		const REAL8	q,
		const REAL8	chi
	)

Correction to ringdown Lorentzian width for disruptive mergers.

Correction to the Lorentzian width parameter in the ringdown ansatz used when the mixed phenom GW is generated for disruptive mergers that do produce tori. See https://arxiv.org/abs/1509.00512 Eq. (24) (p7) for it's definition.

Parameters

Mtorus	Baryonic mass of the torus remnant of a BH-NS merger in units of the NS baryonic mass.
C	Neutron star compactness
q	Mass ratio of the NSBH system M_BH/M_NS > 1
chi	Dimensionless spin parameter -1 <= chi <= 1

Definition at line 733 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_epsilon_tide_ND()

double XLALSimIMRPhenomNSBH_epsilon_tide_ND ( const REAL8 x_ND )

PhenomC parameter delta_1 NSBH correction factor.

Factor that mutltiplies the (PhenomC) parameter delta_1 when the mixed phenom GW is generated. See https://arxiv.org/abs/1509.00512 Eq. (16) (p5) for its definition.

Parameters

x_ND	Dimensionless fit parameters x_ND. See https://arxiv.org/abs/1506.00512 Eq. (17) (p6) for it's original definition (x_ND).

Definition at line 749 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_sigma_tide_ND()

double XLALSimIMRPhenomNSBH_sigma_tide_ND ( const REAL8 x_ND_prime )

Correction to ringdown Lorentzian width for nondisruptive mergers.

Correction to the Lorentzian width parameter in the ringdown ansatz used when the mixed phenom GW is generated for nondisruptive mergers that do not produce tori. See https://arxiv.org/abs/1509.00512 Eq. (18) (p6) for its definition.

Parameters

x_ND_prime Dimensionless fit parameter. See https://arxiv.org/abs/1509.00512 Eq. (19) (p6) for it's original definition (x_ND').

Definition at line 763 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_x_ND()

double XLALSimIMRPhenomNSBH_x_ND	(	const REAL8	f_tide,
		const REAL8	f_RD_tilde,
		const REAL8	C,
		const REAL8	chi
	)

Convinience function for expression appearing in disruptive merger.

Combination of parameters that helps understand and handle non-disruptive cases. See Eq. (17) of arXiv:1509:00512

Parameters

f_tide	Frequency at which the tidal interactions occur
f_RD_tilde	Scaled ringdown frequency
C	Neutron star compactness
chi	Dimensionless spin parameter -1 <= chi <= 1

Definition at line 775 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_x_ND_prime()

double XLALSimIMRPhenomNSBH_x_ND_prime	(	const REAL8	f_tide,
		const REAL8	f_RD_tilde,
		const REAL8	C,
		const REAL8	chi
	)

Convinience function for expression appearing in disruptive merger.

Combination of parameters that helps understand and handle non-disruptive cases. See Eq. (19) of arXiv:1509:00512

Parameters

f_tide	Frequency at which the tidal interactions occur
f_RD_tilde	Scaled ringdown frequency
C	Neutron star compactness
chi	Dimensionless spin parameter -1 <= chi <= 1

Definition at line 790 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_delta2_prime()

double XLALSimIMRPhenomNSBH_delta2_prime	(	const REAL8	f_tide,
		const REAL8	f_RD_tilde
	)

Fitted coefficient for PhenomC Lorentzian.

See Eq. (20) of arXiv:1509:00512

Parameters

f_tide	Frequency at which the tidal interactions occur
f_RD_tilde	Scaled ringdown frequency

Definition at line 804 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_window_plus()

double XLALSimIMRPhenomNSBH_window_plus	(	const REAL8	f,
		const REAL8	f0,
		const REAL8	d
	)

Hyperbolic tangent sigmoid function.

This function approaches 0.5 as f approaches infinity. It approaches 0 as f approaches -infinity. It's value will be 0.25 at f0. As d approaches 0 it approaches a step function.

Parameters

f	Value at which to evaluate sigmoid function
f0	Center of sigmoid function
d	Width of sigmoid function

Definition at line 818 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_window_minus()

double XLALSimIMRPhenomNSBH_window_minus	(	const REAL8	f,
		const REAL8	f0,
		const REAL8	d
	)

Hyperbolic tangent sigmoid function.

This function approaches 0.5 as f approaches -infinity. It approaches 0 as f approaches infinity. It's value will be 0.25 at f0. As d approaches 0 it approaches a step function.

Parameters

f	Value at which to evaluate sigmoid function
f0	Center of sigmoid function
d	Width of sigmoid function

Definition at line 833 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_eta_from_q()

double XLALSimIMRPhenomNSBH_eta_from_q ( const REAL8 q )

Convenience function to calculate symmetric mass ratio from q.

Parameters

q	Mass ratio

Definition at line 844 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_baryonic_mass_from_C()

double XLALSimIMRPhenomNSBH_baryonic_mass_from_C	(	const REAL8	C,
		const REAL8	Mg
	)

NS baryonic mass as a function of NS gravitational mass.

NS baryonic mass as a function of NS gravitational mass. Both are in solar mass units. See Eq. (22) in https://arxiv.org/abs/1601.06083 for the definition of this expression.

Parameters

C	Compactness of neutron star.
Mg	Neutron star gravitational mass.

Definition at line 857 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBH_omega_tilde()

COMPLEX16 XLALSimIMRPhenomNSBH_omega_tilde ( const REAL8 a )

220 quasi-normal mode dimensionless frequency

See Eq. (22) (p8) in https://arxiv.org/abs/1810.03550 for the definition of this quantity.

Parameters

a	Dimensionless final spin parameter of the BH remnant

Definition at line 872 of file LALSimIMRPhenomNSBH.c.

◆ XLALSimIMRPhenomNSBHProperties()

int XLALSimIMRPhenomNSBHProperties	(	REAL8 *	f_RD,
		REAL8 *	f_tide,
		REAL8 *	torus_mass,
		REAL8 *	compactness,
		REAL8 *	final_mass,
		REAL8 *	chif,
		REAL8	mBH_SI,
		REAL8	mNS_SI,
		REAL8	chi_BH,
		REAL8	lambda_NS
	)

Parameters

f_RD	Output: NSBH ringdown frequency [Hz]
f_tide	Output: NSBH tidal disruption frequency [Hz]
torus_mass	Output: Torus remnant mass (kg)
compactness	Output: Compactness of neutron star
final_mass	Output: final mass after merger (kg)
chif	Output: final dimensionless spin
mBH_SI	Mass of BH (kg)
mNS_SI	Mass of neutron star 2 (kg)
chi_BH	Dimensionless aligned component spin of Black Hole
lambda_NS	Dimensionless tidal deformability of NS

Definition at line 886 of file LALSimIMRPhenomNSBH.c.

Detailed Description

Utility routines for IMR Phenomenological Model "NSBH"

Function Documentation

◆ XLALSimIMRPhenomNSBH_x_D()

◆ XLALSimIMRPhenomNSBH_epsilon_ins_with_torus_mass()

◆ XLALSimIMRPhenomNSBH_x_D_prime()

◆ XLALSimIMRPhenomNSBH_sigma_tide_with_torus_mass()

◆ XLALSimIMRPhenomNSBH_epsilon_tide_ND()

◆ XLALSimIMRPhenomNSBH_sigma_tide_ND()

◆ XLALSimIMRPhenomNSBH_x_ND()

◆ XLALSimIMRPhenomNSBH_x_ND_prime()

◆ XLALSimIMRPhenomNSBH_delta2_prime()

◆ XLALSimIMRPhenomNSBH_window_plus()

◆ XLALSimIMRPhenomNSBH_window_minus()

◆ XLALSimIMRPhenomNSBH_eta_from_q()

◆ XLALSimIMRPhenomNSBH_baryonic_mass_from_C()

◆ XLALSimIMRPhenomNSBH_omega_tilde()

◆ XLALSimIMRPhenomNSBHProperties()