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

Prototypes

static UNUSED INT4 XLALSimIMRSpinEOBGetSpinFactorizedWaveform (COMPLEX16 *restrict hlm, REAL8Vector *restrict values, const REAL8 v, const REAL8 Hreal, const INT4 l, const INT4 m, SpinEOBParams *restrict params, INT4 use_optimized_v2)
 This function calculates hlm mode factorized-resummed waveform for given dynamical variables. More...
 
static UNUSED INT4 XLALSimIMRSpinEOBGetAmplitudeResidual (COMPLEX16 *restrict rholmpwrl, const REAL8 v, const REAL8 Hreal, const INT4 modeL, const INT4 modeM, SpinEOBParams *restrict params)
 This function calculate the residue amplitude terms. More...
 
static INT4 XLALSimIMRSpinEOBFluxGetSpinFactorizedWaveform (COMPLEX16 *restrict hlm, REAL8Vector *restrict values, const REAL8 v, const REAL8 Hreal, const INT4 l, const INT4 m, SpinEOBParams *restrict params, INT4 use_optimized_v2, REAL8 *vPhiInput)
 This function calculates hlm mode factorized-resummed waveform for given dynamical variables. More...
 
static int XLALSimIMREOBCalcSpinFacWaveformCoefficients (FacWaveformCoeffs *const coeffs, SpinEOBParams *restrict params, const REAL8 m1, const REAL8 m2, const REAL8 eta, REAL8 a, const REAL8 chiS, const REAL8 chiA, const UINT4 SpinAlignedEOBversion)
 Spin Factors. More...
 
static UNUSED int XLALSimIMREOBCalcCalibCoefficientHigherModes (FacWaveformCoeffs *const coeffs, SpinEOBParams *restrict UNUSED params, const UINT4 modeL, const UINT4 modeM, REAL8Vector *restrict phaseVec, REAL8Vector *restrict rVec, REAL8Vector *restrict prVec, REAL8Vector *restrict orbOmegaVec, REAL8Vector *restrict HamVec, REAL8Vector *restrict pPhiVec, const REAL8 timewavePeak, const REAL8 m1, const REAL8 m2, const REAL8 UNUSED chiS, const REAL8 UNUSED chiA, const REAL8 UNUSED deltaT)
 This function calculate the calibration parameter for the amplitude of the factorized-resummed waveforms in the case of the 21 and the 55 mode. More...
 
static REAL8 XLALTEOBbeta221 (REAL8 X)
 Function to compute PN corrections to the tidal term that enters the (2,2) amplitude. More...
 
static REAL8 XLALSimIMRTEOBk2effMode (REAL8 Omega, REAL8 k2TidaleffHam, REAL8 omega02Tidal, REAL8 XCompanion)
 Function to compute the dynamical enhancement of the quadrupolar Love number that enters the tidal corrections to the mode amplitudes. More...
 
static COMPLEX16 XLALhTidal (INT4 l, INT4 m, REAL8 phase, REAL8 v, REAL8 eta, TidalEOBParams *tidal1, TidalEOBParams *tidal2)
 Function to compute the tidal correction to the mode amplitudes. More...
 
static INT4 XLALSimIMRSpinEOBWaveformTidal (COMPLEX16 *restrict hlm, REAL8Vector *restrict values, const REAL8 v, const INT4 l, const INT4 m, SpinEOBParams *restrict params)
 This function calculates tidal correction to the hlm mode factorized-resummed waveform for given dynamical variables. More...
 

Go to the source code of this file.

Macros

#define _LALSIMIMRSPINEOBFACTORIZEDWAVEFORM_C
 Function to compute the factorized waveform as uses in the SEOBNRv1 model. Waveform expressions are given by Taracchini et al. ( PRD 86, 024011 (2012), arXiv 1202.0790 ). All equation numbers in this file refer to equations of this paper, unless otherwise specified. Coefficients of the so-called "deltalm" terms are given by Damour et al. PRD 79, 064004 (2009) [arXiv:0811.2069] and Pan et al. PRD 83, 064003 (2011) [arXiv:1006.0431], henceforth DIN and PBFRT. More...
 

Macro Definition Documentation

◆ _LALSIMIMRSPINEOBFACTORIZEDWAVEFORM_C

#define _LALSIMIMRSPINEOBFACTORIZEDWAVEFORM_C

