LALSimulation  5.4.0.1-fe68b98
Prototypes | Macros
LALSimIMREOBNQCCorrection.c File Reference

Prototypes

static REAL8 XLALSimIMREOBGetNRPeakDeltaT (INT4 l, INT4 m, REAL8 eta)
 Compute the time offset which should be used in computing the non-quasicircular correction and performing the ringdown attachment. More...
 
static REAL8 GetNRPeakAmplitude (INT4 l, INT4 m, REAL8 eta)
 Function which returns a value of the expected peak amplitude taken from a fit to numerical relativity simulations. More...
 
static REAL8 GetNRPeakADDot (INT4 l, INT4 m, REAL8 eta)
 Function which returns second derivative of the amplitude at the peak taken from a fit to numerical relativity simulations. More...
 
static REAL8 GetNRPeakOmega (INT4 l, INT4 m, REAL8 eta)
 Function which returns a value of the expected peak frequency taken from a fit to numerical relativity simulations. More...
 
static REAL8 GetNRPeakOmegaDot (INT4 l, INT4 m, REAL8 eta)
 Function which returns the derivative of the expected peak frequency taken from a fit to numerical relativity simulations. More...
 
static UNUSED int XLALSimIMREOBGetCalibratedNQCCoeffs (EOBNonQCCoeffs *coeffs, INT4 l, INT4 m, REAL8 eta)
 For the 2,2 mode, there are fits available for the NQC coefficients, given in Eqs. More...
 
static UNUSED int XLALSimIMREOBNonQCCorrection (COMPLEX16 *restrict nqc, REAL8Vector *restrict values, const REAL8 omega, EOBNonQCCoeffs *restrict coeffs)
 This function calculates the non-quasicircular correction to apply to the waveform. More...
 
static UNUSED int XLALSimIMRSpinEOBNonQCCorrection (COMPLEX16 *restrict nqc, REAL8Vector *restrict values, const REAL8 omega, EOBNonQCCoeffs *restrict coeffs)
 This function calculates the non-quasicircular correction to apply to the waveform. More...
 
static UNUSED int XLALSimIMREOBCalculateNQCCoefficients (EOBNonQCCoeffs *restrict coeffs, REAL8Vector *restrict amplitude, REAL8Vector *restrict phase, REAL8Vector *restrict q1, REAL8Vector *restrict q2, REAL8Vector *restrict q3, REAL8Vector *restrict p1, REAL8Vector *restrict p2, INT4 l, INT4 m, REAL8 timePeak, REAL8 deltaT, REAL8 eta)
 This function computes the coefficients a1, a2, etc. More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakDeltaT (INT4 l, INT4 m, REAL8 UNUSED eta, REAL8 a)
 The time difference between the orbital peak and the peak amplitude of the mode in question (currently only 2,2 implemented ). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakAmplitudeV2 (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 UNUSED a)
 Peak amplitude predicted by fitting NR results (currently only 2,2 available). More...
 
static REAL8 CombineTPLEQMFits (REAL8 eta, REAL8 A1, REAL8 fEQ, REAL8 fTPL)
 Combine two spin-dependent fits of NR input values in a quardatic-in-eta polynomial with the linear-in-eta coefficient A1 being provided by a polyinamial-in-spin global fit to NR in the whole eta-chi plane. More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakAmplitudeV4 (INT4 modeL, INT4 modeM, REAL8 m1, REAL8 m2, REAL8 chiS, REAL8 chiA)
 Peak amplitude predicted by fitting NR results The coefficients for the mode (2,2) are in Eq. More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakADotV4 (INT4 modeL, INT4 modeM, REAL8 UNUSED m1, REAL8 UNUSED m2, REAL8 UNUSED chiS, REAL8 UNUSED chiA)
 Peak amplitude slope predicted by fitting NR results. More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakADDotV2 (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 UNUSED a)
 Peak amplitude curvature predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakADDotV4 (INT4 modeL, INT4 modeM, REAL8 m1, REAL8 m2, REAL8 chiS, REAL8 chiA)
 Peak amplitude curvature predicted by fitting NR results. More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaV2 (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 a)
 Peak frequency predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaV4 (INT4 modeL, INT4 modeM, REAL8 UNUSED eta, REAL8 a)
 Peak frequency predicted by fitting NR results The coefficients for the (2,2) are in Eq. More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaV5 (INT4 modeL, INT4 modeM, REAL8 UNUSED eta, REAL8 a)
 Peak frequency predicted by fitting NR results used in SEOBNRv5 The coefficients are in Eq. More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaDotV2 (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 UNUSED a)
 Peak frequency slope predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaDotV4 (INT4 modeL, INT4 modeM, REAL8 UNUSED eta, REAL8 UNUSED a)
 Peak frequency slope predicted by fitting NR results The coefficients for the (2,2) are in Eq. More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakAmplitude (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 UNUSED a)
 Peak amplitude predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakADDot (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 UNUSED a)
 Peak amplitude curvature predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmega (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 a)
 Peak frequency predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaDot (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 UNUSED a)
 Peak frequency slope predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakDeltaTv2 (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED m1, REAL8 UNUSED m2, REAL8 chi1, REAL8 chi2)
 The time difference between the orbital peak and the peak amplitude of the mode in question (currently only 2,2 implemented ). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakDeltaTv4 (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED m1, REAL8 UNUSED m2, REAL8 UNUSED chi1, REAL8 UNUSED chi2)
 The time difference between the orbital peak and the peak amplitude of the mode in question (currently only 2,2 implemented ). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegav2 (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 a)
 Peak frequency predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaDotv2 (INT4 UNUSED l, INT4 UNUSED m, REAL8 UNUSED eta, REAL8 UNUSED a)
 Peak frequency slope predicted by fitting NR results (currently only 2,2 available). More...
 
