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