Function to compute the factorized waveform as uses in the SEOBNRv1 model. Waveform expressions are given by Taracchini et al. ( PRD 86, 024011 (2012), arXiv 1202.0790 ). All equation numbers in this file refer to equations of this paper, unless otherwise specified. Coefficients of the so-called "deltalm" terms are given by Damour et al. PRD 79, 064004 (2009) [arXiv:0811.2069] and Pan et al. PRD 83, 064003 (2011) [arXiv:1006.0431], henceforth DIN and PBFRT.

Author
Craig Robinson, Yi Pan, Prayush Kumar, Andrea Taracchini

Functions to compute the factorized waveform for the purpose of computing the flux, i.e. returning only the absolute value of the multipoles. The tail term Tlm is used in its resummed form, given by Eq. (42) of Damour, Nagar and Bernuzzi, PRD 87 084035 (2013) [arxiv:1212.4357], called DNB here.

Definition at line 41 of file LALSimIMRSpinEOBFactorizedWaveform.c.

Function Documentation

◆ XLALSimIMRSpinEOBGetSpinFactorizedWaveform()

static INT4 XLALSimIMRSpinEOBGetSpinFactorizedWaveform ( COMPLEX16 *restrict  hlm,
REAL8Vector *restrict  values,
const REAL8  v,
const REAL8  Hreal,
const INT4  l,
const INT4  m,
SpinEOBParams *restrict  params,
INT4  use_optimized_v2 
)
static

This function calculates hlm mode factorized-resummed waveform for given dynamical variables.

Eq. 17 and the entire Appendix of the paper.

Parameters
hlmOUTPUT, hlm waveforms
valuesdyanmical variables
vvelocity
Hrealreal Hamiltonian
ll mode index
mm mode index
paramsSpin EOB parameters
use_optimized_v2Spin EOB parameters

Definition at line 2144 of file LALSimIMRSpinEOBFactorizedWaveform.c.

◆ XLALSimIMRSpinEOBGetAmplitudeResidual()

static UNUSED INT4 XLALSimIMRSpinEOBGetAmplitudeResidual ( COMPLEX16 *restrict  rholmpwrl,
const REAL8  v,
const REAL8  Hreal,
const INT4  modeL,
const INT4  modeM,
SpinEOBParams *restrict  params 
)
static

This function calculate the residue amplitude terms.

Definition at line 227 of file LALSimIMRSpinEOBFactorizedWaveform.c.

◆ XLALSimIMRSpinEOBFluxGetSpinFactorizedWaveform()

static INT4 XLALSimIMRSpinEOBFluxGetSpinFactorizedWaveform ( COMPLEX16 *restrict  hlm,
REAL8Vector *restrict  values,
const REAL8  v,
const REAL8  Hreal,
const INT4  l,
const INT4  m,
SpinEOBParams *restrict  params,
INT4  use_optimized_v2,
REAL8 *  vPhiInput 
)
static

This function calculates hlm mode factorized-resummed waveform for given dynamical variables.

This is optimized for flux calculation, by ignoring complex arguments and keeping only absolute values. Changes: (i) Complex Argument of Tlm not exponentiated. (ii) \(exp(\ii deltalm)\) set to 1. Eq. 17 and the entire Appendix of the paper https://journals.aps.org/prd/abstract/10.1103/PhysRevD.86.024011.

Parameters
hlmOUTPUT, hlm waveforms
valuesdyanmical variables
vvelocity
Hrealreal Hamiltonian
ll mode index
mm mode index
paramsSpin EOB parameters
use_optimized_v2Use optimized v2?
vPhiInputReuse vPhi computed outside for efficiency!

Definition at line 804 of file LALSimIMRSpinEOBFactorizedWaveform.c.

◆ XLALSimIMREOBCalcSpinFacWaveformCoefficients()

static UNUSED int XLALSimIMREOBCalcSpinFacWaveformCoefficients ( FacWaveformCoeffs *const  coeffs,
SpinEOBParams *restrict  params,
const REAL8  m1,
const REAL8  m2,
const REAL8  eta,
REAL8  a,
const REAL8  chiS,
const REAL8  chiA,
const UINT4  SpinAlignedEOBversion 
)
static

Spin Factors.

This function calculates coefficients for hlm mode factorized-resummed waveform. The coefficients are pre-computed and stored in the SpinEOBParams structure. Appendix of the paper, and papers DIN (PRD 79, 064004 (2009) [arXiv:0811.2069]) and PBFRT (PRD 83, 064003 (2011)). Concerning SEOBNRv4 see also https://dcc.ligo.org/T1600383