static UNUSED int XLALSimIMRSpinEOBCalculateNQCCoefficients (REAL8Vector *restrict amplitude, REAL8Vector *restrict phase, REAL8Vector *restrict rVec, REAL8Vector *restrict prVec, REAL8Vector *restrict orbOmegaVec, INT4 l, INT4 m, REAL8 timePeak, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 a, REAL8 chiA, REAL8 chiS, EOBNonQCCoeffs *restrict coeffs, UINT4 SpinAlignedEOBversion)
 This function computes the coefficients a3s, a4, etc. More...
 
static UNUSED int XLALSimIMRSpinEOBCalculateNQCCoefficientsV4 (REAL8Vector *restrict amplitude, REAL8Vector *restrict phase, REAL8Vector *restrict rVec, REAL8Vector *restrict prVec, REAL8Vector *restrict orbOmegaVec, INT4 modeL, INT4 modeM, REAL8 timePeak, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 chiA, REAL8 chiS, EOBNonQCCoeffs *restrict coeffs)
 This function computes the coefficients a3s, a4, etc. More...
 

Go to the source code of this file.

Macros

#define _LALSIMIMRNQCCORRECTION_C
 More recent versions of the EOB models, such as EOBNRv2 and SEOBNRv1, utilise a non-quasicircular correction (NQC) to bring the peak of the EOB frequency into agreement with that of NR simulations. This file contains the functions used to calculate these NQC corrections, described in DCC document T1100433. The fits to NR peak amplitude, frequency, and their derivatives, are taken from Pan et al. PRD 84 124052 (2011) [arXiv:1106.1021], for EOBNRv2, and from Taracchini et al. PRD 86, 024011 (2012) [arXiv:1202.0790], for SEOBNRv1. More...
 

Macro Definition Documentation

◆ _LALSIMIMRNQCCORRECTION_C

#define _LALSIMIMRNQCCORRECTION_C

More recent versions of the EOB models, such as EOBNRv2 and SEOBNRv1, utilise a non-quasicircular correction (NQC) to bring the peak of the EOB frequency into agreement with that of NR simulations. This file contains the functions used to calculate these NQC corrections, described in DCC document T1100433. The fits to NR peak amplitude, frequency, and their derivatives, are taken from Pan et al. PRD 84 124052 (2011) [arXiv:1106.1021], for EOBNRv2, and from Taracchini et al. PRD 86, 024011 (2012) [arXiv:1202.0790], for SEOBNRv1.

Author
Craig Robinson, Yi Pan, Andrea Taracchini

Definition at line 44 of file LALSimIMREOBNQCCorrection.c.

Function Documentation

◆ XLALSimIMREOBGetNRPeakDeltaT()

static REAL8 XLALSimIMREOBGetNRPeakDeltaT ( INT4  l,
INT4  m,
REAL8  eta 
)
static

Compute the time offset which should be used in computing the non-quasicircular correction and performing the ringdown attachment.

