Routines for generating binary inspiral gravitational waveforms.
Modules | |
Module LALSimInspiral.c | |
General routines for generating binary inspiral waveforms. | |
Module LALSimInspiralPNMode.c | |
Routines for mode decompositions of post-Newtonian waveforms. | |
Module LALSimInspiralTaylorXX.c | |
Routines to produce Taylor -T1, -T2, -T3, -T4, -F2, and -Et inspiral waveforms. | |
Module LALSimInspiralTaylorF2Ecc.c | |
Routines for generating eccentric TaylorF2 waveforms. | |
Module LALSimInspiralSpinTaylor.c | |
Routines for generating spin precessing Taylor waveforms. | |
Module LALSimInspiralEccentricTD.c | |
Routines to generate time-domain eccentric inspiral waveforms. | |
Module LALSimInspiralEccentricityFD.c | |
Routines to generate frequency-domain eccentric inspiral waveforms. | |
Module LALSimInspiralSpinDominatedWaveform.c | |
Module LALSimInspiralTaylorF2ReducedSpin.c | |
Routines for generating TaylorF2 reduced spin inspiral waveforms. | |
Module LALSimInspiralHGimri.c | |
Routines for generating the Huerta-Gair Intermediate-Mass-Ratio Inspiral model. | |
Module LALSimInspiralWaveformFlags.c | |
Routines to manipulate inspiral waveform flags structures. | |
Module LALSimInspiralTestGRParams.c | |
Routines to manipulate non-GR parameter key-value pairs. | |
Module LALSimInspiralWaveformTaper.c | |
The code XLALInspiralREAL4WaveformTaper() and XLALInspiralREAL8WaveTaper() impose a smooth time tapering at the beginning and/or the end of REAL4 or REAL8 waveforms in the time domain. | |
Module LALSimInspiralNRSur4d2s.c | |
Module LALSimIMRNRHybSur3dq8.c | |
Data Structures | |
struct | PNPhasingSeries |
struct | LALSimInspiralTestGRParamData |
Linked list node for the testing GR parameters. More... | |
struct | LALSimInspiralTestGRParam |
Linked list of any number of parameters for testing GR. More... | |
Macros | |
#define | LAL_PN_MODE_L_MAX 3 |
#define | LAL_MAX_PN_ORDER 8 |
#define | LAL_MAX_ECC_PN_ORDER 6 |
#define | LAL_DEFAULT_F_ECC -1.0 |
#define | PN_PHASING_SERIES_MAX_ORDER 15 |
Structure for passing around PN phasing coefficients. More... | |
#define | LAL_SIM_INSPIRAL_SPIN_ORDER_DEFAULT LAL_SIM_INSPIRAL_SPIN_ORDER_ALL |
Default values for all enumerated flags. More... | |
#define | LAL_SIM_INSPIRAL_TIDAL_ORDER_DEFAULT LAL_SIM_INSPIRAL_TIDAL_ORDER_ALL |
#define | LAL_SIM_INSPIRAL_GMTIDES_DEFAULT LAL_SIM_INSPIRAL_GMTIDES_OFF |
#define | LAL_SIM_INSPIRAL_FRAME_AXIS_DEFAULT LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L |
#define | LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT LAL_SIM_INSPIRAL_MODES_CHOICE_RESTRICTED |
#define | LAL_SIM_L_MAX_MODE_ARRAY 8 |
Maximum L spherical harmonic mode that is supported in Mode Array. More... | |
Files | |
file | LALSimInspiraldEnergyFlux.c |
Module containing the energy and flux functions for waveform generation. | |
file | LALSimInspiralTaylorLength.c |
NONE. | |
enum Approximant |
Enum that specifies the PN approximant to be used in computing the waveform.
Please add new approximants at the end of the list, so as to prevent the values changing for existing approximants and breaking ABI compatibility.
Enumerator | |
---|---|
TaylorT1 | Time domain Taylor approximant in which the energy and flux are both kept as Taylor expansions and a first order ordinary differential equation is solved or the GW phase as a function of \(t\); Outputs a time-domain wave.
|
TaylorT2 | Time domain Taylor approximant in which the phase evolution \(\varphi(t)\) is obtained by iteratively solving post-Newtonian expansions \(\varphi(v)\) and \(t(v)\); Outputs a time-domain wave.
|
TaylorT3 | Time domain Taylor approximant in which phase is explicitly given as a function of time; outputs a time-domain wave.
|
TaylorF1 | The stationary phase approximation that correctly represents, in the Fourier domain, the waveform given by
|
EccentricFD | Frequency domain waveform in the SPA to describe low eccentricity systems.
|
TaylorF2 | The standard stationary phase approximation; Outputs a frequency-domain wave.
|
TaylorF2Ecc | The standard stationary phase approximation with eccentricity; Outputs a frequency-domain wave.
|
TaylorF2NLTides | The standard stationary phase approximation including a phenomenological model of nonlinear tidal effects; Outputs a frequency-domain wave.
|
TaylorR2F4 | A frequency domain model closely related to TaylorT4.
|
TaylorF2RedSpin | TaylorF2 waveforms for non-precessing spins, defined in terms of a single (reduced-spin) parameter [Ajith_2011ec].
|
TaylorF2RedSpinTidal | TaylorF2 waveforms for non-precessing spins, defined in terms of a single (reduced-spin) parameter [Ajith_2011ec] plus tidal terms (http://arxiv.org/abs/1101.1673).
|
PadeT1 | Time-domain P-approximant; Outputs a time-domain wave.
|
PadeF1 | Frequency-domain P-approximant (not yet implemented).
|
EOB | Effective one-body waveform; Outputs a time-domain wave.
|
BCV | Detection template family of Buonanno, Chen and Vallisneri [3]; Outputs a frequency-domain wave.
|
BCVSpin | Detection template family of Buonanno, Chen and Vallisneri including spin effects [4]; Outputs a frequency-domain wave.
|
SpinTaylorT1 | Spinning case T1 models.
|
SpinTaylorT2 | Spinning case T2 models.
|
SpinTaylorT3 | Spinning case T3 models.
|
SpinTaylorT4 | Spinning case T4 models (lalsimulation's equivalent of SpinTaylorFrameless).
|
SpinTaylorT5 | Spinning case T5 models, which is a variant of the spinning version of the original TaylorT2 (see [5]) described in sec. III of [1]. SpinTaylorT2 is NOT implemented in LALSimulation.
|
SpinTaylorF2 | Spinning case F2 models (single spin only).
|
SpinTaylorFrameless | Spinning case PN models (replace SpinTaylor by removing the coordinate singularity)
|
SpinTaylor | Spinning case PN models (should replace SpinTaylorT3 in the future)
|
PhenSpinTaylor | Inspiral part of the PhenSpinTaylorRD.
|
PhenSpinTaylorRD | Phenomenological waveforms, interpolating between a T4 spin-inspiral and the ringdown.
|
SpinQuadTaylor | Spinning case PN models with quadrupole-monopole and self-spin interaction.
|
FindChirpSP | The stationary phase templates implemented by FindChirpSPTemplate in the findchirp package (equivalent to TaylorF2 at twoPN order).
|
FindChirpPTF | UNDOCUMENTED.
|
GeneratePPN | The time domain templates generated by LALGeneratePPNInspiral() in the inject package (equivalent to TaylorT3 at twoPN order).
|
BCVC | UNDOCUMENTED.
|
FrameFile | The waveform contains arbitrary data read from a frame file.
|
AmpCorPPN | UNDOCUMENTED.
|
NumRel | UNDOCUMENTED.
|
NumRelNinja2 | The waveform contains REAL8 data generated by lalapps_fr_ninja from a file in the format described in arXiv:0709.0093v3.
|
Eccentricity | UNDOCUMENTED.
|
EOBNR | UNDOCUMENTED.
|
EOBNRv2 | UNDOCUMENTED.
|
EOBNRv2HM | UNDOCUMENTED.
|
EOBNRv2_ROM | Frequency domain reduced order model of model EOBNRv2HM, no spin neither higher modes.
|
EOBNRv2HM_ROM | Frequency domain reduced order model of model EOBNRv2HM, no spin but with higher modes.
|
TEOBResum_ROM | Time domain reduced order model of EOB with tidal effects.
|
SEOBNRv1 | Spin-aligned EOBNR model.
|
SEOBNRv2 | Spin-aligned EOBNR model v2.
|
SEOBNRv2_opt | Optimized Spin-aligned EOBNR model v2.
|
SEOBNRv3 | Spin precessing EOBNR model v3.
|
SEOBNRv3_pert | Perturbed [m1 -> m1*(1+1e-15)] Spin precessing EOBNR model v3.
|
SEOBNRv3_opt | Optimized Spin precessing EOBNR model v3.
|
SEOBNRv3_opt_rk4 | USE RK4 Optimized Spin precessing EOBNR model v3.
|
SEOBNRv4 | Spin nonprecessing EOBNR model v4.
|
SEOBNRv4_opt | Optimized Spin-aligned EOBNR model v4.
|
SEOBNRv4P | Spin precessing EOBNR model based on SEOBNRv4.
|
SEOBNRv4PHM | Spin precessing EOBNR model based on SEOBNRv4HM.
|
SEOBNRv2T | Tidal EOB model.
|
SEOBNRv4T | Tidal EOB model.
|
SEOBNRv1_ROM_EffectiveSpin | Single-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv1 See [Purrer:2014fza].
|
SEOBNRv1_ROM_DoubleSpin | Double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv1 See [Purrer:2014fza].
|
SEOBNRv2_ROM_EffectiveSpin | Single-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv2.
|
SEOBNRv2_ROM_DoubleSpin | Double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv2.
|
SEOBNRv2_ROM_DoubleSpin_HI | High resolution low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv2.
|
Lackey_Tidal_2013_SEOBNRv2_ROM | Frequency domain tidal model based on reduced order model of SEOBNRv2.
|
SEOBNRv4_ROM | Low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv4.
|
SEOBNRv4HM_ROM | Low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv4hm.
|
SEOBNRv4_ROM_NRTidal | Low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv4 [Bohe et al, arXiv:1611.03703] with tidal phase corrections [Dietrich et al, arXiv:1706.02969.
|
SEOBNRv4_ROM_NRTidalv2 | based on NRTidalv2; https://arxiv.org/abs/1905.06011.
|
SEOBNRv4_ROM_NRTidalv2_NSBH | NSBH model based on SEOBNRv4_ROM_NRTidalv2.
|
SEOBNRv4T_surrogate | Double-spin frequency domain surrogate model of spin-aligned tidal EOBNR model SEOBNRv4T.
|
HGimri | Time domain inspiral-merger-ringdown waveform for quasi-circular intermediate mass-ratio inspirals [Huerta & Gair arXiv:1009.1985].
|
IMRPhenomA | Time domain (non-spinning) inspiral-merger-ringdown waveforms generated from the inverse FFT of IMRPhenomFA.
|
IMRPhenomB | Time domain (non-precessing spins) inspiral-merger-ringdown waveforms generated from the inverse FFT of IMRPhenomFB.
|
IMRPhenomFA | Frequency domain (non-spinning) inspiral-merger-ringdown templates of Ajith et al [Ajith_2007kx] with phenomenological coefficients defined in the Table I of [Ajith_2007xh].
|
IMRPhenomFB | Frequency domain (non-precessing spins) inspiral-merger-ringdown templates of Ajith et al [Ajith_2009bn].
|
IMRPhenomC | Frequency domain (non-precessing spins) inspiral-merger-ringdown templates of Santamaria et al [Santamaria:2010yb] with phenomenological coefficients defined in the Table II of [Santamaria:2010yb].
|
IMRPhenomD | Frequency domain (non-precessing spins) inspiral-merger-ringdown templates of Husa et al, arXiv:1508.07250 and Khan et al, arXiv:1508.07253 with phenomenological coefficients defined in the Table ...
|
IMRPhenomD_NRTidal | Uses arxiv:1706.02969 to upgrad IMRPhenomD to a tidal approximant.
|
IMRPhenomD_NRTidalv2 | NRTidalv2; https://arxiv.org/abs/1905.06011.
|
IMRPhenomNSBH | NSBH Tidal model.
|
IMRPhenomHM | Frequency domain with higher modes (non-precessing spins) inspiral-merger-ringdown templates, based on IMRPhenomD.
|
IMRPhenomP | Frequency domain (generic spins) inspiral-merger-ringdown templates of Hannam et al., arXiv:1308.3271 [gr-qc]. Based on IMRPhenomC.
|
IMRPhenomPv2 | Frequency domain (generic spins) inspiral-merger-ringdown templates of Hannam et al., arXiv:1308.3271 [gr-qc]. Based on IMRPhenomD, arXiv:1508.07250 and arXiv:1508.07253.
|
IMRPhenomPv2_NRTidal | Frequency domain tidal version of IMRPhenomPv2, using NRTidal framework from arXiv:1706.02969. |
IMRPhenomPv2_NRTidalv2 | Frequency domain tidal version; based on https://arxiv.org/abs/1905.06011.
|
IMRPhenomFC | Frequency domain (non-precessing spins) inspiral-merger-ringdown templates of Santamaria et al [Santamaria:2010yb] with phenomenological coefficients defined in the Table II of [Santamaria:2010yb].
|
TaylorEt | UNDOCUMENTED.
|
TaylorT4 | UNDOCUMENTED.
|
EccentricTD | Time domain Taylor T4 approximant including orbital eccentricity effects.
|
TaylorN | UNDOCUMENTED.
|
SpinTaylorT4Fourier | Frequency domain (generic spins) inspiral only waveforms based on TaylorT4, arXiv: 1408.5158.
|
SpinTaylorT5Fourier | Frequency domain (generic spins) inspiral only waveforms based on TaylorT5, [13] , (the paper refers to SpinTaylorT2, but it is actually SpinTaylorT5 which is being used.)
|
SpinDominatedWf | Time domain, inspiral only, 1 spin, precessing waveform, Tapai et al, arXiv: 1209.1722.
|
NR_hdf5 | Time domain, NR waveform from HDF file. From INSERT LINKS HERE |
NRSur4d2s | |
NRSur7dq2 | Time domain, fully precessing NR surrogate model with up to ell=4 modes, arxiv: 1705.07089. |
NRSur7dq4 | q=4 extension of NRSur7dq2, arxiv: 1905.09300 |
SEOBNRv4HM | Spin nonprecessing EOBNR model v4 with higher modes, PhysRevD.98.084028 [arXiv:1803.10701].
|
NRHybSur3dq8 | Time domain, aligned-spin, higher modes, hybridized. Paper arxiv:1812.07865 |
IMRPhenomXAS | Frequency domain, non-precessing phenomenological IMR waveform model ([arXiv:2001.11412]). |
IMRPhenomXHM | Frequency domain, non-precessing phenomenological IMR waveform model with subdominant modes ([arXiv:2001.10914 [gr-qc]]) and accelerated evaluation through adapted grids (arXiv:2001.10897 [gr-qc]) |
IMRPhenomPv3 | Frequency domain (generic spins) inspiral-merger-ringdown templates of Hannam et al., arXiv:1308.3271 [gr-qc]. Based on IMRPhenomD, arXiv:1508.07250 and arXiv:1508.07253. But updated the precession angles to use the ones in arXiv 1703.03967.
|
IMRPhenomPv3HM | Frequency domain (generic spins) inspiral-merger-ringdown templates of Khan et al. PhysRevD.101.024056. Based on IMRPhenomHM arXiv:1708.00404. And the precession angles of IMRPhenomPv3 1809.10113 and arXiv 1703.03967.
|
IMRPhenomXP | Frequency domain, precessing phenomenological IMR waveform model. |
IMRPhenomXPHM | Frequency domain, precessing with subdominant modes phenomenological IMR waveform model. |
TEOBResumS | Resummed Spin-aligned Tidal EOB.
|
IMRPhenomT | |
IMRPhenomTHM | Time domain, non-precessing phenomenological IMR waveform model for the dominant (2,2) and (2,-2) modes ([arXiv: 20XY.ZZZZZ]). |
IMRPhenomTP | Time domain, non-precessing phenomenological IMR waveform model with subdominant modes ([arXiv: 20XY.ZZZZZ]). |
IMRPhenomTPHM | Time domain, precessing phenomenological IMR waveform model for L=2 sector ([arXiv: 20XY.ZZZZZ]). |
SEOBNRv5_ROM | Time domain, precessing phenomenological IMR waveform model with subdominant modes ([arXiv: 20XY.ZZZZZ]). Low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv5
|
SEOBNRv4HM_PA | |
pSEOBNRv4HM_PA | Spin non-precessing EOBNR model v4 with higher modes post-adiabatic dynamics (time domain), PhysRevD.104.124087 [arXiv:2105.06983]. |
IMRPhenomXAS_NRTidalv2 | Spin non-precessing EOBNR model v4 with higher modes post-adiabatic dynamics (time domain) and TGR ringdown effects, PhysRevD.104.124087 [arXiv:2105.06983]. Tidal extension of IMRPhenomXAS based on [arXiv:1905.06011]. |
IMRPhenomXP_NRTidalv2 | Tidal extension of IMRPhenomXP based on [arXiv:1905.06011]. |
IMRPhenomXO4a | Frequency domain, precessing with subdominant modes phenomenological IMR waveform model with NR-tuned precession angles. |
ExternalPython | |
SEOBNRv5HM_ROM | External Python model. Low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv5HM
|
IMRPhenomXAS_NRTidalv3 | Tidal extension of IMRPhenomXAS based on NRTidalv3. |
IMRPhenomXP_NRTidalv3 | Tidal extension of IMRPhenomXP based on NRTidalv3. |
SEOBNRv5_ROM_NRTidalv3 | based on NRTidalv3 (arXiv:2311.07456);
|
IMRPhenomXPNR | Frequency domain, precessing with subdominant modes phenomenological IMR waveform model with SpinTaylor and NR-tuned precession angles. |
NumApproximants | Number of elements in enum, useful for checking bounds. |
Definition at line 229 of file LALSimInspiral.h.
enum FrequencyFunction |
Enum of various frequency functions.
Definition at line 459 of file LALSimInspiral.h.
enum LALPNOrder |
Enum of possible values to use for post-Newtonian order.
Definition at line 480 of file LALSimInspiral.h.
Enumeration to specify the tapering method to apply to the waveform.
Definition at line 494 of file LALSimInspiral.h.
enum LALSimulationDomain |
Enumeration to specify time or frequency domain.
Enumerator | |
---|---|
LAL_SIM_DOMAIN_TIME | |
LAL_SIM_DOMAIN_FREQUENCY |
Definition at line 504 of file LALSimInspiral.h.
enum SpinSupport |
Definition at line 509 of file LALSimInspiral.h.
enum SpinFreq |
Definition at line 518 of file LALSimInspiral.h.
enum AllowZeroMinFreq |
Definition at line 526 of file LALSimInspiral.h.
enum TestGRaccept |
Definition at line 532 of file LALSimInspiral.h.
Enumeration of allowed PN orders of spin effects.
All effects up to and including the given order will be included in waveforms. They can be specified by integers equal to twice the PN order, so e.g. LAL_SIM_INSPIRAL_SPIN_ORDER_25PN = 5 In addition, LAL_SIM_INSPIRAL_SPIN_ORDER_ALL = -1 is a flag to include all available spin effects
Definition at line 58 of file LALSimInspiralWaveformFlags.h.
Enumeration of allowed PN orders of tidal effects.
All effects up to and including the given order will be included in waveforms. Numerically, they are equal to twice the PN order, so e.g. LAL_SIM_INSPIRAL_TIDAL_ORDER_5PN = 10 In addition, LAL_SIM_INSPIRAL_TIDAL_ORDER_ALL = -1 is a flag to include all tidal PN orders up to the default value (which currently is 7PN for TaylorF2, 6PN for all other approximants).
Definition at line 80 of file LALSimInspiralWaveformFlags.h.
Enumerator | |
---|---|
LAL_SIM_INSPIRAL_GETIDES_OFF | |
LAL_SIM_INSPIRAL_GETIDES_NNLO | |
LAL_SIM_INSPIRAL_GETIDES_GSF2 | |
LAL_SIM_INSPIRAL_GETIDES_GSF23 | |
LAL_SIM_INSPIRAL_GETIDES_NOPT |
Definition at line 90 of file LALSimInspiralWaveformFlags.h.
Enumerator | |
---|---|
LAL_SIM_INSPIRAL_GMTIDES_OFF | |
LAL_SIM_INSPIRAL_GMTIDES_PN | |
LAL_SIM_INSPIRAL_GMTIDES_GSF | |
LAL_SIM_INSPIRAL_GMTIDES_NOPT |
Definition at line 98 of file LALSimInspiralWaveformFlags.h.
Enumerator for choosing the reference frame associated with PSpinInspiralRD waveforms.
Definition at line 110 of file LALSimInspiralWaveformFlags.h.
Enumerator for choosing which modes to include in IMR models.
'ALL' means to use all modes available to that model.
'RESTRICTED' means only the (2,2) mode for non-precessing models or only the set of l=2 modes for precessing models.
Definition at line 124 of file LALSimInspiralWaveformFlags.h.
#define LAL_PN_MODE_L_MAX 3 |
Definition at line 218 of file LALSimInspiral.h.
#define LAL_MAX_PN_ORDER 8 |
Definition at line 220 of file LALSimInspiral.h.
#define LAL_MAX_ECC_PN_ORDER 6 |
Definition at line 221 of file LALSimInspiral.h.
#define LAL_DEFAULT_F_ECC -1.0 |
Definition at line 222 of file LALSimInspiral.h.
#define PN_PHASING_SERIES_MAX_ORDER 15 |
Structure for passing around PN phasing coefficients.
For use with the TaylorF2 waveform.
Definition at line 544 of file LALSimInspiral.h.
#define LAL_SIM_INSPIRAL_SPIN_ORDER_DEFAULT LAL_SIM_INSPIRAL_SPIN_ORDER_ALL |
Default values for all enumerated flags.
Definition at line 40 of file LALSimInspiralWaveformFlags.h.
#define LAL_SIM_INSPIRAL_TIDAL_ORDER_DEFAULT LAL_SIM_INSPIRAL_TIDAL_ORDER_ALL |
Definition at line 41 of file LALSimInspiralWaveformFlags.h.
#define LAL_SIM_INSPIRAL_GMTIDES_DEFAULT LAL_SIM_INSPIRAL_GMTIDES_OFF |
Definition at line 42 of file LALSimInspiralWaveformFlags.h.
#define LAL_SIM_INSPIRAL_FRAME_AXIS_DEFAULT LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L |
Definition at line 43 of file LALSimInspiralWaveformFlags.h.
#define LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT LAL_SIM_INSPIRAL_MODES_CHOICE_RESTRICTED |
Definition at line 44 of file LALSimInspiralWaveformFlags.h.
#define LAL_SIM_L_MAX_MODE_ARRAY 8 |
Maximum L spherical harmonic mode that is supported in Mode Array.
Definition at line 47 of file LALSimInspiralWaveformFlags.h.