LALSimIMRPhenomNSBH.c File Reference

Prototypes
int	IMRPhenomNSBH_Core (COMPLEX16FrequencySeries **htilde, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 chi_NS, LALDict *extraParams, const REAL8Sequence *freqs_in, REAL8 deltaF)
static REAL8	PhenomNSBHAmplitudeOneFrequency (const REAL8 f, const BBHPhenomCParams *params, const BBHPhenomNSBHParams *params_NSBH)
	Computes PhenomNSBH Amplitude at a single frequency. More...
static BBHPhenomNSBHParams *	ComputeIMRPhenomNSBHParams (const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 lambda, const BBHPhenomCParams *params)
	PhenomC parameters for NSBH amplitude model. More...
Routines for IMR Phenomenological Model "NSBH"
C code for IMRPhenomNSBH phenomenological waveform model. Author Jonathan Thompson, Edward Fauchon-Jones, Sebastian Khan This is a single-spin, non-precessing frequency domain model. This model is based on the amplitude model described by [16] and the IMRPhenomD based NRTidal phase model described by [8]. Please see LIGO-T1900729 for a technical description of the implemented model. Note The model can be evaluated within the following parameter space boundary outside of which an XLAL_EDOM error will be thrown \( m_{\mathrm{NS}} \leq 3 M_{\odot} \) \( 1 \leq q \leq 100 \) \( 0 \leq \Lambda_2 \leq 5000 \) The model will throw a warning if it is evaluated inside the above parameter space boundary but violates any of the following conditions \( \chi_{\mathrm{NS}} = 0 \) \( m_{\mathrm{NS}} \geq 1 M_{\odot} \) \( \delta_1 \geq 0 \) \( \delta_2 \geq 10^{-4} \) \( \gamma_1 \geq 0 \) If any of the conditions on the phenomenological coefficient \( \delta_1, \delta_2, \gamma_1 \) are violated then they are increased to the values \( 0, 10^{-4}, 0 \) respectively to remove unphysical zeros in the amplitude. The models amplitude was calibrated to mass-ratios [1:2,1:3,1:4,1:5]. Along the mass-ratio 1:2 line it was calibrated to BH spins [-0.5, 0.75]. Along the mass-ratio 1:3 line it was calibrated to BH spins [-0.5, 0.75]. Along the mass-ratio 1:4 line it was calibrated to BH spins [0, 0.75]. Along the mass-ratio 1:5 line it was calibrated to BH spins [0, 0.75]. Please see [17], [14] and [16] for full details of the NR data used to calibrate the amplitude for this model. The models phase uses the phase of IMRPhenomD_NRTidalv2. For full details of the NR data used to calibrate the phase for this model please see [10], [12] and [8] Attention The model is usable outside this parameter range, and tests have shown that the model produces sensible results. However the current set of numerical relativity simulations for NSBH systems is limited. In particular they do not cover the mass ratio ranges and spin ranges of numerical relativity simulations that are available for BBH systems. As such you should carefully consider applications of this model for use case when evaluated outside the suggested parameter space. For more information please see the review wiki which can be found at https://git.ligo.org/waveforms/reviews/nsbh-models/wikis/home.
int	XLALSimIMRPhenomNSBHFrequencySequence (COMPLEX16FrequencySeries **htilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 chi_NS, LALDict *extraParams)
	Compute waveform in LAL format at specified frequencies for the IMRPhenomNSBH model. More...
int	XLALSimIMRPhenomNSBH (COMPLEX16FrequencySeries **htilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 chi_NS, LALDict *extraParams)
	Driver routine to compute the single-spin, non-precessing, neutron-star-black-hole, inspiral-merger-ringdown phenomenological waveform IMRPhenomNSBH in the frequency domain in LAL format. More...
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)

Go to the source code of this file.

Macros
#define	omp   ignore

Macro Definition Documentation

omp

#define omp   ignore

Definition at line 31 of file LALSimIMRPhenomNSBH.c.

Function Documentation

IMRPhenomNSBH_Core()

int IMRPhenomNSBH_Core	(	COMPLEX16FrequencySeries **	htilde,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	mBH_SI,
		REAL8	mNS_SI,
		REAL8	chi_BH,
		REAL8	chi_NS,
		LALDict *	extraParams,
		const REAL8Sequence *	freqs_in,
		REAL8	deltaF
	)

Parameters

htilde	Output: Frequency-domain waveform h+
phiRef	Phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
mBH_SI	Mass of BH (kg)
mNS_SI	Mass of neutron star 2 (kg)
chi_BH	Dimensionless aligned component spin of Black Hole
chi_NS	Dimensionless aligned component spin of NS
extraParams	extra params
freqs_in	Frequency points at which to evaluate the waveform (Hz)
deltaF	Sampling frequency (Hz)

Definition at line 35 of file LALSimIMRPhenomNSBH.c.

PhenomNSBHAmplitudeOneFrequency()

static REAL8 PhenomNSBHAmplitudeOneFrequency ( const REAL8  f, const BBHPhenomCParams *  params, const BBHPhenomNSBHParams *  params_NSBH  )

static

Computes PhenomNSBH Amplitude at a single frequency.

Parameters

f	frequency Hz
params	pointer to Object storing coefficients and constants: PhenomC
params_NSBH	pointer to Object storing coefficients and constants: PhenomC_NSBH

Definition at line 288 of file LALSimIMRPhenomNSBH.c.

ComputeIMRPhenomNSBHParams()

static BBHPhenomNSBHParams* ComputeIMRPhenomNSBHParams ( const REAL8  m1, const REAL8  m2, const REAL8  chi, const REAL8  lambda, const BBHPhenomCParams *  params  )

static

PhenomC parameters for NSBH amplitude model.

Compute NSBH parameters

mixed_merger

amp

Parameters

m1	Mass of companion 1 (solar masses)
m2	Mass of companion 2 (solar masses)
chi	Dimensionless spin of black hole
lambda	Dimensionless tidal deformability of NS
params	pointer to Object storing coefficients and constants: PhenomC

Definition at line 364 of file LALSimIMRPhenomNSBH.c.