These numbers were tuned to numerical relativity simulations, and are taken from Pan et al, PRD84, 124052(2011) [arXiv:1106.1021], lines 1-5 of Table III.

Parameters
l< Mode l
m< Mode m
eta< Symmetric mass ratio

Definition at line 65 of file LALSimIMREOBNQCCorrection.c.

◆ GetNRPeakAmplitude()

static REAL8 GetNRPeakAmplitude ( INT4  l,
INT4  m,
REAL8  eta 
)
inlinestatic

Function which returns a value of the expected peak amplitude taken from a fit to numerical relativity simulations.

The functions are taken from Pan et al, PRD84, 124052(2011) [arXiv:1106.1021], lines 1-5 of Table II.

Parameters
l< Mode l
m< Mode m
eta< Symmetric mass ratio

Definition at line 131 of file LALSimIMREOBNQCCorrection.c.

◆ GetNRPeakADDot()

static REAL8 GetNRPeakADDot ( INT4  l,
INT4  m,
REAL8  eta 
)
inlinestatic

Function which returns second derivative of the amplitude at the peak taken from a fit to numerical relativity simulations.

The functions are taken from Pan et al, PRD84, 124052(2011) [arXiv:1106.1021], lines 1-5 of Table II.

Parameters
l< Mode l
m< Mode m
eta< Symmetric mass ratio

Definition at line 195 of file LALSimIMREOBNQCCorrection.c.

◆ GetNRPeakOmega()

static REAL8 GetNRPeakOmega ( INT4  l,
INT4  m,
REAL8  eta 
)
inlinestatic

Function which returns a value of the expected peak frequency taken from a fit to numerical relativity simulations.

The functions are taken from Pan et al, PRD84, 124052(2011) [arXiv:1106.1021], lines 1-5 of Table II.

Parameters
l< Mode l
m< Mode m
eta< Symmetric mass ratio

Definition at line 261 of file LALSimIMREOBNQCCorrection.c.

◆ GetNRPeakOmegaDot()

static REAL8 GetNRPeakOmegaDot ( INT4  l,
INT4  m,
REAL8  eta 
)
inlinestatic

Function which returns the derivative of the expected peak frequency taken from a fit to numerical relativity simulations.

The functions are taken from Pan et al, PRD84, 124052(2011) [arXiv:1106.1021], lines 1-5 of Table II.

Parameters
l< Mode l
m< Mode m
eta< Symmetric mass ratio

Definition at line 324 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetCalibratedNQCCoeffs()

static UNUSED int XLALSimIMREOBGetCalibratedNQCCoeffs ( EOBNonQCCoeffs *  coeffs,
INT4  l,
INT4  m,
REAL8  eta 
)
static

For the 2,2 mode, there are fits available for the NQC coefficients, given in Eqs.

(40a)-(40c) of Pan et al, PRD84, 124052(2011) [arXiv:1106.1021]. This function provides the values of these coefficients, so the correction can be used in the dynamics prior to finding the more accurate NQC values later on.

Parameters
coeffs< OUTPUT, Structure for NQC coeffs
l< Mode l
m< Mode m
eta< Symmetric mass ratio

Definition at line 390 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBNonQCCorrection()

static UNUSED int XLALSimIMREOBNonQCCorrection ( COMPLEX16 *restrict  nqc,
REAL8Vector *restrict  values,
const REAL8  omega,
EOBNonQCCoeffs *restrict  coeffs 
)
static

This function calculates the non-quasicircular correction to apply to the waveform.

The form of this correction can be found in Pan et al, PRD84, 124052(2011) [arXiv:1106.1021], Eq.(22), and also in the DCC document T1100433. Note that when calling this function, the NQC coefficients should already have been pre-computed.

Parameters
nqc< OUTPUT, The NQC correction
values< Dynamics r, phi, pr, pphi
omega< Angular frequency
coeffs< NQC coefficients

Definition at line 429 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMRSpinEOBNonQCCorrection()

static UNUSED int XLALSimIMRSpinEOBNonQCCorrection ( COMPLEX16 *restrict  nqc,
REAL8Vector *restrict  values,
const REAL8  omega,
EOBNonQCCoeffs *restrict  coeffs 
)
static

This function calculates the non-quasicircular correction to apply to the waveform.

The form of this correction can be found in Pan et al, PRD84, 124052(2011) [arXiv:1106.1021], Eq.(22), and also in the DCC document T1100433. Note that when calling this function, the NQC coefficients should already have been pre-computed. This version is for generic precesing case where the dynamics variable values are given in Catesean coordinates.

