LALSimulation  5.4.0.1-fe68b98
LALSimIMR.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2011 N. Fotopoulos <nickolas.fotopoulos@ligo.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with with program; see the file COPYING. If not, write to the
16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17  * MA 02110-1301 USA
18  */
19 
20 #ifndef _LALSIMIMR_H
21 #define _LALSIMIMR_H
22 
23 #include <lal/LALDatatypes.h>
24 #include <lal/LALSimInspiral.h>
25 
26 #ifdef LAL_HDF5_ENABLED
27 #include <lal/H5FileIO.h>
28 #endif
29 
30 // #include "LALSimIMRSpinEOB.h"
31 
32 #if defined(__cplusplus)
33 extern "C" {
34 #elif 0
35 } /* so that editors will match preceding brace */
36 #endif
37 
38 /**
39  * @defgroup LALSimIMR_h Header LALSimIMR.h
40  * @ingroup lalsimulation_inspiral
41  *
42  * @brief Routines for generating inspiral-merger-ringdown waveforms.
43  *
44  * @{
45  * @defgroup LALSimIMRPhenom_c LALSimIMRPhenom.c
46  * @defgroup LALSimIMRPhenomX_c LALSimIMRPhenomX.c
47  * @defgroup LALSimIMRPhenomT_c LALSimIMRPhenomTHM.c
48  * @defgroup LALSimIMREOBNRv2_c LALSimIMREOBNRv2.c
49  * @defgroup LALSimIMRSpinAlignedEOB_c LALSimIMRSpinAlignedEOB.c
50  * @defgroup LALSimIMRSpinPrecEOB_c LALSimIMRSpinPrecEOB.c
51  * @defgroup LALSimIMRSpinPrecEOBv4P_c LALSimIMRSpinPrecEOBv4P.c
52  * @defgroup LALSimIMRSEOBNRROM_c LALSimIMRSEOBNRvxROMXXX.c
53  * @defgroup LALSimIMRSEOBNRHMROM_c LALSimIMRSEOBNRv4HMROM.c
54  * @defgroup LALSimIMRSEOBNRv5HMROM_c LALSimIMRSEOBNRv5HMROM.c
55  * @defgroup LALSimIMRSEOBNRv2ChirpTime_c LALSimIMRSEOBNRv2ChirpTime.c
56  * @defgroup LALSimIMRPSpinInspiralRD_c LALSimIMRPSpinInspiralRD.c
57  * @defgroup LALSimIMRTidal_c LALSimIMRLackeyTidal2013.c
58  * @defgroup LALSimPrecessingNRSur_c LALSimIMRPrecessingNRSur.c
59  * @defgroup LALSimIMRNRWaveforms_c LALSimIMRNRWaveforms.c
60  * @defgroup LALSimIMRTEOBResumS_c LALSimIMRTEOBResumS.c
61  * @}
62  *
63  * @addtogroup LALSimIMR_h
64  * @{
65  */
66 
67 /**
68  * The number of e-folds of ringdown which should be attached for
69  * EOBNR models
70  */
71 #define EOB_RD_EFOLDS 10.0
72 
73 typedef enum tagIMRPhenomP_version_type {
74  IMRPhenomPv1_V, /**< version 1: based on IMRPhenomC */
75  IMRPhenomPv2_V, /**< version 2: based on IMRPhenomD */
76  IMRPhenomPv2NRTidal_V, /**< version Pv2_NRTidal: based on IMRPhenomPv2; NRTides added before precession; can be used with both NRTidal versions defined below */
77  IMRPhenomPv3_V /**< version 3: based on IMRPhenomD and the precession angles from Katerina Chatziioannou PhysRevD.95.104004 (arxiv:1703.03967) */
79 
80 typedef enum tagNRTidal_version_type {
81  NRTidal_V, /**< version NRTidal: based on https://arxiv.org/pdf/1706.02969.pdf*/
82  NRTidalv2_V, /**< version NRTidalv2: https://arxiv.org/abs/1905.06011 */
83  NRTidalv2NoAmpCorr_V, /**< version NRTidalv2, without amplitude corrections */
84  NRTidalv2NSBH_V, /**< version NRTidalv2: https://arxiv.org/abs/1905.06011 with amplitude corrections for NSBH (used for SEOBNRv4ROM_NRTidalv2_NSBH) */
85  NoNRT_V /**< special case for PhenomPv2 BBH baseline */
87 
88 typedef enum tagSEOBNRv4TSurrogate_spline_order {
89  SEOBNRv4TSurrogate_CUBIC, /**< use cubic splines in frequency */
90  SEOBNRv4TSurrogate_LINEAR /**< use linear splines in frequency */
92 
93 /** @} */
94 
95 /* in module LALSimIMRPhenom.c */
96 
97 int XLALSimIMRPhenomAGenerateFD(COMPLEX16FrequencySeries **htilde, const REAL8 phiPeak, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_min, const REAL8 f_max, const REAL8 distance);
98 int XLALSimIMRPhenomAGenerateTD(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination);
99 double XLALSimIMRPhenomBComputeChi(const REAL8 m1, const REAL8 m2, const REAL8 s1z, const REAL8 s2z);
100 double XLALSimIMRPhenomAGetFinalFreq(const REAL8 m1, const REAL8 m2);
101 double XLALSimIMRPhenomBGetFinalFreq(const REAL8 m1, const REAL8 m2, const REAL8 chi);
102 int XLALSimIMRPhenomBGenerateFD(COMPLEX16FrequencySeries **htilde, const REAL8 phiPeak, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance);
103 int XLALSimIMRPhenomBGenerateTD(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination);
104 int XLALSimIMRPhenomBMetricInMEtaChi(REAL8 *gamma00, REAL8 *gamma01, REAL8 *gamma02, REAL8 *gamma11, REAL8 *gamma12, REAL8 *gamma22, const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh);
105 int XLALSimIMRPhenomBMetricInTheta0Theta3Theta3S(REAL8 *gamma00, REAL8 *gamma01, REAL8 *gamma02, REAL8 *gamma11, REAL8 *gamma12, REAL8 *gamma22, const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh);
106 double XLALSimIMRPhenomCGetFinalFreq(const REAL8 m1, const REAL8 m2, const REAL8 chi);
107 int XLALSimIMRPhenomCGenerateFD(COMPLEX16FrequencySeries **htilde, const REAL8 phiPeak, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, LALDict *extraParams);
108 int XLALSimIMRPhenomCGenerateTD(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination, LALDict *extraParams);
109 
110 /* in module LALSimIMRPhenomNSBH.c */
112  REAL8 *f_RD, /**< Output: NSBH ringdown frequency [Hz] */
113  REAL8 *f_tide, /**< Output: NSBH tidal disruption frequency [Hz] */
114  REAL8 *torus_mass, /**< Output: Torus remnant mass (kg) */
115  REAL8 *compactness, /**< Output: Compactness of neutron star */
116  REAL8 *final_mass, /**< Output: final mass after merger (kg) */
117  REAL8 *chif, /**< Output: final dimensionless spin */
118  REAL8 mBH_SI, /**< Mass of BH (kg) */
119  REAL8 mNS_SI, /**< Mass of neutron star 2 (kg) */
120  REAL8 chi_BH, /**< Dimensionless aligned component spin of Black Hole */
121  REAL8 lambda_NS /**< Dimensionless tidal deformability of NS */
122 );
123 
124 double XLALSimIMRPhenomNSBH_x_D(const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi);
125 double XLALSimIMRPhenomNSBH_epsilon_ins_with_torus_mass(const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi);
126 double XLALSimIMRPhenomNSBH_x_D_prime(const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi);
127 double XLALSimIMRPhenomNSBH_sigma_tide_with_torus_mass(const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi);
129 double XLALSimIMRPhenomNSBH_sigma_tide_ND(const REAL8 x_ND_prime);
130 double XLALSimIMRPhenomNSBH_x_ND(const REAL8 f_tide, const REAL8 f_RD_tilde, const REAL8 C, const REAL8 chi);
131 double XLALSimIMRPhenomNSBH_x_ND_prime(const REAL8 f_tide, const REAL8 f_RD_tilde, const REAL8 C, const REAL8 chi);
132 double XLALSimIMRPhenomNSBH_delta2_prime(const REAL8 f_tide, const REAL8 f_RD_tilde);
133 
134 double XLALSimIMRPhenomNSBH_window_plus(const REAL8 f, const REAL8 f0, const REAL8 d);
135 double XLALSimIMRPhenomNSBH_window_minus(const REAL8 f, const REAL8 f0, const REAL8 d);
137 
138 double XLALSimIMRPhenomNSBH_baryonic_mass_from_C(const REAL8 C, const REAL8 Mg);
139 
141 
142 /* in module LALSimNSBHProperties.c */
143 double XLALSimNSBH_fGWinKerr(const REAL8 r, const REAL8 M, const REAL8 a);
144 double XLALSimNSBH_rKerrISCO(const REAL8 a);
145 double XLALSimNSBH_xi_tide(const REAL8 q, const REAL8 a, const REAL8 mu);
147 double XLALSimNSBH_torus_mass_fit(const REAL8 q, const REAL8 a, const REAL8 C);
148 
149 /* in module LALSimIMRPhenomD.c */
150 int XLALSimIMRPhenomDGenerateFD(COMPLEX16FrequencySeries **htilde, const REAL8 phi0, const REAL8 fRef, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi1, const REAL8 chi2, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, LALDict *extraParams, NRTidal_version_type NRTidal_version);
151 int XLALSimIMRPhenomDFrequencySequence(COMPLEX16FrequencySeries **htilde, const REAL8Sequence *freqs, const REAL8 phi0, const REAL8 fRef_in, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi1, const REAL8 chi2, const REAL8 distance, LALDict *extraParams, NRTidal_version_type NRTidal_version);
152 double XLALIMRPhenomDGetPeakFreq(const REAL8 m1_in, const REAL8 m2_in, const REAL8 chi1_in, const REAL8 chi2_in);
153 double XLALSimIMRPhenomDChirpTime(const REAL8 m1_in, const REAL8 m2_in, const REAL8 chi1_in, const REAL8 chi2_in, const REAL8 fHz);
154 double XLALSimIMRPhenomDFinalSpin(const REAL8 m1_in, const REAL8 m2_in, const REAL8 chi1_in, const REAL8 chi2_in);
155 
156 int XLALSimIMRPhenomP(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip, const REAL8 thetaJ, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 distance, const REAL8 alpha0, const REAL8 phic, const REAL8 deltaF, const REAL8 f_min, const REAL8 f_max, const REAL8 f_ref, IMRPhenomP_version_type IMRPhenomP_version, NRTidal_version_type NRTidal_version, LALDict *extraParams);
157 int XLALSimIMRPhenomPFrequencySequence(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip, const REAL8 thetaJ, REAL8 m1_SI, const REAL8 m2_SI, const REAL8 distance, const REAL8 alpha0, const REAL8 phic, const REAL8 f_ref, IMRPhenomP_version_type IMRPhenomP_version, NRTidal_version_type NRTidal_version, LALDict *extraParams);
158 int XLALSimIMRPhenomPCalculateModelParametersOld(REAL8 *chi1_l, REAL8 *chi2_l, REAL8 *chip, REAL8 *thetaJ, REAL8 *alpha0, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_ref, const REAL8 lnhatx, const REAL8 lnhaty, const REAL8 lnhatz, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, IMRPhenomP_version_type IMRPhenomP_version);
159 int XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame(REAL8 *chi1_l, REAL8 *chi2_l, REAL8 *chip, REAL8 *thetaJN, REAL8 *alpha0, REAL8 *phi_aligned, REAL8 *zeta_polariz, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_ref, const REAL8 phiRef, const REAL8 incl, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, IMRPhenomP_version_type IMRPhenomP_version);
160 
161 /* in module LALSimIMREOBNRv2.c */
162 
163 int XLALSimIMREOBNRv2DominantMode(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fLower, const REAL8 distance, const REAL8 inclination);
164 int XLALSimIMREOBNRv2AllModes(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fLower, const REAL8 distance, const REAL8 inclination);
165 SphHarmTimeSeries *XLALSimIMREOBNRv2Modes(const REAL8 deltaT, const REAL8 m1, const REAL8 m2, const REAL8 fLower, const REAL8 distance);
166 
167 
168 /* in module LALSimIMRSpinAlignedEOB.c */
169 
170 double XLALSimIMRSpinAlignedEOBPeakFrequency(REAL8 m1SI, REAL8 m2SI, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion);
171 int XLALSimIMRSpinAlignedEOBWaveform(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, LALDict *LALparams);
173  REAL8TimeSeries **hplus,
174  REAL8TimeSeries **hcross,
175  const REAL8 phiC,
176  REAL8 deltaT,
177  const REAL8 m1SI,
178  const REAL8 m2SI,
179  const REAL8 fMin,
180  const REAL8 r,
181  const REAL8 inc,
182  const REAL8 spin1z,
183  const REAL8 spin2z,
184  UINT4 SpinAlignedEOBversion,
185  const REAL8 lambda2Tidal1,
186  const REAL8 lambda2Tidal2,
187  const REAL8 omega02Tidal1,
188  const REAL8 omega02Tidal2,
189  const REAL8 lambda3Tidal1,
190  const REAL8 lambda3Tidal2,
191  const REAL8 omega03Tidal1,
192  const REAL8 omega03Tidal2,
193  const REAL8 quadparam1,
194  const REAL8 quadparam2,
195  REAL8Vector *nqcCoeffsInput,
196  const INT4 nqcFlag,
197  LALValue *ModeArray,
198  LALDict *TGRParams
199 );
201  SphHarmTimeSeries ** hlmmode, //SM
202  REAL8Vector ** dynamics_out, /**<< OUTPUT, low-sampling dynamics */
203  REAL8Vector ** dynamicsHi_out, /**<< OUTPUT, high-sampling dynamics */ //SM
204  REAL8 deltaT,
205  const REAL8 m1SI,
206  const REAL8 m2SI,
207  const REAL8 fMin,
208  const REAL8 r,
209  const REAL8 spin1z,
210  const REAL8 spin2z,
211  UINT4 SpinAlignedEOBversion,
212  const REAL8 lambda2Tidal1,
213  const REAL8 lambda2Tidal2,
214  const REAL8 omega02Tidal1,
215  const REAL8 omega02Tidal2,
216  const REAL8 lambda3Tidal1,
217  const REAL8 lambda3Tidal2,
218  const REAL8 omega03Tidal1,
219  const REAL8 omega03Tidal2,
220  const REAL8 quadparam1,
221  const REAL8 quadparam2,
222  REAL8Vector *nqcCoeffsInput,
223  const INT4 nqcFlag,
224  LALDict *PAParams,
225  LALDict *TGRParams
226 );
227 /*int XLALSimIMRSpinEOBWaveform(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1[], const REAL8 spin2[]);
228  */
229 
230 /* in module LALSimIMRSpinPrecEOB.c */
231 
233  REAL8TimeSeries **hplus,
234  REAL8TimeSeries **hcross,
235  const REAL8 phiC,
236  const REAL8 deltaT,
237  const REAL8 m1SI,
238  const REAL8 m2SI,
239  const REAL8 fMin,
240  const REAL8 r,
241  const REAL8 inc,
242  const REAL8 spin1[],
243  const REAL8 spin2[],
244  const UINT4 PrecEOBversion
245  );
247  REAL8TimeSeries **hplus,
248  REAL8TimeSeries **hcross,
249  REAL8Vector **dynamicsHi,
250  SphHarmTimeSeries **hlmPTSout,
251  SphHarmTimeSeries **hlmPTSHi,
252  SphHarmTimeSeries **hIMRlmJTSHi,
253  SphHarmTimeSeries **hIMRoutput,
254  REAL8Vector **AttachParams,
255  const REAL8 phiC,
256  const REAL8 deltaT,
257  const REAL8 m1SI,
258  const REAL8 m2SI,
259  const REAL8 fMin,
260  const REAL8 r,
261  const REAL8 inc,
262  const REAL8 INspin1x,
263  const REAL8 INspin1y,
264  const REAL8 INspin1z,
265  const REAL8 INspin2x,
266  const REAL8 INspin2y,
267  const REAL8 INspin2z,
268  const UINT4 PrecEOBversion
269  );
270 typedef enum tagflagSEOBNRv4P_hamiltonian_derivative {
271  FLAG_SEOBNRv4P_HAMILTONIAN_DERIVATIVE_ANALYTICAL = 0, /**< use analytical derivatives (opt) */
272  FLAG_SEOBNRv4P_HAMILTONIAN_DERIVATIVE_NUMERICAL = 1 /**< use numerical derivatives (pre-opt) */
274 
275 typedef enum tagflagSEOBNRv4P_euler_extension {
276  FLAG_SEOBNRv4P_EULEREXT_QNM_SIMPLE_PRECESSION = 0, /**< QNM-based simple precession prescription post-merger */
277  FLAG_SEOBNRv4P_EULEREXT_CONSTANT = 1 /**< Euler angles set to constants post-merger */
279 
280 typedef enum tagflagSEOBNRv4P_Zframe {
281  FLAG_SEOBNRv4P_ZFRAME_L = 0, /**< set Z axis of the P-frame along L */
282  FLAG_SEOBNRv4P_ZFRAME_LN = 1 /**< set Z axis of the P-frame along LN */
284 
285 
286 /* in module LALSimIMRSpinPrecEOBv4P.c */
287 
288 int XLALEOBHighestInitialFreq(REAL8 *freqMinRad, REAL8 mTotal);
289 int XLALEOBCheckNyquistFrequency(REAL8 m1, REAL8 m2, REAL8 spin1[3], REAL8 spin2[3],
290  UINT4 ell_max, Approximant approx,
291  REAL8 deltaT);
293  REAL8TimeSeries **hplus,
294  REAL8TimeSeries **hcross,
295  SphHarmTimeSeries **hIlm,
296  SphHarmTimeSeries **hJlm,
297  REAL8Vector **seobdynamicsAdaSVector,
298  REAL8Vector **seobdynamicsHiSVector,
299  REAL8Vector **seobdynamicsAdaSHiSVector,
300  REAL8Vector **tVecPmodes,
301  REAL8Vector **hP22_amp,
302  REAL8Vector **hP22_phase,
303  REAL8Vector **hP21_amp,
304  REAL8Vector **hP21_phase,
305  REAL8Vector **hP33_amp,
306  REAL8Vector **hP33_phase,
307  REAL8Vector **hP44_amp,
308  REAL8Vector **hP44_phase,
309  REAL8Vector **hP55_amp,
310  REAL8Vector **hP55_phase,
311  REAL8Vector **alphaJ2P,
312  REAL8Vector **betaJ2P,
313  REAL8Vector **gammaJ2P,
314  REAL8Vector **mergerParams,
315  const REAL8 phiC,
316  const REAL8 INdeltaT,
317  const REAL8 m1SI,
318  const REAL8 m2SI,
319  const REAL8 fMin,
320  const REAL8 r,
321  const REAL8 inc,
322  const REAL8 chi1x,
323  const REAL8 chi1y,
324  const REAL8 chi1z,
325  const REAL8 chi2x,
326  const REAL8 chi2y,
327  const REAL8 chi2z,
328  LALValue *modearray,
329  LALDict *seobflags
330  );
331 
333  REAL8TimeSeries **hplus,
334  REAL8TimeSeries **hcross,
335  const REAL8 phiC,
336  const REAL8 deltaT,
337  const REAL8 m1SI,
338  const REAL8 m2SI,
339  const REAL8 fMin,
340  const REAL8 r,
341  const REAL8 inc,
342  const REAL8 INspin1[],
343  const REAL8 INspin2[],
344  const UINT4 PrecEOBversion,
345  LALDict *LALParams
346  );
347 
349  const REAL8 deltaT,
350  const REAL8 m1SI,
351  const REAL8 m2SI,
352  const REAL8 fMin,
353  const REAL8 r,
354  const REAL8 INspin1[],
355  const REAL8 INspin2[],
356  const UINT4 PrecEOBversion,
357  LALDict *LALParams
358  );
359 
360 /* in module LALSimIMREOBNRv2HMROM.c */
361 
362 int XLALSimIMREOBNRv2HMROM(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, const int higherModesFlag);
363 
364 /* in module LALSimIMRSEOBNRv1ROMEffectiveSpin.c */
365 
366 int XLALSimIMRSEOBNRv1ROMEffectiveSpin(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi);
367 int XLALSimIMRSEOBNRv1ROMEffectiveSpinFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi);
368 
369 /* in module LALSimIMRSEOBNRv1ROMDoubleSpin.c */
370 
371 int XLALSimIMRSEOBNRv1ROMDoubleSpin(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
372 int XLALSimIMRSEOBNRv1ROMDoubleSpinFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
373 
374 
375 /* in module LALSimIMRSEOBNRv2ROMEffectiveSpin.c */
376 
377 int XLALSimIMRSEOBNRv2ROMEffectiveSpin(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi);
378 int XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi);
381 
382 
383 /* in module LALSimIMRSEOBNRv2ROMDoubleSpin.c */
384 
385 int XLALSimIMRSEOBNRv2ROMDoubleSpin(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
386 int XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
387 int XLALSimIMRSEOBNRv2ROMDoubleSpinTimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
388 int XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencyOfTime(REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
389 int XLALSimIMRSEOBNRv2ROMDoubleSpinAmpPhaseInterpolants( struct tagREAL8Vector **amplitude_interp, struct tagREAL8Vector **amplitude_freq_points, struct tagREAL8Vector **phase_interp, struct tagREAL8Vector **phase_freq_points, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
390 
391 
392 /* in module LALSimIMRSEOBNRv2ROMDoubleSpinHI.c */
393 
394 int XLALSimIMRSEOBNRv2ROMDoubleSpinHI(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max);
395 int XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max);
396 int XLALSimIMRSEOBNRv2ROMDoubleSpinHITimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
397 int XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencyOfTime(REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
398 
399 
400 /* in module LALSimIMRSEOBNRv2ChirpTime.c */
401 
402 REAL8 XLALSimIMRSEOBNRv2ChirpTimeSingleSpin(const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min);
403 
404 
405 /* in module LALSimIMRLackeyTidal2013.c */
406 
407 int XLALSimIMRLackeyTidal2013(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 Lambda);
408 int XLALSimIMRLackeyTidal2013FrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 Lambda);
409 
410 
411 /* in module LALSimIMRSEOBNRv4ROM.c */
412 
413 int XLALSimIMRSEOBNRv4ROM(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, LALDict *LALparams, NRTidal_version_type NRTidal_version);
414 int XLALSimIMRSEOBNRv4ROMFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, LALDict *LALparams, NRTidal_version_type NRTidal_version);
415 int XLALSimIMRSEOBNRv4ROMTimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
416 int XLALSimIMRSEOBNRv4ROMFrequencyOfTime(REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
417 
418 /* in module LALSimIMRSEOBNRv4HMROM.c */
419 int XLALSimIMRSEOBNRv4HMROM(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, bool use_hybridization, LALDict *LALParams);
420 int XLALSimIMRSEOBNRv4HMROMFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, LALDict *LALParams);
421 int XLALSimIMRSEOBNRv4HMROM_Modes(SphHarmFrequencySeries **hlm, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, bool use_hybridization);
422 int XLALSimIMRSEOBNRv4HMROMFrequencySequence_Modes(SphHarmFrequencySeries **hlm, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, LALDict *LALParams);
423 
424 /* in module LALSimIMRSEOBNRv5HMROM.c */
425 int XLALSimIMRSEOBNRv5HMROM(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, bool use_hybridization, LALDict *LALParams);
426 int XLALSimIMRSEOBNRv5HMROMFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, LALDict *LALParams);
427 int XLALSimIMRSEOBNRv5HMROM_Modes(SphHarmFrequencySeries **hlm, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, bool use_hybridization);
428 int XLALSimIMRSEOBNRv5HMROMFrequencySequence_Modes(SphHarmFrequencySeries **hlm, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, LALDict *LALParams);
429 int XLALSimIMRSEOBNRv5ROMTimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2);
430 
431 /* in module LALSimIMRSEOBNRv4ROM_NRTidal.c */
432 
433 int XLALSimIMRSEOBNRv4ROMNRTidalFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 chi2, REAL8 Lambda1, REAL8 Lambda2, LALDict *LALparams, NRTidal_version_type NRTidal_version);
434 int XLALSimIMRSEOBNRv4ROMNRTidal(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 chi2, REAL8 Lambda1, REAL8 Lambda2, LALDict *LALparams, NRTidal_version_type NRTidal_version);
435 
436 /* in module LALSimBHNSRemnantFits.c */
437 REAL8 XLALbbh_final_mass_non_precessing_UIB2016(const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 chi2);
438 REAL8 XLALbbh_final_spin_non_precessing_UIB2016(const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 chi2);
439 REAL8 XLALBHNS_mass_aligned(const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 lam);
440 REAL8 XLALBHNS_spin_aligned(const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 lam);
441 
442 /* In module LALSimIMRSEOBNRv4ROM_NSBHAmplitudeCorrection.c */
444  const REAL8Sequence *amp_tidal, /**< [out] tidal amplitude frequency series */
445  const REAL8Sequence *fHz, /**< list of input Gravitational wave Frequency in Hz to evaluate */
446  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
447  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
448  REAL8 chi1, /**< Spin of black hole */
449  REAL8 lambda2 /**< (tidal deformability of mass 2) / m2^5 (dimensionless) */
450 );
451 
452 /* in module LALSimIMRSEOBNRv4TSurrogate.c */
453 
454 int XLALSimIMRSEOBNRv4TSurrogate(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, REAL8 lambda1, REAL8 lambda2, SEOBNRv4TSurrogate_spline_order spline_order);
455 int XLALSimIMRSEOBNRv4TSurrogateFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, REAL8 lambda1, REAL8 lambda2, SEOBNRv4TSurrogate_spline_order spline_order);
456 
457 
458 /* in module LALSimIMRPSpinInspiralRD.c */
459 
460 int XLALSimIMRPhenSpinFinalMassSpin(REAL8 *finalMass, REAL8 *finalSpin, REAL8 m1, REAL8 m2, REAL8 s1s1, REAL8 s2s2, REAL8 s1L, REAL8 s2L, REAL8 s1s2, REAL8 energy);
461 int XLALSimSpinInspiralGenerator(REAL8TimeSeries **hPlus, REAL8TimeSeries **hCross, REAL8 phi_start, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 f_ref, REAL8 r, REAL8 iota, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, int phaseO, int ampO, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams);
462 int XLALSimIMRPhenSpinInspiralRDGenerator(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phi0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 f_ref, REAL8 r, REAL8 iota, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, int phaseO, int ampO, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams);
463 
464 /* IMRPhenomX/HM Routines */
465 /* in module LALSimIMRPhenomX.c */
467  REAL8 m1_SI,
468  REAL8 m2_SI,
469  REAL8 chi1L,
470  REAL8 chi2L,
471  REAL8 distance,
472  REAL8 f_min,
473  REAL8 f_max,
474  REAL8 deltaF,
475  REAL8 phiRef,
476  REAL8 fRef_In,
477  LALDict *lalParams
478 );
479 
481  COMPLEX16FrequencySeries **htilde22,
482  const REAL8Sequence *freqs,
483  REAL8 m1_SI,
484  REAL8 m2_SI,
485  REAL8 chi1L,
486  REAL8 chi2L,
487  REAL8 distance,
488  REAL8 phiRef,
489  REAL8 fRef_In,
490  LALDict *lalParams
491 );
492 
494  REAL8 m1_SI, /**< mass of companion 1 (kg) */
495  REAL8 m2_SI, /**< mass of companion 2 (kg) */
496  REAL8 chi1L, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
497  REAL8 chi2L, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
498  REAL8 f_min /**< Starting frequency for waveform (Hz) */
499 );
500 
502  REAL8Sequence **alpha_of_f, /**< [out] The azimuthal angle of L around J */
503  REAL8Sequence **gamma_of_f, /**< [out] The third Euler angle describing L with respect to J. Fixed by minmal rotation condition. */
504  REAL8Sequence **cosbeta_of_f, /**< [out] Cosine of polar angle between L and J */
505  const REAL8Sequence *freqs, /**< Input Frequency series [Hz] */
506  REAL8 m1_SI, /**< mass of companion 1 (kg) */
507  REAL8 m2_SI, /**< mass of companion 2 (kg) */
508  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
509  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
510  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
511  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
512  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
513  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
514  REAL8 inclination, /**< Inclination : angle between LN and the line of sight */
515  REAL8 fRef_In, /**< Reference frequency (Hz) */
516  INT4 mprime, /**< Spherical harmonic order m */
517  LALDict *lalParams /**< LAL Dictionary struct */
518 );
519 
521  REAL8Sequence **alpha_of_f, /**< [out] Azimuthal angle of L w.r.t J */
522  REAL8Sequence **gamma_of_f, /**< [out] Third Euler angle describing L w.r.t J, fixed by minimal rotation condition */
523  REAL8Sequence **cosbeta_of_f, /**< [out] Cosine of polar angle between L and J */
524  const REAL8Sequence *freqs, /**< Input Frequency series [Hz] */
525  REAL8 m1_SI, /**< mass of companion 1 (kg) */
526  REAL8 m2_SI, /**< mass of companion 2 (kg) */
527  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
528  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
529  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
530  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
531  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
532  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
533  REAL8 inclination, /**< Inclination : angle between LN and the line of sight */
534  REAL8 fRef_In, /**< Reference frequency (Hz) */
535  INT4 mprime, /**< Spherical harmonic order m */
536  LALDict *lalParams /**< LAL Dictionary struct */
537 );
538 
540  REAL8Sequence **alphaFS, /**< [out] Alpha angle frequency series */
541  REAL8Sequence **cosbetaFS, /**< [out] cos(Beta) angle frequency series */
542  REAL8Sequence **gammaFS, /**< [out] Gamma angle frequency series */
543  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
544  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
545  REAL8 s1x, /**< x component of primary spin*/
546  REAL8 s1y, /**< y component of primary spin*/
547  REAL8 s1z, /**< z component of primary spin */
548  REAL8 s2x, /**< x component of secondary spin*/
549  REAL8 s2y, /**< y component of secondary spin*/
550  REAL8 s2z, /**< z component of secondary spin */
551  REAL8 fmin, /**< starting GW frequency (Hz) */
552  REAL8 fmax, /**< maximum GW frequency (Hz) */
553  REAL8 deltaF, /**< starting GW frequency (Hz) */
554  REAL8 fRef, /**< reference GW frequency (Hz) */
555  REAL8 phiRef, /**< reference orbital phase (rad) */
556  LALDict *LALparams /**< LAL Dictionary struct */
557 );
558 
560  COMPLEX16FrequencySeries **hptilde, /**< [out] Frequency-domain waveform h+ */
561  COMPLEX16FrequencySeries **hctilde, /**< [out] Frequency-domain waveform hx */
562  REAL8 m1_SI, /**< mass of companion 1 (kg) */
563  REAL8 m2_SI, /**< mass of companion 2 (kg) */
564  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
565  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
566  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
567  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
568  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
569  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
570  const REAL8 distance, /**< Distance of source (m) */
571  const REAL8 inclination, /**< inclination of source (rad) */
572  const REAL8 phiRef, /**< Orbital phase (rad) at reference frequency */
573  REAL8 f_min, /**< Starting GW frequency (Hz) */
574  REAL8 f_max, /**< Ending GW frequency (Hz); Defaults to Mf = 0.3 if no f_max is specified. */
575  const REAL8 deltaF, /**< Sampling frequency (Hz). To use non-uniform frequency grid, set deltaF <= 0. */
576  REAL8 fRef_In, /**< Reference frequency (Hz) */
577  LALDict *lalParams /**< LAL Dictionary struct */
578 );
579 
580 /* ~~~~~~~~~~ PNR Related ~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
581 REAL8 XLALSimPhenomPNRfRingEff( REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams );
582 REAL8 XLALSimPhenomPNRafinal( REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams );
583 REAL8 XLALSimPhenomPNRafinal_prec( REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams );
584 REAL8 XLALSimPhenomPNRafinal_nonprec( REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams );
585 REAL8 XLALSimPhenomPNRwindow( REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams );
586 REAL8 XLALSimPhenomPNRfRINGEffShiftDividedByEmm( REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams );
587 REAL8 XLALSimPhenomPNRbetaRD( REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams );
588 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
589 
591  COMPLEX16FrequencySeries **hptilde, /**< [out] Frequency-domain waveform h+ */
592  COMPLEX16FrequencySeries **hctilde, /**< [out] Frequency-domain waveform hx */
593  const REAL8Sequence *freqs, /**< [out] Frequency series [Hz] */
594  REAL8 m1_SI, /**< mass of companion 1 (kg) */
595  REAL8 m2_SI, /**< mass of companion 2 (kg) */
596  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
597  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
598  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
599  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
600  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
601  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
602  const REAL8 distance, /**< Distance of source (m) */
603  const REAL8 inclination, /**< inclination of source (rad) */
604  const REAL8 phiRef, /**< Orbital phase (rad) at reference frequency */
605  REAL8 fRef_In, /**< Reference frequency (Hz) */
606  LALDict *lalParams /**< LAL Dictionary struct */
607 );
608 
610  SphHarmFrequencySeries **hlms,
611  REAL8 m1_SI, /**< mass of companion 1 (kg) */
612  REAL8 m2_SI, /**< mass of companion 2 (kg) */
613  REAL8 S1z, /**< z-component of the dimensionless spin of object 1 */
614  REAL8 S2z, /**< z-component of the dimensionless spin of object 2 */
615  REAL8 deltaF, /**< sampling interval (s) */
616  REAL8 f_min, /**< starting GW frequency (Hz) */
617  REAL8 f_max, /**< ending GW frequency (Hz) */
618  REAL8 f_ref, /**< reference GW frequency (Hz) */
619  REAL8 phiRef, /**< phase shift at reference frequency */
620  REAL8 distance, /**< distance of source (m) */
621  LALDict *LALparams /**< LAL dictionary with extra options */
622 );
623 
625  COMPLEX16FrequencySeries **htildelm, /**< [out] FD waveform */
626  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
627  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
628  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
629  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
630  UINT4 ell, /**< l index of the mode */
631  INT4 emm, /**< m index of the mode */
632  REAL8 distance, /**< Luminosity distance (m) */
633  REAL8 f_min, /**< Starting GW frequency (Hz) */
634  REAL8 f_max, /**< End frequency; 0 defaults to Mf = 0.3 */
635  REAL8 deltaF, /**< Sampling frequency (Hz) */
636  REAL8 phiRef, /**< Orbital phase at fRef (rad) */
637  REAL8 fRef_In, /**< Reference frequency (Hz) */
638  LALDict *lalParams /**< lal dictionary parameters */
639 );
640 
642  COMPLEX16FrequencySeries **htildelm, /**< [out] FD waveform */
643  const REAL8Sequence *freqs, /**< frequency array to evaluate model (Hz) */
644  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
645  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
646  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
647  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
648  UINT4 ell, /**< l index of the mode */
649  INT4 emm, /**< m index of the mode */
650  REAL8 distance, /**< Luminosity distance (m) */
651  REAL8 phiRef, /**< Orbital phase at fRef (rad) */
652  REAL8 fRef_In, /**< Reference frequency (Hz) */
653  LALDict *lalParams /**< lal dictionary parameters */
654 );
655 
657  COMPLEX16FrequencySeries **hptilde, /**< [out] Frequency-domain waveform h+ */
658  COMPLEX16FrequencySeries **hctilde, /**< [out] Frequency-domain waveform hx */
659  REAL8 m1_SI, /**< mass of companion 1 (kg) */
660  REAL8 m2_SI, /**< mass of companion 2 (kg) */
661  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
662  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
663  REAL8 f_min, /**< Starting GW frequency (Hz) */
664  REAL8 f_max, /**< End frequency; 0 defaults to Mf = 0.3 */
665  REAL8 deltaF, /**< Sampling frequency (Hz) */
666  REAL8 distance, /**< distance of source (m) */
667  REAL8 inclination, /**< inclination of source (rad) */
668  REAL8 phiRef, /**< reference orbital phase (rad) */
669  REAL8 fRef_In, /**< Reference frequency */
670  LALDict *lalParams /**<linked list containing the extra testing GR parameters */
671 );
672 
673 
675  COMPLEX16FrequencySeries **hptilde, /**< [out] Frequency domain h+ GW strain */
676  COMPLEX16FrequencySeries **hctilde, /**< [out] Frequency domain hx GW strain */
677  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
678  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
679  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
680  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
681  REAL8 distance, /**< Luminosity distance (m) */
682  REAL8 f_min, /**< Starting GW frequency (Hz) */
683  REAL8 f_max, /**< End frequency; 0 defaults to Mf = 0.3 */
684  REAL8 deltaF, /**< Sampling frequency (Hz) */
685  REAL8 inclination, /** Inclination of the source */
686  REAL8 phiRef, /**< Orbital phase at fRef (rad) */
687  REAL8 fRef_In, /**< Reference frequency (Hz) */
688  LALDict *lalParams /**< LAL Dictionary */
689 );
690 
691 
693  COMPLEX16FrequencySeries **htildelm, /**< [out] FD waveform */
694  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
695  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
696  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
697  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
698  UINT4 ell, /**< l index of the mode */
699  INT4 emm, /**< m index of the mode */
700  REAL8 distance, /**< Luminosity distance (m) */
701  REAL8 f_min, /**< Starting GW frequency (Hz) */
702  REAL8 f_max, /**< End frequency; 0 defaults to Mf = 0.3 */
703  REAL8 deltaF, /**< Sampling frequency (Hz) */
704  REAL8 phiRef, /**< Orbital phase at fRef (rad) */
705  REAL8 fRef_In, /**< Reference frequency (Hz) */
706  LALDict *lalParams /**< Extra params */
707 );
708 
710  COMPLEX16FrequencySeries **htildelm, /**< [out] FD waveform */
711  COMPLEX16FrequencySeries *htilde22, /**< [out] FD waveform */
712  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
713  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
714  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
715  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
716  UINT4 ell, /**< l index of the mode */
717  INT4 emm, /**< m index of the mode */
718  REAL8 distance, /**< Luminosity distance (m) */
719  REAL8 f_min, /**< Starting GW frequency (Hz) */
720  REAL8 f_max, /**< End frequency; 0 defaults to Mf = 0.3 */
721  REAL8 deltaF, /**< Sampling frequency (Hz) */
722  REAL8 phiRef, /**< Orbital phase at fRef (rad) */
723  REAL8 fRef_In, /**< Reference frequency (Hz) */
724  LALDict *lalParams /**< Extra params */
725 );
726 
728  REAL8Sequence **amplitude, /**< [out] FD amp */
729  const REAL8Sequence *freqs, /**< Input Frequency Array (Hz) */
730  UINT4 ell, /**< l index of the mode */
731  INT4 emm, /**< m index of the mode */
732  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
733  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
734  REAL8 S1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
735  REAL8 S1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
736  REAL8 S1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
737  REAL8 S2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
738  REAL8 S2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
739  REAL8 S2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
740  REAL8 distance, /**< Luminosity distance (m) */
741  REAL8 phiRef, /**< Orbital amp at fRef (rad) */
742  REAL8 fRef_In, /**< Reference frequency (Hz) */
743  LALDict *lalParams /**< Extra params */
744 );
745 
747  REAL8Sequence **phase, /**< [out] FD amp */
748  const REAL8Sequence *freqs, /**< Input Frequency Array (Hz) */
749  UINT4 ell, /**< l index of the mode */
750  INT4 emm, /**< m index of the mode */
751  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
752  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
753  REAL8 S1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
754  REAL8 S1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
755  REAL8 S1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
756  REAL8 S2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
757  REAL8 S2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
758  REAL8 S2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
759  REAL8 distance, /**< Luminosity distance (m) */
760  REAL8 phiRef, /**< Orbital amp at fRef (rad) */
761  REAL8 fRef_In, /**< Reference frequency (Hz) */
762  LALDict *lalParams /**< Extra params */
763  );
764 
765 
767  REAL8Sequence **phase, /**< [out] FD waveform */
768  const REAL8Sequence *freqs_In, /**< frequency array to evaluate model (positives) */
769  UINT4 ell, /**< l index of the mode */
770  INT4 emm, /**< m index of the mode */
771  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
772  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
773  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
774  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
775  REAL8 distance, /**< Luminosity distance (m) */
776  REAL8 phiRef, /**< Orbital phase at fRef (rad) */
777  REAL8 fRef_In, /**< Reference frequency (Hz) */
778  LALDict *lalParams /**< UNDOCUMENTED */
779 );
780 
782  REAL8Sequence **amp, /**< [out] FD waveform */
783  const REAL8Sequence *freqs_In, /**< frequency array to evaluate model (positives) */
784  UINT4 ell, /**< l index of the mode */
785  INT4 emm, /**< m index of the mode */
786  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
787  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
788  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
789  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
790  REAL8 distance, /**< Luminosity distance (m) */
791  REAL8 phiRef, /**< Orbital phase at fRef (rad) */
792  REAL8 fRef_In, /**< Reference frequency (Hz) */
793  LALDict *lalParams /**< UNDOCUMENTED */
794 );
795 
797  COMPLEX16FrequencySeries **hptilde, /**< [out] Frequency-domain waveform h+ */
798  COMPLEX16FrequencySeries **hctilde, /**< [out] Frequency-domain waveform hx */
799  REAL8 m1_SI, /**< mass of companion 1 (kg) */
800  REAL8 m2_SI, /**< mass of companion 2 (kg) */
801  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
802  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
803  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
804  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
805  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
806  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
807  REAL8 distance, /**< Distance of source (m) */
808  REAL8 inclination, /**< inclination of source (rad) */
809  REAL8 phiRef, /**< Orbital phase (rad) at reference frequency */
810  REAL8 f_min, /**< Starting GW frequency (Hz) */
811  REAL8 f_max, /**< Ending GW frequency (Hz); Defaults to Mf = 0.3 if no f_max is specified. */
812  REAL8 deltaF, /**< Sampling frequency (Hz). To use non-uniform frequency grid, set deltaF <= 0. */
813  REAL8 fRef_In, /**< Reference frequency (Hz) */
814  LALDict *lalParams /**< LAL Dictionary struct */
815 );
816 
818 COMPLEX16FrequencySeries **hptilde, /**< [out] Frequency-domain waveform h+ */
819 COMPLEX16FrequencySeries **hctilde, /**< [out] Frequency-domain waveform hx */
820 REAL8 m1_SI, /**< mass of companion 1 (kg) */
821 REAL8 m2_SI, /**< mass of companion 2 (kg) */
822 REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
823 REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
824 REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
825 REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
826 REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
827 REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
828 const REAL8 distance, /**< Distance of source (m) */
829 const REAL8 inclination, /**< inclination of source (rad) */
830 const REAL8 phiRef, /**< Orbital phase (rad) at reference frequency */
831 REAL8 f_min, /**< Starting GW frequency (Hz) */
832 REAL8 f_max, /**< Ending GW frequency (Hz); Defaults to Mf = 0.3 if no f_max is specified. */
833 const REAL8 deltaF, /**< Sampling frequency (Hz). To use non-uniform frequency grid, set deltaF <= 0. */
834 REAL8 fRef_In, /**< Reference frequency (Hz) */
835 LALDict *lalParams /**< LAL Dictionary struct */
836 );
837 
839  COMPLEX16FrequencySeries **hptilde, /**< [out] Frequency-domain waveform h+ */
840  COMPLEX16FrequencySeries **hctilde, /**< [out] Frequency-domain waveform hx */
841  const REAL8Sequence *freqs, /**< Input Frequency series [Hz] */
842  REAL8 m1_SI, /**< mass of companion 1 (kg) */
843  REAL8 m2_SI, /**< mass of companion 2 (kg) */
844  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
845  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
846  REAL8 distance, /**< Distance of source (m) */
847  REAL8 inclination, /**< inclination of source (rad) */
848  REAL8 phiRef, /**< Orbital phase (rad) at reference frequency */
849  REAL8 fRef, /**< Reference frequency (Hz) */
850  LALDict *lalParams /**< LAL Dictionary struct */
851 );
852 
854  COMPLEX16FrequencySeries **hptilde, /**< [out] Frequency-domain waveform h+ */
855  COMPLEX16FrequencySeries **hctilde, /**< [out] Frequency-domain waveform hx */
856  const REAL8Sequence *freqs, /**< input frequency series [Hz] */
857  REAL8 m1_SI, /**< mass of companion 1 (kg) */
858  REAL8 m2_SI, /**< mass of companion 2 (kg) */
859  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
860  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
861  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
862  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
863  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
864  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
865  REAL8 distance, /**< Distance of source (m) */
866  REAL8 inclination, /**< inclination of source (rad) */
867  REAL8 phiRef, /**< Orbital phase (rad) at reference frequency */
868  REAL8 fRef_In, /**< Reference frequency (Hz) */
869  LALDict *lalParams /**< LAL Dictionary struct */
870 );
871 
873  COMPLEX16FrequencySeries **hlmpos, /**< [out] Frequency-domain waveform hlm inertial frame positive frequencies */
874  COMPLEX16FrequencySeries **hlmneg, /**< [out] Frequency-domain waveform hlm inertial frame negative frequencies */
875  const UINT4 l, /**< First index of the (l,m) precessing mode */
876  const INT4 m, /**< Second index of the (l,m) precessing mode */
877  REAL8 m1_SI, /**< mass of companion 1 (kg) */
878  REAL8 m2_SI, /**< mass of companion 2 (kg) */
879  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
880  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
881  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
882  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
883  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
884  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
885  const REAL8 distance, /**< distance of source (m) */
886  const REAL8 inclination, /**< inclination of source (rad) */
887  const REAL8 phiRef, /**< reference orbital phase (rad) */
888  const REAL8 deltaF, /**< Sampling frequency (Hz) */
889  const REAL8 f_min, /**< Starting GW frequency (Hz) */
890  const REAL8 f_max, /**< End frequency; 0 defaults to ringdown cutoff freq */
891  const REAL8 fRef_In, /**< Reference frequency */
892  LALDict *lalParams /**<LAL Dictionary */
893 );
894 
896  COMPLEX16FrequencySeries **hlmpos, /**< [out] Frequency-domain waveform hlm inertial frame positive frequencies */
897  COMPLEX16FrequencySeries **hlmneg, /**< [out] Frequency-domain waveform hlm inertial frame negative frequencies */
898  const REAL8Sequence *freqs, /**< Input Frequency series [Hz] */
899  const UINT4 l, /**< First index of the (l,m) precessing mode */
900  const INT4 m, /**< Second index of the (l,m) precessing mode */
901  REAL8 m1_SI, /**< mass of companion 1 (kg) */
902  REAL8 m2_SI, /**< mass of companion 2 (kg) */
903  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
904  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
905  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
906  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
907  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
908  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
909  const REAL8 distance, /**< distance of source (m) */
910  const REAL8 inclination, /**< inclination of source (rad) */
911  const REAL8 phiRef, /**< reference orbital phase (rad) */
912  const REAL8 fRef_In, /**< Reference frequency */
913  LALDict *lalParams /**<LAL Dictionary */
914 );
915 
916 
917 
919  SphHarmFrequencySeries **hlms, /**< [out] list with single modes h_lm in the J-frame */
920  REAL8 m1_SI, /**< mass of companion 1 (kg) */
921  REAL8 m2_SI, /**< mass of companion 2 (kg) */
922  REAL8 S1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
923  REAL8 S1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
924  REAL8 S1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
925  REAL8 S2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
926  REAL8 S2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
927  REAL8 S2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
928  REAL8 deltaF, /**< frequency spacing (Hz) */
929  REAL8 f_min, /**< starting GW frequency (Hz) */
930  REAL8 f_max, /**< ending GW frequency (Hz) */
931  REAL8 f_ref, /**< reference GW frequency (Hz) */
932  REAL8 phiRef, /**< phase shift at reference frequency */
933  REAL8 distance, /**< distance of source (m) */
934  REAL8 inclination, /**< inclination of source (rad) */
935  LALDict *LALparams /**< LAL dictionary with extra options */
936 );
937 
938 /*
939  XLAL routine to calculate the IMRPhenomX mode parameters from the source frame.
940  Note that this is just an IMRPhenomX compatible implementation of:
941 
942  XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame
943 */
945  REAL8 *chi1L, /**< [out] Dimensionless aligned spin on companion 1 */
946  REAL8 *chi2L, /**< [out] Dimensionless aligned spin on companion 2 */
947  REAL8 *chi_p, /**< [out] Effective spin in the orbital plane */
948  REAL8 *thetaJN, /**< [out] Angle between J0 and line of sight (z-direction) */
949  REAL8 *alpha0, /**< [out] Initial value of alpha angle (azimuthal precession angle) */
950  REAL8 *phi_aligned, /**< [out] Initial phase to feed the underlying aligned-spin model */
951  REAL8 *zeta_polarization, /**< [out] Angle to rotate the polarizations */
952  const REAL8 m1_SI, /**< Mass of companion 1 (kg) */
953  const REAL8 m2_SI, /**< Mass of companion 2 (kg) */
954  const REAL8 f_ref, /**< Reference GW frequency (Hz) */
955  const REAL8 phiRef, /**< Reference phase */
956  const REAL8 incl, /**< Inclination : angle between LN and the line of sight */
957  const REAL8 s1x, /**< Initial value of s1x: dimensionless spin of BH 1 */
958  const REAL8 s1y, /**< Initial value of s1y: dimensionless spin of BH 1 */
959  const REAL8 s1z, /**< Initial value of s1z: dimensionless spin of BH 1 */
960  const REAL8 s2x, /**< Initial value of s2x: dimensionless spin of BH 2 */
961  const REAL8 s2y, /**< Initial value of s2y: dimensionless spin of BH 2 */
962  const REAL8 s2z, /**< Initial value of s2z: dimensionless spin of BH 2 */
963  LALDict *lalParams /**< LAL Dictionary */
964 );
965 
967  REAL8Sequence **alphaPNR, /**< [out] alpha angle series */
968  REAL8Sequence **betaPNR, /**< [out] beta angle series */
969  REAL8Sequence **gammaPNR, /**< [out] gamma angle series */
970  REAL8Sequence **freqs, /**< [out] frequency series */
971  REAL8 *alphaPNR_ref, /**< alpha angle at reference frequency */
972  REAL8 *gammaPNR_ref, /**< gamma angle at reference frequency */
973  REAL8 m1_SI, /**< mass of companion 1 (kg) */
974  REAL8 m2_SI, /**< mass of companion 2 (kg) */
975  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
976  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
977  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
978  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
979  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
980  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
981  REAL8 inclination, /**< Inclination : angle between LN and the line of sight */
982  REAL8 deltaF, /**< frequency spacing (Hz) */
983  REAL8 f_min, /**< Starting GW frequency (Hz) */
984  REAL8 f_max, /**< Ending GW frequency (Hz); Defaults to Mf = 0.3 if no f_max is specified. */
985  REAL8 fRef_In, /**< Reference frequency (Hz) */
986  LALDict *lalParams /**< LAL Dictionary struct */
987 );
988 
990  REAL8Sequence **alphaPNR, /**< [out] alpha angle series */
991  REAL8Sequence **betaPNR, /**< [out] beta angle series */
992  REAL8Sequence **gammaPNR, /**< [out] gamma angle series */
993  REAL8Sequence **freqs, /**< [out] frequency series */
994  REAL8 *alphaPNR_ref, /**< alpha angle at reference frequency */
995  REAL8 *gammaPNR_ref, /**< gamma angle at reference frequency */
996  REAL8 m1_SI, /**< mass of companion 1 (kg) */
997  REAL8 m2_SI, /**< mass of companion 2 (kg) */
998  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
999  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1000  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1001  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1002  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1003  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1004  REAL8 inclination, /**< Inclination : angle between LN and the line of sight */
1005  REAL8 deltaF, /**< frequency spacing (Hz) */
1006  REAL8 f_min, /**< Starting GW frequency (Hz) */
1007  REAL8 f_max, /**< Ending GW frequency (Hz); Defaults to Mf = 0.3 if no f_max is specified. */
1008  REAL8 fRef_In, /**< Reference frequency (Hz) */
1009  INT4 ell, /**< First index of the (l,m) mode */
1010  INT4 emmprime, /**< Second index of the (l,m) mode */
1011  LALDict *lalParams /**< LAL Dictionary struct */
1012 );
1013 
1015  INT4 *twospin,/**< Tell if the system is double spin */
1016  INT4 *precversion,/**< precessing version */
1017  REAL8 *deltaF,/**< frequency spacing (Hz) */
1018  REAL8 m1_SI, /**< mass of companion 1 (kg) */
1019  REAL8 m2_SI, /**< mass of companion 2 (kg) */
1020  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1021  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1022  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1023  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1024  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1025  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1026  REAL8 f_min, /**< Starting GW frequency (Hz) */
1027  REAL8 f_max, /**< Ending GW frequency (Hz); Defaults to Mf = 0.3 if no f_max is specified. */
1028  REAL8 fRef, /**< Reference frequency (Hz) */
1029  LALDict *lalParams /**< LAL Dictionary struct */);
1030 
1032  REAL8 m1_SI, /**< mass of companion 1 (kg) */
1033  REAL8 m2_SI, /**< mass of companion 2 (kg) */
1034  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1035  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1036  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1037  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1038  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1039  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1040  REAL8 f_min, /**< Starting GW frequency (Hz) */
1041  REAL8 f_max, /**< Ending GW frequency (Hz); Defaults to Mf = 0.3 if no f_max is specified. */
1042  REAL8 fRef, /**< Reference frequency (Hz) */
1043  UINT4 ell, /**< First index of the (l,m) mode */
1044  UINT4 emmprime, /**< Second index of the (l,m) mode */
1045  LALDict *lalParams /**< LAL Dictionary struct */
1046  );
1047 
1049  REAL8 m1_SI, /**< mass of companion 1 (kg) */
1050  REAL8 m2_SI, /**< mass of companion 2 (kg) */
1051  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1052  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1053  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1054  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1055  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1056  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1057  REAL8 deltaF, /**< frequency spacing (Hz) */
1058  REAL8 f_min, /**< Starting GW frequency (Hz) */
1059  REAL8 f_max, /**< Ending GW frequency (Hz); Defaults to Mf = 0.3 if no f_max is specified. */
1060  REAL8 fRef_In, /**< Reference frequency (Hz) */
1061  LALDict *lalParams /**< LAL Dictionary struct */
1062  );
1063 
1064 
1066  REAL8Sequence **antisymamp, /**< antisymmetric to symmetric waveform amplitude */
1067  REAL8Sequence **antisymphase, /**< antisymmetric to symmetric waveform phase */
1068  REAL8 m1_SI, /**< mass of companion 1 (kg) */
1069  REAL8 m2_SI, /**< mass of companion 2 (kg) */
1070  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1071  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1072  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1073  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1074  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1075  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1076  REAL8 distance, /**< Luminosity distance (m) */
1077  REAL8 inclination, /**< Angle between orbital angular momentum and line-of-sight vector at reference frequency (rad) */
1078  REAL8 deltaF, /**< Frequency spacing (Hz) */
1079  REAL8 f_min, /**< Starting GW frequency (Hz) */
1080  REAL8 f_max, /**< Ending GW frequency (Hz) */
1081  REAL8 fRef_In, /**< Reference frequency (Hz) */
1082  REAL8 phiRef, /**< phase at reference frequency (Hz) */
1083  LALDict *lalParams /**< LAL Dictionary struct */
1084  );
1085 
1087  REAL8Sequence **kappa, /**< antisymmetric to symmetric waveform amplitude ratio*/
1088  REAL8Sequence **freqs, /**< [out] Frequency array (Hz) */
1089  REAL8 m1_SI, /**< mass of companion 1 (kg) */
1090  REAL8 m2_SI, /**< mass of companion 2 (kg) */
1091  REAL8 chi1x, /**< x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1092  REAL8 chi1y, /**< y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1093  REAL8 chi1z, /**< z-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1) */
1094  REAL8 chi2x, /**< x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1095  REAL8 chi2y, /**< y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1096  REAL8 chi2z, /**< z-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1) */
1097  REAL8 inclination, /**< Angle between orbital angular momentum and line-of-sight vector at reference frequency (rad) */
1098  REAL8 deltaF, /**< Frequency spacing (Hz) */
1099  REAL8 f_min, /**< Starting GW frequency (Hz) */
1100  REAL8 f_max, /**< Ending GW frequency (Hz) */
1101  REAL8 fRef_In, /**< Reference frequency (Hz) */
1102  LALDict *lalParams /**< LAL Dictionary struct */
1103 );
1104 
1105 
1106 /* IMRPhenomT/HM Routines */
1107 /* in module LALSimIMRPhenomTHM.c */
1108 
1110  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1111  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1112  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
1113  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
1114  REAL8 distance, /**< Luminosity distance (m) */
1115  REAL8 deltaT, /**< inclination of source (rad) */
1116  REAL8 fmin, /**< sampling interval (s) */
1117  REAL8 fRef, /**< reference GW frequency (Hz) */
1118  REAL8 phiRef, /**< reference orbital phase (rad) */
1119  LALDict *lalParams /**< LAL dictionary containing accessory parameters */
1120  );
1121 
1123  REAL8TimeSeries **hp, /**< [out] TD waveform for plus polarisation */
1124  REAL8TimeSeries **hc, /**< [out] TD waveform for cross polarisation */
1125  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1126  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1127  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
1128  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
1129  REAL8 distance, /**< Luminosity distance (m) */
1130  REAL8 inclination, /**< inclination of source (rad) */
1131  REAL8 deltaT, /**< sampling interval (s) */
1132  REAL8 fmin, /**< starting GW frequency (Hz) */
1133  REAL8 fRef, /**< reference GW frequency (Hz) */
1134  REAL8 phiRef, /**< reference orbital phase (rad) */
1135  LALDict *lalparams /**< LAL dictionary containing accessory parameters */
1136  );
1137 
1138 int XLALSimIMRPhenomT(
1139  REAL8TimeSeries **hp, /**< [out] TD waveform for plus polarisation */
1140  REAL8TimeSeries **hc, /**< [out] TD waveform for cross polarisation */
1141  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1142  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1143  REAL8 chi1L, /**< Dimensionless aligned spin of companion 1 */
1144  REAL8 chi2L, /**< Dimensionless aligned spin of companion 2 */
1145  REAL8 distance, /**< Luminosity distance (m) */
1146  REAL8 inclination, /**< inclination of source (rad) */
1147  REAL8 deltaT, /**< sampling interval (s) */
1148  REAL8 fmin, /**< starting GW frequency (Hz) */
1149  REAL8 fRef, /**< reference GW frequency (Hz) */
1150  REAL8 phiRef, /**< reference orbital phase (rad) */
1151  LALDict *lalParams /**< LAL dictionary containing accessory parameters */
1152  );
1153 
1154 /* IMRPhenomTPHM Routines */
1155 /* in module LALSimIMRPhenomTPHM.c */
1156 
1157 int XLALSimIMRPhenomTP(
1158  REAL8TimeSeries **hp, /**< [out] TD waveform for plus polarisation */
1159  REAL8TimeSeries **hc, /**< [out] TD waveform for cross polarisation */
1160  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1161  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1162  REAL8 chi1x, /**< x component of primary spin*/
1163  REAL8 chi1y, /**< y component of primary spin*/
1164  REAL8 chi1z, /**< z component of primary spin */
1165  REAL8 chi2x, /**< x component of secondary spin*/
1166  REAL8 chi2y, /**< y component of secondary spin*/
1167  REAL8 chi2z, /**< z component of secondary spin */
1168  REAL8 distance, /**< Luminosity distance (m) */
1169  REAL8 inclination, /**< inclination (in rad) */
1170  REAL8 deltaT, /**< sampling interval (s) */
1171  REAL8 fmin, /**< starting GW frequency (Hz) */
1172  REAL8 fRef, /**< reference GW frequency (Hz) */
1173  REAL8 phiRef, /**< reference orbital phase (rad) */
1174  LALDict *lalParams /**< LAL dictionary containing accessory parameters */
1175  );
1176 
1178  REAL8TimeSeries **hp, /**< [out] TD waveform for plus polarisation */
1179  REAL8TimeSeries **hc, /**< [out] TD waveform for cross polarisation */
1180  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1181  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1182  REAL8 chi1x, /**< x component of primary spin*/
1183  REAL8 chi1y, /**< y component of primary spin*/
1184  REAL8 chi1z, /**< z component of primary spin */
1185  REAL8 chi2x, /**< x component of secondary spin*/
1186  REAL8 chi2y, /**< y component of secondary spin*/
1187  REAL8 chi2z, /**< z component of secondary spin */
1188  REAL8 distance, /**< Luminosity distance (m) */
1189  REAL8 inclination, /**< inclination (in rad) */
1190  REAL8 deltaT, /**< sampling interval (s) */
1191  REAL8 fmin, /**< starting GW frequency (Hz) */
1192  REAL8 fRef, /**< reference GW frequency (Hz) */
1193  REAL8 phiRef, /**< reference orbital phase (rad) */
1194  LALDict *lalParams /**< LAL dictionary containing accessory parameters */
1195  );
1196 
1198  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1199  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1200  REAL8 chi1x, /**< x component of primary spin*/
1201  REAL8 chi1y, /**< y component of primary spin*/
1202  REAL8 chi1z, /**< z component of primary spin */
1203  REAL8 chi2x, /**< x component of secondary spin*/
1204  REAL8 chi2y, /**< y component of secondary spin*/
1205  REAL8 chi2z, /**< z component of secondary spin */
1206  REAL8 distance, /**< Luminosity distance (m) */
1207  REAL8 deltaT, /**< sampling interval (s) */
1208  REAL8 fmin, /**< starting GW frequency (Hz) */
1209  REAL8 fRef, /**< reference GW frequency (Hz) */
1210  LALDict *lalParams /**< LAL dictionary containing accessory parameters */
1211  );
1212 
1214  SphHarmTimeSeries **hlmI, /**< [out] Modes in the intertial L0=z frame*/
1215  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1216  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1217  REAL8 chi1x, /**< x component of primary spin*/
1218  REAL8 chi1y, /**< y component of primary spin*/
1219  REAL8 chi1z, /**< z component of primary spin */
1220  REAL8 chi2x, /**< x component of secondary spin*/
1221  REAL8 chi2y, /**< y component of secondary spin*/
1222  REAL8 chi2z, /**< z component of secondary spin */
1223  REAL8 distance, /**< Luminosity distance (m) */
1224  REAL8 inclination, /**< inclination (in rad) */
1225  REAL8 deltaT, /**< sampling interval (s) */
1226  REAL8 fmin, /**< starting GW frequency (Hz) */
1227  REAL8 fRef, /**< reference GW frequency (Hz) */
1228  REAL8 phiRef, /**< reference orbital phase (rad) */
1229  LALDict *lalParams, /**< LAL dictionary containing accessory parameters */
1230  UINT4 only22 /**< Flag for calling only IMRPhenomTP (dominant 22 coprec mode only) */
1231  );
1232 
1234  SphHarmTimeSeries **hlmJ, /**< [out] Modes in the intertial J0=z frame*/
1235  REAL8TimeSeries **alphaTS, /**< [out] Precessing Euler angle alpha */
1236  REAL8TimeSeries **cosbetaTS, /**< [out] cosinus of Precessing Euler angle beta */
1237  REAL8TimeSeries **gammaTS, /**< [out] Precessing Euler angle gamma */
1238  REAL8 *af, /**< [out] Final spin */
1239  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1240  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1241  REAL8 chi1x, /**< x component of primary spin*/
1242  REAL8 chi1y, /**< y component of primary spin*/
1243  REAL8 chi1z, /**< z component of primary spin */
1244  REAL8 chi2x, /**< x component of secondary spin*/
1245  REAL8 chi2y, /**< y component of secondary spin*/
1246  REAL8 chi2z, /**< z component of secondary spin */
1247  REAL8 distance, /**< Luminosity distance (m) */
1248  REAL8 inclination, /**< inclination (in rad) */
1249  REAL8 deltaT, /**< sampling interval (s) */
1250  REAL8 fmin, /**< starting GW frequency (Hz) */
1251  REAL8 fRef, /**< reference GW frequency (Hz) */
1252  REAL8 phiRef, /**< reference orbital phase (rad) */
1253  LALDict *lalParams, /**< LAL dictionary containing accessory parameters */
1254  UINT4 only22 /**< Flag for calling only IMRPhenomTP (dominant 22 coprec mode only) */
1255  );
1256 
1258  REAL8TimeSeries **V, /**< post-Newtonian parameter [returned]*/
1259  REAL8TimeSeries **S1x, /**< Spin1 vector x component [returned]*/
1260  REAL8TimeSeries **S1y, /**< " " " y component [returned]*/
1261  REAL8TimeSeries **S1z, /**< " " " z component [returned]*/
1262  REAL8TimeSeries **S2x, /**< Spin2 vector x component [returned]*/
1263  REAL8TimeSeries **S2y, /**< " " " y component [returned]*/
1264  REAL8TimeSeries **S2z, /**< " " " z component [returned]*/
1265  REAL8TimeSeries **LNhatx, /**< unit orbital ang. mom. x [returned]*/
1266  REAL8TimeSeries **LNhaty, /**< " " " y component [returned]*/
1267  REAL8TimeSeries **LNhatz, /**< " " " z component [returned]*/
1268  REAL8TimeSeries **E1x, /**< orb. plane basis vector x[returned]*/
1269  REAL8TimeSeries **E1y, /**< " " " y component [returned]*/
1270  REAL8TimeSeries **E1z, /**< " " " z component [returned]*/
1271  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1272  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1273  REAL8 chi1x, /**< x component of primary spin*/
1274  REAL8 chi1y, /**< y component of primary spin*/
1275  REAL8 chi1z, /**< z component of primary spin */
1276  REAL8 chi2x, /**< x component of secondary spin*/
1277  REAL8 chi2y, /**< y component of secondary spin*/
1278  REAL8 chi2z, /**< z component of secondary spin */
1279  REAL8 deltaT, /**< sampling interval (s) */
1280  REAL8 fmin, /**< starting GW frequency (Hz) */
1281  REAL8 fRef, /**< reference GW frequency (Hz) */
1282  REAL8 phiRef, /**< reference orbital phase (rad) */
1283  LALDict *lalParams /**< LAL dictionary containing accessory parameters */
1284  );
1285 
1287  SphHarmTimeSeries **hlmJ, /**< [out] Modes in the intertial J0=z frame*/
1288  REAL8TimeSeries **alphaTS, /**< [out] Precessing Euler angle alpha */
1289  REAL8TimeSeries **cosbetaTS, /**< [out] Precessing Euler angle beta */
1290  REAL8TimeSeries **gammaTS, /**< [out] Precessing Euler angle gamma */
1291  REAL8 *af, /**< [out] Final spin */
1292  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1293  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1294  REAL8 chi1x, /**< x component of primary spin*/
1295  REAL8 chi1y, /**< y component of primary spin*/
1296  REAL8 chi1z, /**< z component of primary spin */
1297  REAL8 chi2x, /**< x component of secondary spin*/
1298  REAL8 chi2y, /**< y component of secondary spin*/
1299  REAL8 chi2z, /**< z component of secondary spin */
1300  REAL8 distance, /**< Luminosity distance (m) */
1301  REAL8 inclination, /**< inclination (in rad) */
1302  REAL8 deltaT, /**< sampling interval (s) */
1303  REAL8 fmin, /**< starting GW frequency (Hz) */
1304  REAL8 fRef, /**< reference GW frequency (Hz) */
1305  REAL8 phiRef, /**< reference orbital phase (rad) */
1306  LALDict *lalParams, /**< LAL dictionary containing accessory parameters */
1307  UINT4 only22 /**< Flag for calling only IMRPhenomTP (dominant 22 coprec mode only) */
1308  );
1309 
1310 
1311 /* in module LALSimIMRTEOBResumS.c */
1312 
1314  REAL8TimeSeries **hplus,
1315  REAL8TimeSeries **hcross,
1316  const REAL8 phiRef,
1317  const REAL8 deltaT,
1318  const REAL8 m1,
1319  const REAL8 m2,
1320  const REAL8 S1x,
1321  const REAL8 S1y,
1322  const REAL8 S1z,
1323  const REAL8 S2x,
1324  const REAL8 S2y,
1325  const REAL8 S2z,
1326  const REAL8 lambda1,
1327  const REAL8 lambda2,
1328  const REAL8 distance,
1329  const REAL8 inclination,
1330  const REAL8 longAscNodes,
1331  LALDict *LALparams,
1332  const REAL8 eccentricity,
1333  const REAL8 meanPerAno,
1334  const REAL8 f_min,
1335  const REAL8 f_ref
1336  );
1337 
1338 
1339 /* in module LALSimInspiralNRWaveforms.c */
1340 
1342  REAL8 *S1x, /**< [out] Dimensionless spin1x in LAL frame */
1343  REAL8 *S1y, /**< [out] Dimensionless spin1y in LAL frame */
1344  REAL8 *S1z, /**< [out] Dimensionless spin1z in LAL frame */
1345  REAL8 *S2x, /**< [out] Dimensionless spin2x in LAL frame */
1346  REAL8 *S2y, /**< [out] Dimensionless spin2y in LAL frame */
1347  REAL8 *S2z, /**< [out] Dimensionless spin2z in LAL frame */
1348  REAL8 fRef, /**< Reference frequency */
1349  REAL8 mTot, /**< Total mass */
1350  const char *NRDataFile /**< Location of NR HDF file */
1351 );
1352 
1353 /* The following XLALSimInspiralNRWaveformGetHplusHcross() generates polarizations
1354  * reading directly the NR files and does not return l,m modes.
1355  */
1357  REAL8TimeSeries **hplus, /**< OUTPUT h_+ vector */
1358  REAL8TimeSeries **hcross, /**< OUTPUT h_x vector */
1359  REAL8 phiRef, /**< orbital phase at reference pt. */
1360  REAL8 inclination, /**< inclination angle */
1361  REAL8 deltaT, /**< sampling interval (s) */
1362  REAL8 m1, /**< mass of companion 1 (kg) */
1363  REAL8 m2, /**< mass of companion 2 (kg) */
1364  REAL8 r, /**< distance of source (m) */
1365  REAL8 fStart, /**< start GW frequency (Hz) */
1366  REAL8 fRef, /**< reference GW frequency (Hz) */
1367  REAL8 s1x, /**< initial value of S1x */
1368  REAL8 s1y, /**< initial value of S1y */
1369  REAL8 s1z, /**< initial value of S1z */
1370  REAL8 s2x, /**< initial value of S2x */
1371  REAL8 s2y, /**< initial value of S2y */
1372  REAL8 s2z, /**< initial value of S2z */
1373  const char *NRDataFile, /**< Location of NR HDF file */
1374  LALValue* ModeArray /**< Container for the ell and m modes to generate. To generate all available modes pass NULL */
1375  );
1376 
1377 /* The following XLALSimInspiralNRWaveformGetHlms() reads NR file to output l,m modes.
1378  */
1380  REAL8 deltaT, /**< sampling interval (s) */
1381  REAL8 m1, /**< mass of companion 1 (kg) */
1382  REAL8 m2, /**< mass of companion 2 (kg) */
1383  REAL8 r, /**< distance of source (m) */
1384  REAL8 fStart, /**< start GW frequency (Hz) */
1385  REAL8 fRef, /**< reference GW frequency (Hz) */
1386  REAL8 s1x, /**< initial value of S1x */
1387  REAL8 s1y, /**< initial value of S1y */
1388  REAL8 s1z, /**< initial value of S1z */
1389  REAL8 s2x, /**< initial value of S2x */
1390  REAL8 s2y, /**< initial value of S2y */
1391  REAL8 s2z, /**< initial value of S2z */
1392  const char *NRDataFile, /**< Location of NR HDF file */
1393  LALValue* ModeArray /**< Container for the ell and m modes to generate. To generate all available modes pass NULL */
1394  );
1395 
1396 /* in module LALSimIMRPrecessingNRSur.c */
1397 
1399  REAL8TimeSeries **hplus, /**< OUTPUT h_+ vector */
1400  REAL8TimeSeries **hcross, /**< OUTPUT h_x vector */
1401  REAL8 phiRef, /**< azimuthal angle for Ylms */
1402  REAL8 inclination, /**< inclination angle */
1403  REAL8 deltaT, /**< sampling interval (s) */
1404  REAL8 m1, /**< mass of companion 1 (kg) */
1405  REAL8 m2, /**< mass of companion 2 (kg) */
1406  REAL8 distnace, /**< distance of source (m) */
1407  REAL8 fMin, /**< start GW frequency (Hz) */
1408  REAL8 fRef, /**< reference GW frequency (Hz) */
1409  REAL8 s1x, /**< reference value of S1x */
1410  REAL8 s1y, /**< reference value of S1y */
1411  REAL8 s1z, /**< reference value of S1z */
1412  REAL8 s2x, /**< reference value of S2x */
1413  REAL8 s2y, /**< reference value of S2y */
1414  REAL8 s2z, /**< reference value of S2z */
1415  LALDict* LALparams, /**< Dict with extra parameters */
1416  Approximant approximant /**< approximant (NRSur7dq2 or NRSur7dq4) */
1417 
1418 );
1419 
1421  REAL8 deltaT, /**< sampling interval (s) */
1422  REAL8 m1, /**< mass of companion 1 (kg) */
1423  REAL8 m2, /**< mass of companion 2 (kg) */
1424  REAL8 S1x, /**< x-component of the dimensionless spin of object 1 */
1425  REAL8 S1y, /**< y-component of the dimensionless spin of object 1 */
1426  REAL8 S1z, /**< z-component of the dimensionless spin of object 1 */
1427  REAL8 S2x, /**< x-component of the dimensionless spin of object 2 */
1428  REAL8 S2y, /**< y-component of the dimensionless spin of object 2 */
1429  REAL8 S2z, /**< z-component of the dimensionless spin of object 2 */
1430  REAL8 fMin, /**< start GW frequency (Hz) */
1431  REAL8 fRef, /**< reference GW frequency (Hz) */
1432  REAL8 distance, /**< distance of source (m) */
1433  LALDict* LALparams, /**< Dict with extra parameters */
1434  Approximant approximant /**< approximant (NRSur7dq2 or NRSur7dq4) */
1435 );
1436 
1438  gsl_vector **t_dynamics, /**< Output: Time array at which the dynamics are returned. */
1439  gsl_vector **quat0, /**< Output: Time series of 0th index of coprecessing frame quaternion. */
1440  gsl_vector **quat1, /**< Output: Time series of 1st index of coprecessing frame quaternion. */
1441  gsl_vector **quat2, /**< Output: Time series of 2nd index of coprecessing frame quaternion. */
1442  gsl_vector **quat3, /**< Output: Time series of 3rd index of coprecessing frame quaternion. */
1443  gsl_vector **orbphase, /**< Output: Time series of orbital phase in the coprecessing frame. */
1444  gsl_vector **chiAx, /**< Output: Time series of x-comp of dimensionless spin of BhA in the coprecessing frame. */
1445  gsl_vector **chiAy, /**< Output: Time series of y-comp of dimensionless spin of BhA in the coprecessing frame. */
1446  gsl_vector **chiAz, /**< Output: Time series of z-comp of dimensionless spin of BhA in the coprecessing frame. */
1447  gsl_vector **chiBx, /**< Output: Time series of x-comp of dimensionless spin of BhB in the coprecessing frame. */
1448  gsl_vector **chiBy, /**< Output: Time series of y-comp of dimensionless spin of BhB in the coprecessing frame. */
1449  gsl_vector **chiBz, /**< Output: Time series of z-comp of dimensionless spin of BhB in the coprecessing frame. */
1450  REAL8 q, /**< mass ratio m1/m2 >= 1. */
1451  REAL8 chiA0x, /**< x-comp of dimensionless spin of BhA in the coorbital frame at the reference epoch. */
1452  REAL8 chiA0y, /**< y-comp of dimensionless spin of BhA in the coorbital frame at the reference epoch. */
1453  REAL8 chiA0z, /**< z-comp of dimensionless spin of BhA in the coorbital frame at the reference epoch. */
1454  REAL8 chiB0x, /**< x-comp of dimensionless spin of BhB in the coorbital frame at the reference epoch. */
1455  REAL8 chiB0y, /**< y-comp of dimensionless spin of BhB in the coorbital frame at the reference epoch. */
1456  REAL8 chiB0z, /**< z-comp of dimensionless spin of BhB in the coorbital frame at the reference epoch. */
1457  REAL8 omegaRef_dimless, /**< Dimensionless orbital frequency (rad/M) in the coprecessing frame at the reference epoch.*/
1458  REAL8 init_quat0, /**< 0th comp of the coprecessing frame quaternion at the reference epoch.*/
1459  REAL8 init_quat1, /**< 1st comp of the coprecessing frame quaternion at the reference epoch.*/
1460  REAL8 init_quat2, /**< 2nd comp of the coprecessing frame quaternion at the reference epoch.*/
1461  REAL8 init_quat3, /**< 3rd comp of the coprecessing frame quaternion at the reference epoch.*/
1462  REAL8 init_orbphase, /**< orbital phase in the coprecessing frame at the reference epoch. */
1463  LALDict* LALparams, /**< Dict with extra parameters. */
1464  Approximant approximant /**< approximant (NRSur7dq2 or NRSur7dq4). */
1465 );
1466 
1467 /* in module LALSimNRSur7dq4Remnant.c */
1469  gsl_vector **result, /**<Output: The requested remnant property. */
1470  REAL8 q, /**< Mass ratio of Bh1/Bh2. q>=1. */
1471  REAL8 s1x, /**< S1x in coorbital frame at t=-100M */
1472  REAL8 s1y, /**< S1y in coorbital frame at t=-100M */
1473  REAL8 s1z, /**< S1z in coorbital frame at t=-100M */
1474  REAL8 s2x, /**< S2x in coorbital frame at t=-100M */
1475  REAL8 s2y, /**< S2y in coorbital frame at t=-100M */
1476  REAL8 s2z, /**< S2z in coorbital frame at t=-100M */
1477  char *remnant_property, /**< One of "mf", "chif" or "vf" */
1478  LALDict* LALparams /**< Dict with extra parameters */
1479 );
1480 
1481 /* in module LALSimNRSur3dq8Remnant.c */
1483  REAL8 *result, /**<Output: The requested remnant property. */
1484  REAL8 q, /**< Mass ratio of Bh1/Bh2. q>=1. */
1485  REAL8 s1z, /**< S1z z-spin of Bh1 */
1486  REAL8 s2z, /**< S2z z-spin of Bh2 */
1487  char *remnant_property, /**< One of "mf", "chifz", "vfx" or "vfy" */
1488  LALDict* LALparams /**< Dict with extra parameters */
1489 );
1490 
1491 /* in module LALSimNRTunedTides.c */
1493  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1494  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1495  REAL8 lambda1, /**< (tidal deformability of mass 1) / m1^5 (dimensionless) */
1496  REAL8 lambda2 /**< (tidal deformability of mass 2) / m2^5 (dimensionless) */
1497 );
1498 
1500  const REAL8 mtot_MSUN, /**< total mass of system (solar masses) */
1501  const REAL8 kappa2T, /**< tidal coupling constant. Eq. 2 in arXiv:1706.02969 */
1502  const REAL8 q /**< mass-ratio q >= 1 */
1503 );
1504 
1506 
1508  const REAL8Sequence *amp_tidal, /**< [out] tidal amplitude frequency series */
1509  const REAL8Sequence *fHz, /**< list of input Gravitational wave Frequency in Hz to evaluate */
1510  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1511  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1512  REAL8 lambda1, /**< (tidal deformability of mass 1) / m1^5 (dimensionless) */
1513  REAL8 lambda2 /**< (tidal deformability of mass 2) / m2^5 (dimensionless) */
1514 );
1515 
1517  const REAL8Sequence *phi_tidal, /**< [out] tidal phase frequency series */
1518  const REAL8Sequence *amp_tidal, /**< [out] tidal amplitude frequency series */
1519  const REAL8Sequence *planck_taper, /**< [out] planck taper */
1520  const REAL8Sequence *fHz, /**< list of input Gravitational wave Frequency in Hz to evaluate */
1521  REAL8 m1_SI, /**< Mass of companion 1 (kg) */
1522  REAL8 m2_SI, /**< Mass of companion 2 (kg) */
1523  REAL8 lambda1, /**< (tidal deformability of mass 1) / m1^5 (dimensionless) */
1524  REAL8 lambda2, /**< (tidal deformability of mass 2) / m2^5 (dimensionless) */
1525  NRTidal_version_type NRTidal_version /**< NRTidal version */
1526  );
1527 
1528 void XLALSimInspiralGetHOSpinTerms(REAL8 *SS_3p5PN, REAL8 *SSS_3p5PN, REAL8 X_A, REAL8 X_B, REAL8 chi1, REAL8 chi2, REAL8 quadparam1, REAL8 quadparam2);
1529 
1530 /* In module LALSimIMRPhenomD_NRTidal.c */
1531 int XLALSimIMRPhenomDNRTidal(COMPLEX16FrequencySeries **htilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 chi2, REAL8 lambda1, REAL8 lambda2, LALDict *extraParams, NRTidal_version_type NRTidal_version);
1532 int XLALSimIMRPhenomDNRTidalFrequencySequence(COMPLEX16FrequencySeries **htilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 chi2, REAL8 lambda1, REAL8 lambda2, LALDict *extraParams, NRTidal_version_type NRTidal_version);
1533 
1534 /* in module LALSimIMRPhenomHM.c */
1536  COMPLEX16FrequencySeries **hptilde,
1537  COMPLEX16FrequencySeries **hctilde,
1538  REAL8Sequence *freqs,
1539  REAL8 m1_SI,
1540  REAL8 m2_SI,
1541  REAL8 chi1z,
1542  REAL8 chi2z,
1543  const REAL8 distance,
1544  const REAL8 inclination,
1545  const REAL8 phiRef,
1546  const REAL8 deltaF,
1547  REAL8 f_ref,
1548  LALDict *extraParams);
1549 
1551  SphHarmFrequencySeries **hlms,
1552  REAL8Sequence *freqs,
1553  REAL8 m1_SI,
1554  REAL8 m2_SI,
1555  REAL8 chi1x,
1556  REAL8 chi1y,
1557  REAL8 chi1z,
1558  REAL8 chi2x,
1559  REAL8 chi2y,
1560  REAL8 chi2z,
1561  const REAL8 phiRef,
1562  const REAL8 deltaF,
1563  REAL8 f_ref,
1564  LALDict *extraParams);
1565 
1566 /* from LALSimIMRPhenomNSBH.c */
1567 
1569  COMPLEX16FrequencySeries **htilde,
1570  const REAL8Sequence *freqs,
1571  REAL8 phiRef,
1572  REAL8 fRef,
1573  REAL8 distance,
1574  REAL8 mBH_SI,
1575  REAL8 mNS_SI,
1576  REAL8 chi_BH,
1577  REAL8 chi_NS,
1578  LALDict *extraParams);
1579 
1581  COMPLEX16FrequencySeries **htilde,
1582  REAL8 phiRef,
1583  REAL8 deltaF,
1584  REAL8 fLow,
1585  REAL8 fHigh,
1586  REAL8 fRef,
1587  REAL8 distance,
1588  REAL8 mBH_SI,
1589  REAL8 mNS_SI,
1590  REAL8 chi_BH,
1591  REAL8 chi_NS,
1592  LALDict *extraParams
1593 );
1594 
1595 /* LALSimInspiralFDPrecAngles functions */
1597  REAL8Sequence *phiz_of_f,
1598  REAL8Sequence *zeta_of_f,
1599  REAL8Sequence *costhetaL_of_f,
1600  const REAL8Sequence *f,
1601  const double m1,
1602  const double m2,
1603  const double mul,
1604  const double phl,
1605  const double mu1,
1606  const double ph1,
1607  const double ch1,
1608  const double mu2,
1609  const double ph2,
1610  double ch2,
1611  const double f_0,
1612  const int ExpansionOrder);
1613 
1615  REAL8Sequence *phiz_of_f,
1616  REAL8Sequence *zeta_of_f,
1617  REAL8Sequence *costhetaL_of_f,
1618  const REAL8Sequence *f,
1619  const double m1,
1620  const double m2,
1621  const double mul,
1622  const double phl,
1623  const double mu1,
1624  const double ph1,
1625  const double ch1,
1626  const double mu2,
1627  const double ph2,
1628  double ch2,
1629  const double f_0,
1630  const int ExpansionOrder);
1631 
1632 int XLALComputeAngles(
1633  REAL8Sequence *phiz_of_f,
1634  REAL8Sequence *zeta_of_f,
1635  REAL8Sequence *costhetaL_of_f,
1636  const REAL8Sequence *f,
1637  const double m1,
1638  const double m2,
1639  const double mul,
1640  const double phl,
1641  const double mu1,
1642  const double ph1,
1643  const double ch1,
1644  const double mu2,
1645  const double ph2,
1646  double ch2,
1647  const double f_0,
1648  const int ExpansionOrder);
1649 
1651  REAL8Sequence *L_norm_3PN,
1652  REAL8Sequence *f_orb_hz,
1653  const double m1,
1654  const double m2,
1655  const double mul,
1656  const double phl,
1657  double mu1,
1658  double ph1,
1659  double ch1,
1660  double mu2,
1661  double ph2,
1662  double ch2,
1663  const double f_0,
1664  const int ExpansionOrder);
1665 
1666 /* IMRPhenomPv3 XLAL functions */
1668  COMPLEX16FrequencySeries **hptilde,
1669  COMPLEX16FrequencySeries **hctilde,
1670  REAL8Sequence *freqs,
1671  REAL8 m1_SI,
1672  REAL8 m2_SI,
1673  REAL8 S1x,
1674  REAL8 S1y,
1675  REAL8 S1z,
1676  REAL8 S2x,
1677  REAL8 S2y,
1678  REAL8 S2z,
1679  const REAL8 distance,
1680  const REAL8 inclination,
1681  const REAL8 phiRef,
1682  const REAL8 deltaF,
1683  const REAL8 f_ref,
1684  LALDict *extraParams);
1685 
1686 /* IMRPhenomPv3HM XLAL functions */
1688  COMPLEX16FrequencySeries **hptilde,
1689  COMPLEX16FrequencySeries **hctilde,
1690  REAL8Sequence *freqs,
1691  REAL8 m1_SI,
1692  REAL8 m2_SI,
1693  REAL8 chi1x,
1694  REAL8 chi1y,
1695  REAL8 chi1z,
1696  REAL8 chi2x,
1697  REAL8 chi2y,
1698  REAL8 chi2z,
1699  const REAL8 distance,
1700  const REAL8 inclination,
1701  const REAL8 phiRef,
1702  const REAL8 deltaF,
1703  REAL8 f_ref,
1704  LALDict *extraParams);
1705 
1707  SphHarmFrequencySeries **hlms,
1708  REAL8Sequence *freqs,
1709  REAL8 m1_SI,
1710  REAL8 m2_SI,
1711  REAL8 chi1x,
1712  REAL8 chi1y,
1713  REAL8 chi1z,
1714  REAL8 chi2x,
1715  REAL8 chi2y,
1716  REAL8 chi2z,
1717  const REAL8 phiRef,
1718  const REAL8 deltaF,
1719  const REAL8 f_ref,
1720  LALDict *extraParams);
1721 
1722 #if 0
1723 { /* so that editors will match succeeding brace */
1724 #elif defined(__cplusplus)
1725 }
1726 #endif
1727 
1728 #endif /* _LALSIMIMR_H */
REAL8 XLALSimPhenomPNRafinal_nonprec(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
REAL8 XLALSimPhenomPNRwindow(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
int XLALOrbitalAngMom3PNSpinning(REAL8Sequence *L_norm_3PN, REAL8Sequence *f_orb_hz, const double m1, const double m2, const double mul, const double phl, double mu1, double ph1, double ch1, double mu2, double ph2, double ch2, const double f_0, const int ExpansionOrder)
Standalone function to compute the magnitude of L divided by GMsquare_over_c to 3PN order with spin t...
int XLALSimIMRPhenomPv3HMModes(SphHarmFrequencySeries **hlms, REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 phiRef, const REAL8 deltaF, const REAL8 f_ref, LALDict *extraParams)
Returns frequency domain hlm's in inertial frame.
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.
int XLALSimIMRPhenomX_PNR_GenerateAntisymmetricAmpRatio(REAL8Sequence **kappa, REAL8Sequence **freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 inclination, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 fRef_In, LALDict *lalParams)
EXTERNAL GENERATE Antisymmetric Amplitude Ratio This is an external wrapper to generate the (2,...
int XLALSimIMRPhenomHM(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1z, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 deltaF, REAL8 f_ref, LALDict *extraParams)
double XLALSimIMRPhenomDFinalSpin(const REAL8 m1_in, const REAL8 m2_in, const REAL8 chi1_in, const REAL8 chi2_in)
Function to return the final spin (spin of the remnant black hole) as predicted by the IMRPhenomD mod...
int XLALSimIMRSEOBNRv4ROMFrequencyOfTime(REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute the starting frequency so that the given amount of 'time' elapses in the ROM waveform from th...
int XLALSimIMRPhenomXPHMModes(SphHarmFrequencySeries **hlms, REAL8 m1_SI, REAL8 m2_SI, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 f_ref, REAL8 phiRef, REAL8 distance, REAL8 inclination, LALDict *LALparams)
Function to obtain a SphHarmFrequencySeries with the individual modes h_lm.
INT4 XLALSimInspiralNRWaveformGetHlms(SphHarmTimeSeries **hlms, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 r, REAL8 fStart, REAL8 fRef, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, const char *NRDataFile, LALValue *ModeArray)
int XLALSimInspiralNRWaveformGetSpinsFromHDF5File(REAL8 *S1x, REAL8 *S1y, REAL8 *S1z, REAL8 *S2x, REAL8 *S2y, REAL8 *S2z, REAL8 fRef, REAL8 mTot, const char *NRDataFile)
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, NRTidal_version_type NRTidal_version)
Function to call the frequency domain tidal correction over an array of input frequencies.
int XLALSimIMRPhenSpinInspiralRDGenerator(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phi0, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 f_ref, REAL8 r, REAL8 iota, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, int phaseO, int ampO, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams)
flagSEOBNRv4P_euler_extension
Definition: LALSimIMR.h:275
@ FLAG_SEOBNRv4P_EULEREXT_QNM_SIMPLE_PRECESSION
QNM-based simple precession prescription post-merger.
Definition: LALSimIMR.h:276
@ FLAG_SEOBNRv4P_EULEREXT_CONSTANT
Euler angles set to constants post-merger.
Definition: LALSimIMR.h:277
int XLALNRSur7dq4Remnant(gsl_vector **result, REAL8 q, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, char *remnant_property, LALDict *LALparams)
Returns the remnant BH's mass, spin, or kick according to NRSur7dq4Remnant model.
int XLALSimIMRPhenomPv3(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 deltaF, const REAL8 f_ref, LALDict *extraParams)
Driver routine to compute the precessing inspiral-merger-ringdown phenomenological waveform IMRPhenom...
double XLALSimIMRPhenomDChirpTime(const REAL8 m1_in, const REAL8 m2_in, const REAL8 chi1_in, const REAL8 chi2_in, const REAL8 fHz)
Estimates the length of the time domain IMRPhenomD signal This does NOT taking into account any taper...
int XLALSimIMRSEOBNRv4HMROM_Modes(SphHarmFrequencySeries **hlm, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, bool use_hybridization)
int XLALSimIMRSpinPrecEOBWaveformAll(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, SphHarmTimeSeries **hIlm, SphHarmTimeSeries **hJlm, REAL8Vector **seobdynamicsAdaSVector, REAL8Vector **seobdynamicsHiSVector, REAL8Vector **seobdynamicsAdaSHiSVector, REAL8Vector **tVecPmodes, REAL8Vector **hP22_amp, REAL8Vector **hP22_phase, REAL8Vector **hP21_amp, REAL8Vector **hP21_phase, REAL8Vector **hP33_amp, REAL8Vector **hP33_phase, REAL8Vector **hP44_amp, REAL8Vector **hP44_phase, REAL8Vector **hP55_amp, REAL8Vector **hP55_phase, REAL8Vector **alphaJ2P, REAL8Vector **betaJ2P, REAL8Vector **gammaJ2P, REAL8Vector **mergerParams, const REAL8 phiC, const REAL8 INdeltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 chi1x, const REAL8 chi1y, const REAL8 chi1z, const REAL8 chi2x, const REAL8 chi2y, const REAL8 chi2z, LALValue *modearray, LALDict *seobflags)
This function is the master function generating precessing spinning SEOBNRv4P waveforms h+ and hx.
int XLALSimIMRSEOBNRv2ROMDoubleSpinHITimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown.
double XLALIMRPhenomDGetPeakFreq(const REAL8 m1_in, const REAL8 m2_in, const REAL8 chi1_in, const REAL8 chi2_in)
Function to return the frequency (in Hz) of the peak of the frequency domain amplitude for the IMRPhe...
int XLALSimIMRPhenomPv3HMGetHplusHcross(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 deltaF, REAL8 f_ref, LALDict *extraParams)
int XLALSimIMRTEOBResumS(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiRef, const REAL8 deltaT, const REAL8 m1, const REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 lambda1, const REAL8 lambda2, const REAL8 distance, const REAL8 inclination, const REAL8 longAscNodes, LALDict *LALparams, const REAL8 eccentricity, const REAL8 meanPerAno, const REAL8 f_min, const REAL8 f_ref)
int XLALNRSur3dq8Remnant(REAL8 *result, REAL8 q, REAL8 s1z, REAL8 s2z, char *remnant_property, LALDict *LALparams)
Returns the remnant BH's mass, spin, or kick according to NRSur3dq8Remnant model.
int XLALSimIMRSEOBNRv5HMROM_Modes(SphHarmFrequencySeries **hlm, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, bool use_hybridization)
REAL8 XLALSimPhenomPNRafinal(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
int XLALSimIMRPhenomHMGethlmModes(SphHarmFrequencySeries **hlms, REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 phiRef, const REAL8 deltaF, REAL8 f_ref, LALDict *extraParams)
int XLALSimInspiralNRWaveformGetHplusHcross(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 inclination, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 r, REAL8 fStart, REAL8 fRef, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, const char *NRDataFile, LALValue *ModeArray)
int XLALSimIMREOBNRv2HMROM(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, const int higherModesFlag)
int XLALSimSpinInspiralGenerator(REAL8TimeSeries **hPlus, REAL8TimeSeries **hCross, REAL8 phi_start, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 f_ref, REAL8 r, REAL8 iota, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, int phaseO, int ampO, REAL8 lambda1, REAL8 lambda2, REAL8 quadparam1, REAL8 quadparam2, LALDict *LALparams)
int XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencyOfTime(REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute the starting frequency so that the given amount of 'time' elapses in the ROM waveform from th...
int XLALSimIMRSEOBNRv4HMROMFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, LALDict *LALParams)
int XLALSimIMRSpinEOBWaveform(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1[], const REAL8 spin2[], const UINT4 PrecEOBversion)
Standard interface for SEOBNRv3 waveform generator: calls XLALSimIMRSpinEOBWaveformAll.
int XLALSimIMRSEOBNRv4HMROM(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, bool use_hybridization, LALDict *LALParams)
int XLALSimIMRSEOBNRv4HMROMFrequencySequence_Modes(SphHarmFrequencySeries **hlm, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, LALDict *LALParams)
int XLALSimIMRSEOBNRv5HMROM(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, bool use_hybridization, LALDict *LALParams)
int XLALSimNRTunedTidesSetFDTidalPhase_v2_Coeffs(REAL8 *NRTidalv2_coeffs)
Set the NRTidalv2 phase coefficients in an array for use here and in the IMRPhenomX*_NRTidalv2 implem...
REAL8 XLALSimPhenomPNRbetaRD(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
double XLALSimNRTunedTidesMergerFrequency(const REAL8 mtot_MSUN, const REAL8 kappa2T, const REAL8 q)
compute the merger frequency of a BNS system.
int XLALSimIMRSpinPrecEOBWaveform(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 INspin1[], const REAL8 INspin2[], const UINT4 PrecEOBversion, LALDict *LALParams)
REAL8 XLALSimPhenomPNRfRingEff(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
int XLALComputeAngles2PNNonSpinning(REAL8Sequence *phiz_of_f, REAL8Sequence *zeta_of_f, REAL8Sequence *costhetaL_of_f, const REAL8Sequence *f, 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, double ch2, const double f_0, const int ExpansionOrder)
flagSEOBNRv4P_Zframe
Definition: LALSimIMR.h:280
@ FLAG_SEOBNRv4P_ZFRAME_L
set Z axis of the P-frame along L
Definition: LALSimIMR.h:281
@ FLAG_SEOBNRv4P_ZFRAME_LN
set Z axis of the P-frame along LN
Definition: LALSimIMR.h:282
SphHarmTimeSeries * XLALSimIMRSpinPrecEOBModes(const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 INspin1[], const REAL8 INspin2[], const UINT4 PrecEOBversion, LALDict *LALParams)
int XLALEOBHighestInitialFreq(REAL8 *freqMinRad, REAL8 mTotal)
int XLALEOBCheckNyquistFrequency(REAL8 m1, REAL8 m2, REAL8 spin1[3], REAL8 spin2[3], UINT4 ell_max, Approximant approx, REAL8 deltaT)
REAL8 XLALSimPhenomPNRafinal_prec(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
int XLALSimIMRSpinEOBWaveformAll(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8Vector **dynamicsHi, SphHarmTimeSeries **hlmPTSout, SphHarmTimeSeries **hlmPTSHi, SphHarmTimeSeries **hIMRlmJTSHi, SphHarmTimeSeries **hIMRoutput, REAL8Vector **AttachParams, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 INspin1x, const REAL8 INspin1y, const REAL8 INspin1z, const REAL8 INspin2x, const REAL8 INspin2y, const REAL8 INspin2z, const UINT4 PrecEOBversion)
This function generates precessing spinning SEOBNRv3 waveforms h+ and hx.
int XLALSimIMRSEOBNRv5HMROMFrequencySequence_Modes(SphHarmFrequencySeries **hlm, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, LALDict *LALParams)
int XLALSimNRTunedTidesFDTidalAmplitudeFrequencySeries(const REAL8Sequence *amp_tidal, const REAL8Sequence *fHz, REAL8 m1_SI, REAL8 m2_SI, REAL8 lambda1, REAL8 lambda2)
Function to call amplitude tidal series only; done for convenience to use for PhenomD_NRTidalv2 and S...
int XLALComputeAngles(REAL8Sequence *phiz_of_f, REAL8Sequence *zeta_of_f, REAL8Sequence *costhetaL_of_f, const REAL8Sequence *f, 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, double ch2, const double f_0, const int ExpansionOrder)
double XLALSimNRTunedTidesComputeKappa2T(REAL8 m1_SI, REAL8 m2_SI, REAL8 lambda1, REAL8 lambda2)
convenient function to compute tidal coupling constant.
REAL8 XLALSimPhenomPNRfRINGEffShiftDividedByEmm(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, LALDict *lalParams)
int XLALSimIMRPhenomX_PNR_GenerateAntisymmetricWaveform(REAL8Sequence **antisymamp, REAL8Sequence **antisymphase, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 fRef_In, REAL8 phiRef, LALDict *lalParams)
EXTERNAL GENERATE antisymmetric waveform This is an external wrapper to generate the (2,...
int XLALSimIMRPhenomXPSpinTaylorAngles(REAL8Sequence **alphaFS, REAL8Sequence **cosbetaFS, REAL8Sequence **gammaFS, REAL8 m1_SI, REAL8 m2_SI, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 fmin, REAL8 fmax, REAL8 deltaF, REAL8 fRef, REAL8 phiRef, LALDict *LALparams)
XLAL function that evaluates the SpinTaylor Euler angles on a frequency grid passed by the user.
int XLALSimIMRSEOBNRv4ROMTimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown.
int XLALSimIMRSEOBNRv5HMROMFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, UINT4 nModes, LALDict *LALParams)
flagSEOBNRv4P_hamiltonian_derivative
Definition: LALSimIMR.h:270
@ FLAG_SEOBNRv4P_HAMILTONIAN_DERIVATIVE_ANALYTICAL
use analytical derivatives (opt)
Definition: LALSimIMR.h:271
@ FLAG_SEOBNRv4P_HAMILTONIAN_DERIVATIVE_NUMERICAL
use numerical derivatives (pre-opt)
Definition: LALSimIMR.h:272
int XLALComputeAngles3PN(REAL8Sequence *phiz_of_f, REAL8Sequence *zeta_of_f, REAL8Sequence *costhetaL_of_f, const REAL8Sequence *f, 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, double ch2, const double f_0, const int ExpansionOrder)
#define nModes
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 ...
int l
Definition: bh_qnmode.c:135
REAL8 M
Definition: bh_qnmode.c:133
const double Lambda
double complex COMPLEX16
double REAL8
uint32_t UINT4
int32_t INT4
REAL8 XLALBHNS_spin_aligned(const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 lam)
Compute final black hole spin for aligned black hole spin.
REAL8 XLALbbh_final_mass_non_precessing_UIB2016(const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 chi2)
Calculate the final mass with the aligned-spin NR fit.
REAL8 XLALbbh_final_spin_non_precessing_UIB2016(const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 chi2)
Calculate the final spin with the aligned-spin NR fit.
REAL8 XLALBHNS_mass_aligned(const REAL8 m1, const REAL8 m2, const REAL8 chi1, const REAL8 lam)
Compute final black hole mass for aligned black hole spin.
IMRPhenomP_version_type
Definition: LALSimIMR.h:73
SEOBNRv4TSurrogate_spline_order
Definition: LALSimIMR.h:88
NRTidal_version_type
Definition: LALSimIMR.h:80
@ IMRPhenomPv3_V
version 3: based on IMRPhenomD and the precession angles from Katerina Chatziioannou PhysRevD....
Definition: LALSimIMR.h:77
@ IMRPhenomPv1_V
version 1: based on IMRPhenomC
Definition: LALSimIMR.h:74
@ IMRPhenomPv2_V
version 2: based on IMRPhenomD
Definition: LALSimIMR.h:75
@ IMRPhenomPv2NRTidal_V
version Pv2_NRTidal: based on IMRPhenomPv2; NRTides added before precession; can be used with both NR...
Definition: LALSimIMR.h:76
@ SEOBNRv4TSurrogate_CUBIC
use cubic splines in frequency
Definition: LALSimIMR.h:89
@ SEOBNRv4TSurrogate_LINEAR
use linear splines in frequency
Definition: LALSimIMR.h:90
@ NRTidalv2NoAmpCorr_V
version NRTidalv2, without amplitude corrections
Definition: LALSimIMR.h:83
@ NRTidal_V
version NRTidal: based on https://arxiv.org/pdf/1706.02969.pdf
Definition: LALSimIMR.h:81
@ NoNRT_V
special case for PhenomPv2 BBH baseline
Definition: LALSimIMR.h:85
@ NRTidalv2NSBH_V
version NRTidalv2: https://arxiv.org/abs/1905.06011 with amplitude corrections for NSBH (used for SEO...
Definition: LALSimIMR.h:84
@ NRTidalv2_V
version NRTidalv2: https://arxiv.org/abs/1905.06011
Definition: LALSimIMR.h:82
int XLALSimIMREOBNRv2AllModes(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fLower, const REAL8 distance, const REAL8 inclination)
This function generates the plus and cross polarizations for the EOBNRv2 approximant with all availab...
SphHarmTimeSeries * XLALSimIMREOBNRv2Modes(const REAL8 deltaT, const REAL8 m1, const REAL8 m2, const REAL8 fLower, const REAL8 distance)
Wrapper function to generate the -2 spin-weighted spherical harmonic modes (as opposed to generating ...
int XLALSimIMREOBNRv2DominantMode(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, const REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fLower, const REAL8 distance, const REAL8 inclination)
This function generates the plus and cross polarizations for the dominant (2,2) mode of the EOBNRv2 a...
int XLALSimIMRPhenSpinFinalMassSpin(REAL8 *finalMass, REAL8 *finalSpin, REAL8 m1, REAL8 m2, REAL8 s1s1, REAL8 s2s2, REAL8 s1L, REAL8 s2L, REAL8 s1s2, REAL8 energy)
double XLALSimIMRPhenomAGetFinalFreq(const REAL8 m1, const REAL8 m2)
Compute the default final frequency.
int XLALSimIMRPhenomBGenerateFD(COMPLEX16FrequencySeries **htilde, const REAL8 phiPeak, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance)
Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhe...
int XLALSimIMRPhenomP(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip, const REAL8 thetaJ, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 distance, const REAL8 alpha0, const REAL8 phic, const REAL8 deltaF, const REAL8 f_min, const REAL8 f_max, const REAL8 f_ref, IMRPhenomP_version_type IMRPhenomP_version, NRTidal_version_type NRTidal_version, LALDict *extraParams)
Driver routine to compute the precessing inspiral-merger-ringdown phenomenological waveform IMRPhenom...
int XLALSimIMRPhenomDGenerateFD(COMPLEX16FrequencySeries **htilde, const REAL8 phi0, const REAL8 fRef, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi1, const REAL8 chi2, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, LALDict *extraParams, NRTidal_version_type NRTidal_version)
Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhe...
int XLALSimIMRPhenomPCalculateModelParametersFromSourceFrame(REAL8 *chi1_l, REAL8 *chi2_l, REAL8 *chip, REAL8 *thetaJN, REAL8 *alpha0, REAL8 *phi_aligned, REAL8 *zeta_polariz, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_ref, const REAL8 phiRef, const REAL8 incl, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, IMRPhenomP_version_type IMRPhenomP_version)
Function to map LAL parameters (masses, 6 spin components, phiRef and inclination at f_ref) (assumed ...
int XLALSimIMRPhenomBMetricInTheta0Theta3Theta3S(REAL8 *gamma00, REAL8 *gamma01, REAL8 *gamma02, REAL8 *gamma11, REAL8 *gamma12, REAL8 *gamma22, const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh)
Compute the template-space metric of the IMRPhenomB waveform in the theta0, theta3,...
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.
int XLALSimIMRPhenomDFrequencySequence(COMPLEX16FrequencySeries **htilde, const REAL8Sequence *freqs, const REAL8 phi0, const REAL8 fRef_in, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi1, const REAL8 chi2, const REAL8 distance, LALDict *extraParams, NRTidal_version_type NRTidal_version)
Compute waveform in LAL format at specified frequencies for the IMRPhenomD model.
double XLALSimIMRPhenomBComputeChi(const REAL8 m1, const REAL8 m2, const REAL8 s1z, const REAL8 s2z)
Compute the dimensionless, spin-aligned parameter chi as used in the IMRPhenomB waveform.
int XLALSimIMRPhenomPCalculateModelParametersOld(REAL8 *chi1_l, REAL8 *chi2_l, REAL8 *chip, REAL8 *thetaJ, REAL8 *alpha0, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_ref, const REAL8 lnhatx, const REAL8 lnhaty, const REAL8 lnhatz, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, IMRPhenomP_version_type IMRPhenomP_version)
Deprecated : used the old convention (view frame for the spins) Function to map LAL parameters (masse...
int XLALSimIMRPhenomPFrequencySequence(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, const REAL8 chi1_l, const REAL8 chi2_l, const REAL8 chip, const REAL8 thetaJ, REAL8 m1_SI, const REAL8 m2_SI, const REAL8 distance, const REAL8 alpha0, const REAL8 phic, const REAL8 f_ref, IMRPhenomP_version_type IMRPhenomP_version, NRTidal_version_type NRTidal_version, LALDict *extraParams)
Driver routine to compute the precessing inspiral-merger-ringdown phenomenological waveform IMRPhenom...
int XLALSimIMRPhenomAGenerateFD(COMPLEX16FrequencySeries **htilde, const REAL8 phiPeak, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_min, const REAL8 f_max, const REAL8 distance)
Driver routine to compute the non-spinning, inspiral-merger-ringdown phenomenological waveform IMRPhe...
int XLALSimIMRPhenomAGenerateTD(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination)
Driver routine to compute the non-spinning, inspiral-merger-ringdown phenomenological waveform IMRPhe...
int XLALSimIMRPhenomCGenerateTD(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination, LALDict *extraParams)
Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhe...
double XLALSimIMRPhenomBGetFinalFreq(const REAL8 m1, const REAL8 m2, const REAL8 chi)
Compute the default final frequency.
int XLALSimIMRPhenomCGenerateFD(COMPLEX16FrequencySeries **htilde, const REAL8 phiPeak, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, LALDict *extraParams)
Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhe...
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,...
int XLALSimIMRPhenomBGenerateTD(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination)
Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhe...
double XLALSimIMRPhenomCGetFinalFreq(const REAL8 m1, const REAL8 m2, const REAL8 chi)
Convenience function to quickly find the default final frequency.
int XLALSimIMRPhenomBMetricInMEtaChi(REAL8 *gamma00, REAL8 *gamma01, REAL8 *gamma02, REAL8 *gamma11, REAL8 *gamma12, REAL8 *gamma22, const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh)
Compute the template-space metric of the IMRPhenomB waveform in the M, eta, chi coordinates.
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.
double XLALSimIMRPhenomNSBH_sigma_tide_ND(const REAL8 x_ND_prime)
Correction to ringdown Lorentzian width for nondisruptive mergers.
double XLALSimIMRPhenomNSBH_x_D(const REAL8 Mtorus, const REAL8 C, const REAL8 q, const REAL8 chi)
Convenience function for expression appearing in disruptive merger.
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.
double XLALSimIMRPhenomNSBH_baryonic_mass_from_C(const REAL8 C, const REAL8 Mg)
NS baryonic mass as a function of NS gravitational mass.
double XLALSimIMRPhenomNSBH_window_minus(const REAL8 f, const REAL8 f0, const REAL8 d)
Hyperbolic tangent sigmoid function.
double XLALSimIMRPhenomNSBH_window_plus(const REAL8 f, const REAL8 f0, const REAL8 d)
Hyperbolic tangent sigmoid function.
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.
double XLALSimIMRPhenomNSBH_eta_from_q(const REAL8 q)
Convenience function to calculate symmetric mass ratio from q.
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)
COMPLEX16 XLALSimIMRPhenomNSBH_omega_tilde(const REAL8 a)
220 quasi-normal mode dimensionless frequency
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.
double XLALSimIMRPhenomNSBH_epsilon_tide_ND(const REAL8 x_ND)
PhenomC parameter delta_1 NSBH correction factor.
double XLALSimIMRPhenomNSBH_delta2_prime(const REAL8 f_tide, const REAL8 f_RD_tilde)
Fitted coefficient for PhenomC Lorentzian.
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.
SphHarmTimeSeries * XLALSimIMRPhenomTPHM_ChooseTDModes(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 deltaT, REAL8 fmin, REAL8 fRef, LALDict *lalParams)
Routine to be used by ChooseTDModes, it returns a list of the time-domain modes of the IMRPhenomTPHM ...
int XLALSimIMRPhenomTHM(REAL8TimeSeries **hp, REAL8TimeSeries **hc, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalparams)
Routine to compute time domain polarisations for IMRPhenomTHM model.
int XLALSimIMRPhenomTPHM_JModes(SphHarmTimeSeries **hlmJ, REAL8TimeSeries **alphaTS, REAL8TimeSeries **cosbetaTS, REAL8TimeSeries **gammaTS, REAL8 *af, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams, UINT4 only22)
Routine to compute a list of the time-domain modes of the IMRPhenomTPHM model in the inertial J-frame...
SphHarmTimeSeries * XLALSimIMRPhenomTHM_Modes(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
Routine to compute time domain Spin-Weighted Spherical Harmonic modes for IMRPhenomTHM model.
int XLALSimIMRPhenomTPHM_EvolveOrbit(REAL8TimeSeries **V, 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_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
Function to return the time series for the evolution of the individual spins, the Newtonian angular m...
int XLALSimIMRPhenomTPHM_CoprecModes(SphHarmTimeSeries **hlmJ, REAL8TimeSeries **alphaTS, REAL8TimeSeries **cosbetaTS, REAL8TimeSeries **gammaTS, REAL8 *af, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams, UINT4 only22)
Routine to compute a list of the time-domain modes of the IMRPhenomTPHM model in the co-precessing fr...
int XLALSimIMRPhenomT(REAL8TimeSeries **hp, REAL8TimeSeries **hc, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
Routine to compute time domain polarisations for IMRPhenomT model.
int XLALSimIMRPhenomTPHM(REAL8TimeSeries **hp, REAL8TimeSeries **hc, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
Routine to compute time-domain polarizations for the IMRPhenomTPHM model.
int XLALSimIMRPhenomTP(REAL8TimeSeries **hp, REAL8TimeSeries **hc, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams)
Routine to compute time-domain polarizations for the IMRPhenomTP model.
int XLALSimIMRPhenomTPHM_L0Modes(SphHarmTimeSeries **hlmI, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 deltaT, REAL8 fmin, REAL8 fRef, REAL8 phiRef, LALDict *lalParams, UINT4 only22)
Routine to compute a list of the time-domain modes of the IMRPhenomTPHM model in the inertial L0-fram...
int XLALSimIMRPhenomXHMMultiBandOneMode(COMPLEX16FrequencySeries **htildelm, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, UINT4 ell, INT4 emm, REAL8 distance, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Return htildelm, the waveform of one mode without mode-mixing.
int XLALSimIMRPhenomX_PNR_GeneratePNRAnglesHM(REAL8Sequence **alphaPNR, REAL8Sequence **betaPNR, REAL8Sequence **gammaPNR, REAL8Sequence **freqs, REAL8 *alphaPNR_ref, REAL8 *gammaPNR_ref, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 inclination, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 fRef_In, INT4 ell, INT4 emmprime, LALDict *lalParams)
This is an external wrapper to generate the (l,m) PNR angles, following the prescriptions outlined in...
double XLALSimIMRPhenomXASDuration(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 f_min)
Compute the duration of IMRPhenomXAS using the approximate SPA relation .
int XLALSimIMRPhenomX_PNR_GeneratePNRAngles(REAL8Sequence **alphaPNR, REAL8Sequence **betaPNR, REAL8Sequence **gammaPNR, REAL8Sequence **freqs, REAL8 *alphaPNR_ref, REAL8 *gammaPNR_ref, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 inclination, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 fRef_In, LALDict *lalParams)
This is an external wrapper to generate the (2,2) PNR angles, following the prescription outlined in ...
int XLALSimIMRPhenomXPHMFromModes(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, REAL8 f_min, REAL8 f_max, const REAL8 deltaF, REAL8 fRef_In, LALDict *lalParams)
Returns hptilde and hctilde of the multimode precessing waveform for positive frequencies in an equal...
REAL8 XLALSimIMRPhenomX_PNR_GenerateEffectiveRingdownFreq(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 f_min, REAL8 f_max, REAL8 fRef, UINT4 ell, UINT4 emmprime, LALDict *lalParams)
External wrapper for IMRPhenomX_PNR_GenerateEffectiveRingdownFreq.
int XLALSimIMRPhenomXASGenerateFD(COMPLEX16FrequencySeries **htilde22, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Driver routine to calculate an IMRPhenomX aligned-spin, inspiral-merger-ringdown phenomenological wav...
int XLALSimIMRPhenomXHMFrequencySequence(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1z, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 fRef, LALDict *lalParams)
Returns hptilde and hctilde as a complex frequency series with entries exactly at the frequencies spe...
int XLALSimIMRPhenomXHMModes(SphHarmFrequencySeries **hlms, REAL8 m1_SI, REAL8 m2_SI, REAL8 S1z, REAL8 S2z, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 f_ref, REAL8 phiRef, REAL8 distance, LALDict *LALparams)
Function to obtain a SphHarmFrequencySeries with the individual modes h_lm.
int XLALSimIMRPhenomXHMGenerateFDOneMode(COMPLEX16FrequencySeries **htildelm, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, UINT4 ell, INT4 emm, REAL8 distance, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Returns the Fourier domain strain of just one mode: h_lm.
int XLALSimIMRPhenomXHMFrequencySequenceOneMode(COMPLEX16FrequencySeries **htildelm, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, UINT4 ell, INT4 emm, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Get the model evaluated in a prebuilt frequency array.
int XLALSimIMRPhenomXASFrequencySequence(COMPLEX16FrequencySeries **htilde22, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Compute waveform in LAL format at specified frequencies for the IMRPhenomX model.
int XLALSimIMRPhenomXPMSAAngles(REAL8Sequence **alpha_of_f, REAL8Sequence **gamma_of_f, REAL8Sequence **cosbeta_of_f, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 inclination, REAL8 fRef_In, INT4 mprime, LALDict *lalParams)
int XLALSimIMRPhenomXHMPhase(REAL8Sequence **phase, const REAL8Sequence *freqs, UINT4 ell, INT4 emm, REAL8 m1_SI, REAL8 m2_SI, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Returns phase of one single mode in a custom frequency array.
int XLALSimIMRPhenomXHM(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1z, REAL8 chi2z, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Returns the hptilde and hctilde of the multimode waveform for positive frequencies.
int XLALSimIMRPhenomXHM_SpheroidalPhase(REAL8Sequence **phase, const REAL8Sequence *freqs_In, UINT4 ell, INT4 emm, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
int XLALSimIMRPhenomXHMMultiBandOneModeMixing(COMPLEX16FrequencySeries **htildelm, COMPLEX16FrequencySeries *htilde22, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, UINT4 ell, INT4 emm, REAL8 distance, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Returns htildelm the waveform of one mode that present mode-mixing.
int XLALSimIMRPhenomXPGenerateFD(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, REAL8 f_min, REAL8 f_max, const REAL8 deltaF, REAL8 fRef_In, LALDict *lalParams)
int XLALSimIMRPhenomXHMAmplitude(REAL8Sequence **amplitude, const REAL8Sequence *freqs, UINT4 ell, INT4 emm, REAL8 m1_SI, REAL8 m2_SI, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Returns amplitude of one single mode in a custom frequency array.
int XLALSimIMRPhenomX_PNR_InterpolationDeltaF(INT4 *twospin, INT4 *precversion, REAL8 *deltaF, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 f_min, REAL8 f_max, REAL8 fRef, LALDict *lalParams)
int XLALSimIMRPhenomXPHMFrequencySequence(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Returns hptilde and hctilde as a complex frequency series with entries exactly at the frequencies spe...
int XLALSimIMRPhenomXPHMFrequencySequenceOneMode(COMPLEX16FrequencySeries **hlmpos, COMPLEX16FrequencySeries **hlmneg, const REAL8Sequence *freqs, const UINT4 l, const INT4 m, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 fRef_In, LALDict *lalParams)
Function to compute one hlm precessing mode on a custom frequency grid.
int XLALSimIMRPhenomXHM_SpheroidalAmplitude(REAL8Sequence **amp, const REAL8Sequence *freqs_In, UINT4 ell, INT4 emm, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
int XLALSimIMRPhenomXPHM(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 fRef_In, LALDict *lalParams)
Returns hptilde and hctilde of the multimode precessing waveform for positive frequencies in an equal...
int XLALSimIMRPhenomXPFrequencySequence(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Compute waveform in LAL format at specified frequencies for the IMRPhenomXP model.
int XLALSimIMRPhenomXPCalculateModelParametersFromSourceFrame(REAL8 *chi1L, REAL8 *chi2L, REAL8 *chi_p, REAL8 *thetaJN, REAL8 *alpha0, REAL8 *phi_aligned, REAL8 *zeta_polarization, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_ref, const REAL8 phiRef, const REAL8 incl, const REAL8 s1x, const REAL8 s1y, const REAL8 s1z, const REAL8 s2x, const REAL8 s2y, const REAL8 s2z, LALDict *lalParams)
int XLALSimIMRPhenomXPHMOneMode(COMPLEX16FrequencySeries **hlmpos, COMPLEX16FrequencySeries **hlmneg, const UINT4 l, const INT4 m, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 deltaF, const REAL8 f_min, const REAL8 f_max, const REAL8 fRef_In, LALDict *lalParams)
Function to compute one hlm precessing mode in an uniform frequency grid.
int XLALSimIMRPhenomXHM2(COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 inclination, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
Returns the hptilde and hctilde of the multimode waveform for positive frequencies.
int XLALSimIMRPhenomXPPNAngles(REAL8Sequence **alpha_of_f, REAL8Sequence **gamma_of_f, REAL8Sequence **cosbeta_of_f, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 inclination, REAL8 fRef_In, INT4 mprime, LALDict *lalParams)
REAL8 XLALSimIMRPhenomX_PNR_GenerateRingdownPNRBeta(REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1x, REAL8 chi1y, REAL8 chi1z, REAL8 chi2x, REAL8 chi2y, REAL8 chi2z, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 fRef_In, LALDict *lalParams)
External wrapper for IMRPhenomX_PNR_GenerateRingdownPNRBeta.
int XLALSimIMRSEOBNRv1ROMDoubleSpinFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute waveform in LAL format at specified frequencies for the SEOBNRv1_ROM_DoubleSpin model.
int XLALSimIMRSEOBNRv4ROM(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, LALDict *LALparams, NRTidal_version_type NRTidal_version)
Compute waveform in LAL format for the SEOBNRv4_ROM model.
int XLALSimIMRSEOBNRv2ROMDoubleSpin(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute waveform in LAL format for the SEOBNRv2_ROM_DoubleSpin model.
int XLALSimIMRSEOBNRv2ROMDoubleSpinHI(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max)
Compute waveform in LAL format for the SEOBNRv2_ROM_DoubleSpin_HI model.
int XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencyOfTime(REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
Compute the starting frequency so that the given amount of 'time' elapses in the ROM waveform from th...
int XLALSimIMRSEOBNRv2ROMDoubleSpinAmpPhaseInterpolants(struct tagREAL8Vector **amplitude_interp, struct tagREAL8Vector **amplitude_freq_points, struct tagREAL8Vector **phase_interp, struct tagREAL8Vector **phase_freq_points, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute the Amplitude and Phase interpolants for the SEOBNRv2DoubleSpin model.
int XLALSimIMRSEOBNRv4ROMFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, LALDict *LALparams, NRTidal_version_type NRTidal_version)
Compute waveform in LAL format at specified frequencies for the SEOBNRv4_ROM model.
int XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_EffectiveSpin model.
int XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_DoubleSpin model.
int XLALSimIMRSEOBNRv1ROMEffectiveSpin(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
Compute waveform in LAL format for the SEOBNRv1_ROM_EffectiveSpin model.
int XLALSimIMRSEOBNRv2ROMEffectiveSpinTimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown.
int XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencyOfTime(REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute the starting frequency so that the given amount of 'time' elapses in the ROM waveform from th...
int XLALSimIMRSEOBNRv2ROMDoubleSpinTimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown.
int XLALSimIMRSEOBNRv1ROMEffectiveSpinFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
Compute waveform in LAL format at specified frequencies for the SEOBNRv1_ROM_EffectiveSpin model.
int XLALSimIMRSEOBNRv2ROMEffectiveSpin(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
Compute waveform in LAL format for the SEOBNRv2_ROM_EffectiveSpin model.
int XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max)
Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_DoubleSpin_HI model.
int XLALSimIMRSEOBNRv1ROMDoubleSpin(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute waveform in LAL format for the SEOBNRv1_ROM_DoubleSpin model.
REAL8 XLALSimIMRSEOBNRv2ChirpTimeSingleSpin(const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min)
Compute SEOBNRv2 chirp time from an interpolant assuming a single-spin.
int XLALSimIMRSEOBNRv4TSurrogateFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, REAL8 lambda1, REAL8 lambda2, SEOBNRv4TSurrogate_spline_order spline_order)
Compute waveform in LAL format at specified frequencies for the SEOBNRv4T_surrogate model.
int XLALSimIMRSEOBNRv4TSurrogate(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, REAL8 lambda1, REAL8 lambda2, SEOBNRv4TSurrogate_spline_order spline_order)
Compute waveform in LAL format for the SEOBNRv4T_surrogate model.
int XLALSimIMRSEOBNRv5ROMTimeOfFrequency(REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown.
int XLALSimIMRSpinAlignedEOBModes(SphHarmTimeSeries **hlmmode, REAL8Vector **dynamics_out, REAL8Vector **dynamicsHi_out, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, const REAL8 lambda2Tidal1, const REAL8 lambda2Tidal2, const REAL8 omega02Tidal1, const REAL8 omega02Tidal2, const REAL8 lambda3Tidal1, const REAL8 lambda3Tidal2, const REAL8 omega03Tidal1, const REAL8 omega03Tidal2, const REAL8 quadparam1, const REAL8 quadparam2, REAL8Vector *nqcCoeffsInput, const INT4 nqcFlag, LALDict *PAParams, LALDict *TGRParams)
This function generates spin-aligned SEOBNRv1,2,2opt,4,4opt,2T,4T,4HM complex modes hlm.
int XLALSimIMRSpinAlignedEOBWaveformAll(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, const REAL8 lambda2Tidal1, const REAL8 lambda2Tidal2, const REAL8 omega02Tidal1, const REAL8 omega02Tidal2, const REAL8 lambda3Tidal1, const REAL8 lambda3Tidal2, const REAL8 omega03Tidal1, const REAL8 omega03Tidal2, const REAL8 quadparam1, const REAL8 quadparam2, REAL8Vector *nqcCoeffsInput, const INT4 nqcFlag, LALValue *ModeArray, LALDict *TGRParams)
This function takes the modes from the function XLALSimIMRSpinAlignedEOBModes and combine them into h...
int XLALSimIMRSpinAlignedEOBWaveform(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, LALDict *LALparams)
double XLALSimIMRSpinAlignedEOBPeakFrequency(REAL8 m1SI, REAL8 m2SI, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion)
This function returns the frequency at which the peak amplitude occurs in SEOBNRv(x)
int XLALSimIMRSEOBNRv4ROMNRTidalFrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 chi2, REAL8 Lambda1, REAL8 Lambda2, LALDict *LALparams, NRTidal_version_type NRTidal_version)
Compute waveform in LAL format at specified frequencies for the SEOBNRv4_ROM_NRTidal tidal model base...
int XLALSimIMRPhenomDNRTidalFrequencySequence(COMPLEX16FrequencySeries **htilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 chi2, REAL8 lambda1, REAL8 lambda2, LALDict *extraParams, NRTidal_version_type NRTidal_version)
Compute waveform in LAL format at specified frequencies for the IMRPhenomD_NRTidal tidal model based ...
int XLALSimIMRPhenomDNRTidal(COMPLEX16FrequencySeries **htilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 chi2, REAL8 lambda1, REAL8 lambda2, LALDict *extraParams, NRTidal_version_type NRTidal_version)
Compute waveform in LAL format for the IMRPhenomD_NRTidal tidal model based on IMRPhenomD.
int XLALSEOBNRv4ROMNSBHAmplitudeCorrectionFrequencySeries(const REAL8Sequence *amp_tidal, const REAL8Sequence *fHz, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 lambda2)
Compute amplitude correction to SEOBNRv4_ROM_NRTidalv2 in LAL format at specified frequencies for the...
int XLALSimIMRSEOBNRv4ROMNRTidal(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1, REAL8 chi2, REAL8 Lambda1, REAL8 Lambda2, LALDict *LALparams, NRTidal_version_type NRTidal_version)
Compute waveform in LAL format for the SEOBNRv4_ROM_NRTidal tidal model based on SEOBNRv4_ROM.
int XLALSimIMRLackeyTidal2013(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 Lambda)
Compute waveform in LAL format for the Lackey et al (2013) tidal model based on SEOBNRv2_ROM_DoubleSp...
int XLALSimIMRLackeyTidal2013FrequencySequence(struct tagCOMPLEX16FrequencySeries **hptilde, struct tagCOMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 mBH_SI, REAL8 mNS_SI, REAL8 chi_BH, REAL8 Lambda)
Compute waveform in LAL format at specified frequencies for the Lackey et al (2013) tidal model based...
Approximant
Enum that specifies the PN approximant to be used in computing the waveform.
SphHarmTimeSeries * XLALSimInspiralPrecessingNRSurModes(REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 fMin, REAL8 fRef, REAL8 distance, LALDict *LALparams, Approximant approximant)
This function evaluates the NRSur7dq2 or NRSur7dq4 surrogate model and returns the inertial frame mod...
int XLALSimInspiralPrecessingNRSurPolarizations(REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 inclination, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 distnace, REAL8 fMin, REAL8 fRef, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, LALDict *LALparams, Approximant approximant)
This function evaluates the NRSur7dq2 or NRSur7dq4 surrogate model and sums over all ell <= 4 modes t...
int XLALPrecessingNRSurDynamics(gsl_vector **t_dynamics, gsl_vector **quat0, gsl_vector **quat1, gsl_vector **quat2, gsl_vector **quat3, gsl_vector **orbphase, gsl_vector **chiAx, gsl_vector **chiAy, gsl_vector **chiAz, gsl_vector **chiBx, gsl_vector **chiBy, gsl_vector **chiBz, REAL8 q, REAL8 chiA0x, REAL8 chiA0y, REAL8 chiA0z, REAL8 chiB0x, REAL8 chiB0y, REAL8 chiB0z, REAL8 omegaRef_dimless, REAL8 init_quat0, REAL8 init_quat1, REAL8 init_quat2, REAL8 init_quat3, REAL8 init_orbphase, LALDict *LALparams, Approximant approximant)
This function evaluates the NRSur7dq2 or NRSur7dq4 surrogate model and returns the precessing frame d...
double XLALSimNSBH_compactness_from_lambda(const REAL8 Lambda)
Compactness as a function of tidal deformability.
double XLALSimNSBH_torus_mass_fit(const REAL8 q, const REAL8 a, const REAL8 C)
Baryonic mass of the torus remnant of a BH-NS merger.
double XLALSimNSBH_fGWinKerr(const REAL8 r, const REAL8 M, const REAL8 a)
GW frequency for a particle on Kerr.
double XLALSimNSBH_xi_tide(const REAL8 q, const REAL8 a, const REAL8 mu)
Relativistic correction to orbital radius at mass-shedding.
double XLALSimNSBH_rKerrISCO(const REAL8 a)
Kerr BH ISCO radius.
static const INT4 r
static const INT4 m
static const INT4 q
static const INT4 a
Structure to carry a collection of spherical harmonic modes in COMPLEX16 time series.
double V
Definition: unicorn.c:25
double f_min
Definition: unicorn.c:22
double deltaT
Definition: unicorn.c:24
double f_max
Definition: unicorn.c:23