Parameters
coeffsOUTPUT, pre-computed waveform coefficients
paramsOthers parameters like use_hm
m1mass 1
m2mass 2
etasymmetric mass ratio
aKerr spin parameter for test-particle terms
chiS(chi1+chi2)/2
chiA(chi1-chi2)/2
SpinAlignedEOBversion1 for SEOBNRv1; 2 for SEOBNRv2; 4 for SEOBNRv4

Definition at line 1330 of file LALSimIMRSpinEOBFactorizedWaveform.c.

◆ XLALSimIMREOBCalcCalibCoefficientHigherModes()

static int XLALSimIMREOBCalcCalibCoefficientHigherModes ( FacWaveformCoeffs *const  coeffs,
SpinEOBParams *restrict UNUSED  params,
const UINT4  modeL,
const UINT4  modeM,
REAL8Vector *restrict  phaseVec,
REAL8Vector *restrict  rVec,
REAL8Vector *restrict  prVec,
REAL8Vector *restrict  orbOmegaVec,
REAL8Vector *restrict  HamVec,
REAL8Vector *restrict  pPhiVec,
const REAL8  timePeak,
const REAL8  m1,
const REAL8  m2,
const REAL8 UNUSED  chiS,
const REAL8 UNUSED  chiA,
const REAL8 UNUSED  deltaT 
)
static

This function calculate the calibration parameter for the amplitude of the factorized-resummed waveforms in the case of the 21 and the 55 mode.

Physical quantities

Initializing stuff for interpolation

Calculation and interpolation at the matching point of rho_lm^l + f_lm

Parameters
coeffsOutput
paramsAdditional structure which might be useful in the future
modeLMode index L
modeMMode index M
phaseVecOrbital phase, function of time
rVecPosition-vector, function of time
prVecMomentum vector, function of time
orbOmegaVecOrbital frequency, func of time
HamVecHamiltonian vector, func of time
pPhiVecAngular momentum vector, func of time
timePeakTime of peak orbital frequency
m1Component mass 1
m2Component mass 2
chiSSymmetric dimensionless spin combination
chiAAsymmetric dimensionless spin combination
deltaTSampling interval

Definition at line 635 of file LALSimIMRSpinEOBFactorizedWaveform.c.

◆ XLALTEOBbeta221()

static REAL8 XLALTEOBbeta221 ( REAL8  X)
static

Function to compute PN corrections to the tidal term that enters the (2,2) amplitude.

Parameters
X< NS mass

Definition at line 124 of file LALSimIMRSpinEOBFactorizedWaveform.c.

◆ XLALSimIMRTEOBk2effMode()

static REAL8 XLALSimIMRTEOBk2effMode ( REAL8  Omega,
REAL8  k2TidaleffHam,
REAL8  omega02Tidal,
REAL8  XCompanion 
)
static

Function to compute the dynamical enhancement of the quadrupolar Love number that enters the tidal corrections to the mode amplitudes.

Parameters
Omega< Orbital frequency
k2TidaleffHam< Dynamical enhancement of k2Tidal that enters the Hamiltonian
omega02Tidal< f-mode frequency
XCompanion< Mass of NS companion divided by M

Definition at line 132 of file LALSimIMRSpinEOBFactorizedWaveform.c.

◆ XLALhTidal()

static COMPLEX16 XLALhTidal ( INT4  l,
INT4  m,
REAL8  phase,
REAL8  v,
REAL8  eta,
TidalEOBParams *  tidal1,
TidalEOBParams *  tidal2 
)
static

Function to compute the tidal correction to the mode amplitudes.

Parameters
l< Mode index
m< Mode index
phase< Orbutal phase
v< Orbital speed^2
eta< Symmetric mass ratio
tidal1< Tidal parameters of body 1
tidal2< Tidal parameters of body 2

Definition at line 145 of file LALSimIMRSpinEOBFactorizedWaveform.c.

◆ XLALSimIMRSpinEOBWaveformTidal()

static INT4 XLALSimIMRSpinEOBWaveformTidal ( COMPLEX16 *restrict  hlm,
REAL8Vector *restrict  values,
const REAL8  v,
const INT4  l,
const INT4  m,
SpinEOBParams *restrict  params 
)
static

This function calculates tidal correction to the hlm mode factorized-resummed waveform for given dynamical variables.

Parameters
hlmOUTPUT, hlm waveforms
valuesdyanmical variables
vvelocity
ll mode index
mm mode index
paramsSpin EOB parameters

Definition at line 2774 of file LALSimIMRSpinEOBFactorizedWaveform.c.