Parameters
nqc< OUTPUT, The NQC correction
values< Dynamics r, phi, pr, pphi
omega< Angular frequency
coeffs< NQC coefficients

Definition at line 488 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBCalculateNQCCoefficients()

static UNUSED int XLALSimIMREOBCalculateNQCCoefficients ( EOBNonQCCoeffs *restrict  coeffs,
REAL8Vector *restrict  amplitude,
REAL8Vector *restrict  phase,
REAL8Vector *restrict  q1,
REAL8Vector *restrict  q2,
REAL8Vector *restrict  q3,
REAL8Vector *restrict  p1,
REAL8Vector *restrict  p2,
INT4  l,
INT4  m,
REAL8  timePeak,
REAL8  deltaT,
REAL8  eta 
)
static

This function computes the coefficients a1, a2, etc.

used in the non-quasicircular correction. The details of the calculation of these coefficients are found in the DCC document T1100433.

Parameters
coeffs< OUTPUT, NQC coefficients
amplitude< Waveform amplitude, func of time
phase< Waveform phase(rad), func of time
q1< Function of dynamics (see DCC doc)
q2< Function of dynamics (see DCC doc)
q3< Function of dynamics (see DCC doc)
p1< Function of dynamics (see DCC doc)
p2< Function of dynamics (see DCC doc)
l< Mode l
m< Mode m
timePeak< Time of peak orbital frequency
deltaT< Sampling interval
eta< Symmetric mass ratio

Definition at line 547 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakDeltaT()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakDeltaT ( INT4  l,
INT4  m,
REAL8 UNUSED  eta,
REAL8  a 
)
inlinestatic

The time difference between the orbital peak and the peak amplitude of the mode in question (currently only 2,2 implemented ).

Eq. 33 of Taracchini et al. PRD 86, 024011 (2012) [arXiv:1202.0790].

Parameters
l< Mode l
m< Mode m
eta< Symmetric mass ratio
a< Dimensionless spin

Definition at line 818 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakAmplitudeV2()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakAmplitudeV2 ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8 UNUSED  a 
)
inlinestatic

Peak amplitude predicted by fitting NR results (currently only 2,2 available).

Unpublished. Used in building SEOBNRv2 tables.

Definition at line 869 of file LALSimIMREOBNQCCorrection.c.

◆ CombineTPLEQMFits()

static REAL8 CombineTPLEQMFits ( REAL8  eta,
REAL8  A1,
REAL8  fEQ,
REAL8  fTPL 
)
inlinestatic

Combine two spin-dependent fits of NR input values in a quardatic-in-eta polynomial with the linear-in-eta coefficient A1 being provided by a polyinamial-in-spin global fit to NR in the whole eta-chi plane.

See Eqs. (20)-(21) in https://dcc.ligo.org/T1600383

Definition at line 911 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakAmplitudeV4()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakAmplitudeV4 ( INT4  modeL,
INT4  modeM,
REAL8  m1,
REAL8  m2,
REAL8  chiS,
REAL8  chiA 
)
inlinestatic

Peak amplitude predicted by fitting NR results The coefficients for the mode (2,2) are in Eq.

(A1) of https://journals.aps.org/prd/pdf/10.1103/PhysRevD.95.044028 The coefficients for the modes (2,1), (3,3), (4,4), (5,5) are in Eqs. (B7-B10) of https://arxiv.org/pdf/1803.10701.pdf

Definition at line 929 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakADotV4()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakADotV4 ( INT4  modeL,
INT4  modeM,
REAL8 UNUSED  m1,
REAL8 UNUSED  m2,
REAL8 UNUSED  chiS,
REAL8 UNUSED  chiA 
)
inlinestatic

Peak amplitude slope predicted by fitting NR results.

The coefficient for the (2,2) is 0 because the attachment is done at the peak of the (2,2) mode see Eq.(2.7) in https://journals.aps.org/prd/pdf/10.1103/PhysRevD.95.044028 The coefficients for the modes (2,1), (3,3), (4,4) and (5,5) are in Eqs.(B11-B14) of https://arxiv.org/pdf/1803.10701.pdf

Definition at line 1040 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakADDotV2()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakADDotV2 ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8 UNUSED  a 
)
inlinestatic

Peak amplitude curvature predicted by fitting NR results (currently only 2,2 available).

Unpublished. Used in building SEOBNRv2 tables.

Definition at line 1131 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakADDotV4()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakADDotV4 ( INT4  modeL,
INT4  modeM,
REAL8  m1,
REAL8  m2,
REAL8  chiS,
REAL8  chiA 
)
inlinestatic

Peak amplitude curvature predicted by fitting NR results.

The coefficients for the (2,2) are in Eq.(A3-A4) of https://journals.aps.org/prd/pdf/10.1103/PhysRevD.95.044028 The coefficients for the modes (2,1), (3,3), (4,4) and (5,5) are in Eqs.(B15-B18) of https://arxiv.org/pdf/1803.10701.pdf

Definition at line 1167 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmegaV2()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaV2 ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8  a 
)
inlinestatic

Peak frequency predicted by fitting NR results (currently only 2,2 available).

Unpublished. Used in building SEOBNRv2 tables.

Definition at line 1269 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmegaV4()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaV4 ( INT4  modeL,
INT4  modeM,
REAL8 UNUSED  eta,
REAL8  a 
)
inlinestatic

Peak frequency predicted by fitting NR results The coefficients for the (2,2) are in Eq.

(A6) of https://journals.aps.org/prd/pdf/10.1103/PhysRevD.95.044028 The coefficients for the modes (2,1), (3,3), (4,4) and (5,5) are in Eqs.(B19-B22) of https://arxiv.org/pdf/1803.10701.pdf

Definition at line 1336 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmegaV5()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaV5 ( INT4  modeL,
INT4  modeM,
REAL8 UNUSED  eta,
REAL8  a 
)
inlinestatic

Peak frequency predicted by fitting NR results used in SEOBNRv5 The coefficients are in Eq.

(C29) of https://dcc.ligo.org/LIGO-P2300070

Definition at line 1424 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmegaDotV2()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaDotV2 ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8 UNUSED  a 
)
inlinestatic

Peak frequency slope predicted by fitting NR results (currently only 2,2 available).

Unpublished. Used in building SEOBNRv2 tables.

Definition at line 1465 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmegaDotV4()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaDotV4 ( INT4  modeL,
INT4  modeM,
REAL8 UNUSED  eta,
REAL8 UNUSED  a 
)
inlinestatic

Peak frequency slope predicted by fitting NR results The coefficients for the (2,2) are in Eq.

(A10) of https://journals.aps.org/prd/pdf/10.1103/PhysRevD.95.044028 The coefficients for the modes (2,1), (3,3), (4,4) and (5,5) are in Eqs.(B23-B26) of https://arxiv.org/pdf/1803.10701.pdf

Definition at line 1501 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakAmplitude()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakAmplitude ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8 UNUSED  a 
)
inlinestatic

Peak amplitude predicted by fitting NR results (currently only 2,2 available).

Tables IV and V and Eq. 42 of Taracchini et al. PRD 86, 024011 (2012) [arXiv:1202.0790].

Definition at line 1590 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakADDot()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakADDot ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8 UNUSED  a 
)
inlinestatic

Peak amplitude curvature predicted by fitting NR results (currently only 2,2 available).

Tables IV and V and Eq. 42 of Taracchini et al. PRD 86, 024011 (2012) [arXiv:1202.0790].

Definition at line 1602 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmega()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmega ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8  a 
)
inlinestatic

Peak frequency predicted by fitting NR results (currently only 2,2 available).

Tables IV and V and Eq. 42 of Taracchini et al. PRD 86, 024011 (2012) [arXiv:1202.0790].

Definition at line 1616 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmegaDot()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaDot ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8 UNUSED  a 
)
inlinestatic

Peak frequency slope predicted by fitting NR results (currently only 2,2 available).

Tables IV and V and Eq. 42 of Taracchini et al. PRD 86, 024011 (2012) [arXiv:1202.0790].

Definition at line 1632 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakDeltaTv2()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakDeltaTv2 ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  m1,
REAL8 UNUSED  m2,
REAL8  chi1,
REAL8  chi2 
)
inlinestatic

The time difference between the orbital peak and the peak amplitude of the mode in question (currently only 2,2 implemented ).

Parameters
l< Mode l
m< Mode m
m1< mass 1
m2< mass 22
chi1< Dimensionless spin1
chi2< Dimensionless spin2

Definition at line 1655 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakDeltaTv4()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakDeltaTv4 ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  m1,
REAL8 UNUSED  m2,
REAL8 UNUSED  chi1,
REAL8 UNUSED  chi2 
)
inlinestatic

The time difference between the orbital peak and the peak amplitude of the mode in question (currently only 2,2 implemented ).

Parameters
l< Mode l
m< Mode m
m1< mass 1
m2< mass 2
chi1< Dimensionless spin1
chi2< Dimensionless spin2

Definition at line 1699 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmegav2()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegav2 ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8  a 
)
inlinestatic

Peak frequency predicted by fitting NR results (currently only 2,2 available).

Take from unpublished SEOBNRv2 results.

Definition at line 1756 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMREOBGetNRSpinPeakOmegaDotv2()

static UNUSED REAL8 XLALSimIMREOBGetNRSpinPeakOmegaDotv2 ( INT4 UNUSED  l,
INT4 UNUSED  m,
REAL8 UNUSED  eta,
REAL8 UNUSED  a 
)
inlinestatic

Peak frequency slope predicted by fitting NR results (currently only 2,2 available).

Take from unpublished SEOBNRv2 results.

Definition at line 1815 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMRSpinEOBCalculateNQCCoefficients()

static UNUSED int XLALSimIMRSpinEOBCalculateNQCCoefficients ( REAL8Vector *restrict  amplitude,
REAL8Vector *restrict  phase,
REAL8Vector *restrict  rVec,
REAL8Vector *restrict  prVec,
REAL8Vector *restrict  orbOmegaVec,
INT4  l,
INT4  m,
REAL8  timePeak,
REAL8  deltaT,
REAL8  m1,
REAL8  m2,
REAL8  a,
REAL8  chiA,
REAL8  chiS,
EOBNonQCCoeffs *restrict  coeffs,
UINT4  SpinAlignedEOBversion 
)
static

This function computes the coefficients a3s, a4, etc.

used in the non-quasicircular correction. The details of the calculation of these coefficients are found in the DCC document T1100433. In brief, this function populates and solves the linear equations Eq. 18 (for amplitude) and Eq. 19 (for phase) of the DCC document T1100433v2.

Parameters
amplitude< Waveform amplitude, func of time
phase< Waveform phase(rad), func of time
rVec< Position-vector, function of time
prVec< Momentum vector, function of time
orbOmegaVec< Orbital frequency, func of time
l< Mode index l
m< Mode index m
timePeak< Time of peak orbital frequency
deltaT< Sampling interval
m1< Component mass 1
m2< Component mass 2
a< Normalized spin of deformed-Kerr
chiA< Assymmetric dimensionless spin combination
chiS< Symmetric dimensionless spin combination
coeffs< OUTPUT, NQC coefficients
SpinAlignedEOBversion< 1 for SEOBNRv1, 2 for SEOBNRv2

Definition at line 1848 of file LALSimIMREOBNQCCorrection.c.

◆ XLALSimIMRSpinEOBCalculateNQCCoefficientsV4()

static UNUSED int XLALSimIMRSpinEOBCalculateNQCCoefficientsV4 ( REAL8Vector *restrict  amplitude,
REAL8Vector *restrict  phase,
REAL8Vector *restrict  rVec,
REAL8Vector *restrict  prVec,
REAL8Vector *restrict  orbOmegaVec,
INT4  modeL,
INT4  modeM,
REAL8  timePeak,
REAL8  deltaT,
REAL8  m1,
REAL8  m2,
REAL8  chiA,
REAL8  chiS,
EOBNonQCCoeffs *restrict  coeffs 
)
static

This function computes the coefficients a3s, a4, etc.

used in the non-quasicircular correction. The details of the calculation of these coefficients are found in the DCC document T1100433. In brief, this function populates and solves the linear equations Eq. 18 (for amplitude) and Eq. 19 (for phase) of https://dcc.ligo.org/T1100433

Parameters
amplitude< Waveform amplitude, func of time
phase< Waveform phase(rad), func of time
rVec< Position-vector, function of time
prVec< Momentum vector, function of time
orbOmegaVec< Orbital frequency, func of time
modeL< Mode index l
modeM< Mode index m
timePeak< Time of peak orbital frequency
deltaT< Sampling interval
m1< Component mass 1
m2< Component mass 2
chiA< Assymmetric dimensionless spin combination
chiS< Symmetric dimensionless spin combination
coeffs< OUTPUT, NQC coefficients

Definition at line 2359 of file LALSimIMREOBNQCCorrection.c.