Header LALSimInspiral.h

Detailed Description

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...

Enumerations
enum	Approximant {   TaylorT1 , TaylorT2 , TaylorT3 , TaylorF1 ,   EccentricFD , TaylorF2 , TaylorF2Ecc , TaylorF2NLTides ,   TaylorR2F4 , TaylorF2RedSpin , TaylorF2RedSpinTidal , PadeT1 ,   PadeF1 , EOB , BCV , BCVSpin ,   SpinTaylorT1 , SpinTaylorT2 , SpinTaylorT3 , SpinTaylorT4 ,   SpinTaylorT5 , SpinTaylorF2 , SpinTaylorFrameless , SpinTaylor ,   PhenSpinTaylor , PhenSpinTaylorRD , SpinQuadTaylor , FindChirpSP ,   FindChirpPTF , GeneratePPN , BCVC , FrameFile ,   AmpCorPPN , NumRel , NumRelNinja2 , Eccentricity ,   EOBNR , EOBNRv2 , EOBNRv2HM , EOBNRv2_ROM ,   EOBNRv2HM_ROM , TEOBResum_ROM , SEOBNRv1 , SEOBNRv2 ,   SEOBNRv2_opt , SEOBNRv3 , SEOBNRv3_pert , SEOBNRv3_opt ,   SEOBNRv3_opt_rk4 , SEOBNRv4 , SEOBNRv4_opt , SEOBNRv4P ,   SEOBNRv4PHM , SEOBNRv2T , SEOBNRv4T , SEOBNRv1_ROM_EffectiveSpin ,   SEOBNRv1_ROM_DoubleSpin , SEOBNRv2_ROM_EffectiveSpin , SEOBNRv2_ROM_DoubleSpin , SEOBNRv2_ROM_DoubleSpin_HI ,   Lackey_Tidal_2013_SEOBNRv2_ROM , SEOBNRv4_ROM , SEOBNRv4HM_ROM , SEOBNRv4_ROM_NRTidal ,   SEOBNRv4_ROM_NRTidalv2 , SEOBNRv4_ROM_NRTidalv2_NSBH , SEOBNRv4T_surrogate , HGimri ,   IMRPhenomA , IMRPhenomB , IMRPhenomFA , IMRPhenomFB ,   IMRPhenomC , IMRPhenomD , IMRPhenomD_NRTidal , IMRPhenomD_NRTidalv2 ,   IMRPhenomNSBH , IMRPhenomHM , IMRPhenomP , IMRPhenomPv2 ,   IMRPhenomPv2_NRTidal , IMRPhenomPv2_NRTidalv2 , IMRPhenomFC , TaylorEt ,   TaylorT4 , EccentricTD , TaylorN , SpinTaylorT4Fourier ,   SpinTaylorT5Fourier , SpinDominatedWf , NR_hdf5 , NRSur4d2s ,   NRSur7dq2 , NRSur7dq4 , SEOBNRv4HM , NRHybSur3dq8 ,   IMRPhenomXAS , IMRPhenomXHM , IMRPhenomPv3 , IMRPhenomPv3HM ,   IMRPhenomXP , IMRPhenomXPHM , TEOBResumS , IMRPhenomT ,   IMRPhenomTHM , IMRPhenomTP , IMRPhenomTPHM , SEOBNRv5_ROM ,   SEOBNRv4HM_PA , pSEOBNRv4HM_PA , IMRPhenomXAS_NRTidalv2 , IMRPhenomXP_NRTidalv2 ,   IMRPhenomXO4a , ExternalPython , SEOBNRv5HM_ROM , NumApproximants }
	Enum that specifies the PN approximant to be used in computing the waveform. More...
enum	FrequencyFunction {   fSchwarzISCO , fIMRPhenomAFinal , fIMRPhenomBFinal , fIMRPhenomCFinal ,   fIMRPhenomDPeak , fEOBNRv2RD , fEOBNRv2HMRD , fSEOBNRv1Peak ,   fSEOBNRv1RD , fSEOBNRv2Peak , fSEOBNRv2RD , fSEOBNRv4Peak ,   fSEOBNRv4RD , fTEOBResumSFinal , fSEOBNRv5Peak , fSEOBNRv5RD ,   NumFreqFunctions }
	Enum of various frequency functions. More...
enum	LALPNOrder {   LAL_PNORDER_NEWTONIAN , LAL_PNORDER_HALF , LAL_PNORDER_ONE , LAL_PNORDER_ONE_POINT_FIVE ,   LAL_PNORDER_TWO , LAL_PNORDER_TWO_POINT_FIVE , LAL_PNORDER_THREE , LAL_PNORDER_THREE_POINT_FIVE ,   LAL_PNORDER_PSEUDO_FOUR , LAL_PNORDER_NUM_ORDER }
	Enum of possible values to use for post-Newtonian order. More...
enum	LALSimInspiralApplyTaper {   LAL_SIM_INSPIRAL_TAPER_NONE , LAL_SIM_INSPIRAL_TAPER_START , LAL_SIM_INSPIRAL_TAPER_END , LAL_SIM_INSPIRAL_TAPER_STARTEND ,   LAL_SIM_INSPIRAL_TAPER_NUM_OPTS }
	Enumeration to specify the tapering method to apply to the waveform. More...
enum	LALSimulationDomain { LAL_SIM_DOMAIN_TIME , LAL_SIM_DOMAIN_FREQUENCY }
	Enumeration to specify time or frequency domain. More...
enum	SpinSupport {   LAL_SIM_INSPIRAL_SPINLESS , LAL_SIM_INSPIRAL_SINGLESPIN , LAL_SIM_INSPIRAL_ALIGNEDSPIN , LAL_SIM_INSPIRAL_PRECESSINGSPIN ,   LAL_SIM_INSPIRAL_CASEBYCASE_SPINSUPPORT , LAL_SIM_INSPIRAL_NUMSPINSUPPORT }
enum	SpinFreq {   LAL_SIM_INSPIRAL_SPINS_F_REF , LAL_SIM_INSPIRAL_SPINS_FLOW , LAL_SIM_INSPIRAL_SPINS_NONPRECESSING , LAL_SIM_INSPIRAL_SPINS_CASEBYCASE ,   LAL_SIM_INSPIRAL_NUMSPINFREQ }
enum	AllowZeroMinFreq { LAL_SIM_INSPIRAL_ALLOW_ZERO_FMIN , LAL_SIM_INSPIRAL_DISALLOW_ZERO_FMIN , LAL_SIM_INSPIRAL_NUMZEROFMIN }
enum	TestGRaccept { LAL_SIM_INSPIRAL_NO_TESTGR_PARAMS , LAL_SIM_INSPIRAL_TESTGR_PARAMS , LAL_SIM_INSPIRAL_CASEBYCASE_TESTGR_PARAMS , LAL_SIM_INSPIRAL_NUM_TESTGR_ACCEPT }
enum	LALSimInspiralSpinOrder {   LAL_SIM_INSPIRAL_SPIN_ORDER_0PN = 0 , LAL_SIM_INSPIRAL_SPIN_ORDER_05PN = 1 , LAL_SIM_INSPIRAL_SPIN_ORDER_1PN = 2 , LAL_SIM_INSPIRAL_SPIN_ORDER_15PN = 3 ,   LAL_SIM_INSPIRAL_SPIN_ORDER_2PN = 4 , LAL_SIM_INSPIRAL_SPIN_ORDER_25PN = 5 , LAL_SIM_INSPIRAL_SPIN_ORDER_3PN = 6 , LAL_SIM_INSPIRAL_SPIN_ORDER_35PN = 7 ,   LAL_SIM_INSPIRAL_SPIN_ORDER_ALL = -1 }
	Enumeration of allowed PN orders of spin effects. More...
enum	LALSimInspiralTidalOrder {   LAL_SIM_INSPIRAL_TIDAL_ORDER_0PN = 0 , LAL_SIM_INSPIRAL_TIDAL_ORDER_5PN = 10 , LAL_SIM_INSPIRAL_TIDAL_ORDER_6PN = 12 , LAL_SIM_INSPIRAL_TIDAL_ORDER_65PN = 13 ,   LAL_SIM_INSPIRAL_TIDAL_ORDER_7PN = 14 , LAL_SIM_INSPIRAL_TIDAL_ORDER_75PN = 15 , LAL_SIM_INSPIRAL_TIDAL_ORDER_ALL = -1 }
	Enumeration of allowed PN orders of tidal effects. More...
enum	LALSimInspiralGETides {   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 }
enum	LALSimInspiralGMTides { LAL_SIM_INSPIRAL_GMTIDES_OFF , LAL_SIM_INSPIRAL_GMTIDES_PN , LAL_SIM_INSPIRAL_GMTIDES_GSF , LAL_SIM_INSPIRAL_GMTIDES_NOPT }
enum	LALSimInspiralFrameAxis { LAL_SIM_INSPIRAL_FRAME_AXIS_VIEW , LAL_SIM_INSPIRAL_FRAME_AXIS_TOTAL_J , LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L }
	Enumerator for choosing the reference frame associated with PSpinInspiralRD waveforms. More...
enum	LALSimInspiralModesChoice {   LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT = 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_3L = 1<<1 , LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3L = (1<<2) - 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_4L = 1<<2 ,   LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4L = (1<<3) - 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4L = (1<<3) - 1 - (1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4L = (1<<3) - (1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_5L = 1<<3 ,   LAL_SIM_INSPIRAL_MODES_CHOICE_2AND5L = (1<<3) + 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_3AND5L = (1<<3) + (1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_4AND5L = (1<<3) + (1<<2) , LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND5L = (1<<4) - 1 -(1<<2) ,   LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4AND5L = (1<<4) - 1 -(1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4AND5L = (1<<4) - (1<<1) , LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4AND5L = (1<<4) - 1 , LAL_SIM_INSPIRAL_MODES_CHOICE_ALL = - 1 }
	Enumerator for choosing which modes to include in IMR models. 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.

Enumeration Type Documentation

Approximant

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. Remarks Implemented in lalsimulation (time domain).
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. Remarks Implemented in lalsimulation (time domain).
TaylorT3	Time domain Taylor approximant in which phase is explicitly given as a function of time; outputs a time-domain wave. Remarks Implemented in lalsimulation (time domain).
TaylorF1	The stationary phase approximation that correctly represents, in the Fourier domain, the waveform given by TaylorT1 approximant (see [6] for details); Outputs a frequency-domain wave. Attention Not implemented in lalsimulation.
EccentricFD	Frequency domain waveform in the SPA to describe low eccentricity systems. Remarks Implemented in lalsimulation (frequency domain).
TaylorF2	The standard stationary phase approximation; Outputs a frequency-domain wave. Remarks Implemented in lalsimulation (frequency domain).
TaylorF2Ecc	The standard stationary phase approximation with eccentricity; Outputs a frequency-domain wave. Remarks Implemented in lalsimulation (frequency domain).
TaylorF2NLTides	The standard stationary phase approximation including a phenomenological model of nonlinear tidal effects; Outputs a frequency-domain wave. Remarks Implemented in lalsimulation (frequency domain).
TaylorR2F4	A frequency domain model closely related to TaylorT4. Attention Not implemented in lalsimulation.
TaylorF2RedSpin	TaylorF2 waveforms for non-precessing spins, defined in terms of a single (reduced-spin) parameter [Ajith_2011ec]. Remarks Implemented in lalsimulation (frequency domain).
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). Remarks Implemented in lalsimulation (frequency domain).
PadeT1	Time-domain P-approximant; Outputs a time-domain wave. Attention Not implemented in lalsimulation.
PadeF1	Frequency-domain P-approximant (not yet implemented). Attention Not implemented in lalsimulation.
EOB	Effective one-body waveform; Outputs a time-domain wave. Attention Not implemented in lalsimulation.
BCV	Detection template family of Buonanno, Chen and Vallisneri [3]; Outputs a frequency-domain wave. Attention Not implemented in lalsimulation.
BCVSpin	Detection template family of Buonanno, Chen and Vallisneri including spin effects [4]; Outputs a frequency-domain wave. Attention Not implemented in lalsimulation.
SpinTaylorT1	Spinning case T1 models. Remarks Implemented in lalsimulation (time domain).
SpinTaylorT2	Spinning case T2 models. Attention Not implemented in lalsimulation.
SpinTaylorT3	Spinning case T3 models. Attention Not implemented in lalsimulation.
SpinTaylorT4	Spinning case T4 models (lalsimulation's equivalent of SpinTaylorFrameless). Remarks Implemented in lalsimulation (time domain).
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. Remarks Implemented in lalsimulation (time domain).
SpinTaylorF2	Spinning case F2 models (single spin only). Remarks Implemented in lalsimulation (frequency domain).
SpinTaylorFrameless	Spinning case PN models (replace SpinTaylor by removing the coordinate singularity) Attention Not implemented in lalsimulation.
SpinTaylor	Spinning case PN models (should replace SpinTaylorT3 in the future) Attention Not implemented in lalsimulation.
PhenSpinTaylor	Inspiral part of the PhenSpinTaylorRD. Remarks Implemented in lalsimulation (time domain).
PhenSpinTaylorRD	Phenomenological waveforms, interpolating between a T4 spin-inspiral and the ringdown. Remarks Implemented in lalsimulation (time domain).
SpinQuadTaylor	Spinning case PN models with quadrupole-monopole and self-spin interaction. Attention Not implemented in lalsimulation.
FindChirpSP	The stationary phase templates implemented by FindChirpSPTemplate in the findchirp package (equivalent to TaylorF2 at twoPN order). Attention Not implemented in lalsimulation.
FindChirpPTF	UNDOCUMENTED. Attention Not implemented in lalsimulation.
GeneratePPN	The time domain templates generated by LALGeneratePPNInspiral() in the inject package (equivalent to TaylorT3 at twoPN order). Attention Not implemented in lalsimulation.
BCVC	UNDOCUMENTED. Attention Not implemented in lalsimulation.
FrameFile	The waveform contains arbitrary data read from a frame file. Attention Not implemented in lalsimulation.
AmpCorPPN	UNDOCUMENTED. Attention Not implemented in lalsimulation.
NumRel	UNDOCUMENTED. Attention Not implemented in lalsimulation.
NumRelNinja2	The waveform contains REAL8 data generated by lalapps_fr_ninja from a file in the format described in arXiv:0709.0093v3. Attention Not implemented in lalsimulation.
Eccentricity	UNDOCUMENTED. Attention Not implemented in lalsimulation.
EOBNR	UNDOCUMENTED. Attention Not implemented in lalsimulation.
EOBNRv2	UNDOCUMENTED. Remarks Implemented in lalsimulation (time domain).
EOBNRv2HM	UNDOCUMENTED. Remarks Implemented in lalsimulation (time domain).
EOBNRv2_ROM	Frequency domain reduced order model of model EOBNRv2HM, no spin neither higher modes. Attention Not implemented in lalsimulation.
EOBNRv2HM_ROM	Frequency domain reduced order model of model EOBNRv2HM, no spin but with higher modes. Attention Not implemented in lalsimulation.
TEOBResum_ROM	Time domain reduced order model of EOB with tidal effects. Remarks Implemented in lalsimulation (time domain).
SEOBNRv1	Spin-aligned EOBNR model. Remarks Implemented in lalsimulation (time domain).
SEOBNRv2	Spin-aligned EOBNR model v2. Remarks Implemented in lalsimulation (time domain).
SEOBNRv2_opt	Optimized Spin-aligned EOBNR model v2. Remarks Implemented in lalsimulation (time domain).
SEOBNRv3	Spin precessing EOBNR model v3. Todo: Fix implementation in lalsimulation (time domain).
SEOBNRv3_pert	Perturbed [m1 -> m1*(1+1e-15)] Spin precessing EOBNR model v3. Remarks Implemented in lalsimulation (time domain).
SEOBNRv3_opt	Optimized Spin precessing EOBNR model v3. Remarks Implemented in lalsimulation (time domain).
SEOBNRv3_opt_rk4	USE RK4 Optimized Spin precessing EOBNR model v3. Todo: Fix implementation in lalsimulation (time domain).
SEOBNRv4	Spin nonprecessing EOBNR model v4. Remarks Implemented in lalsimulation (time domain).
SEOBNRv4_opt	Optimized Spin-aligned EOBNR model v4. Remarks Implemented in lalsimulation (time domain).
SEOBNRv4P	Spin precessing EOBNR model based on SEOBNRv4. Remarks Implemented in lalsimulation (time domain).
SEOBNRv4PHM	Spin precessing EOBNR model based on SEOBNRv4HM. Remarks Implemented in lalsimulation (time domain).
SEOBNRv2T	Tidal EOB model. Remarks Implemented in lalsimulation (time domain). Parameter range: q=[1,3], Sz=[-0.5,0.5], Lambda2=[0,5000]. Initial conditions solver can fail when starting frequency is too low (rate of failure 0.3% at fmin=10Hz for M=3Msol).
SEOBNRv4T	Tidal EOB model. Remarks Implemented in lalsimulation (time domain). Parameter range: q=[1,3], Sz=[-0.5,0.5], Lambda2=[0,5000]. Initial conditions solver can fail when starting frequency is too low (rate of failure 0.3% at fmin=10Hz for M=3Msol).
SEOBNRv1_ROM_EffectiveSpin	Single-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv1 See [Purrer:2014fza]. Remarks Implemented in lalsimulation (frequency domain).
SEOBNRv1_ROM_DoubleSpin	Double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv1 See [Purrer:2014fza]. Remarks Implemented in lalsimulation (frequency domain).
SEOBNRv2_ROM_EffectiveSpin	Single-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv2. Remarks Implemented in lalsimulation (frequency domain).
SEOBNRv2_ROM_DoubleSpin	Double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv2. Remarks Implemented in lalsimulation (frequency domain).
SEOBNRv2_ROM_DoubleSpin_HI	High resolution low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv2. Remarks Implemented in lalsimulation (frequency domain).
Lackey_Tidal_2013_SEOBNRv2_ROM	Frequency domain tidal model based on reduced order model of SEOBNRv2. Remarks Implemented in lalsimulation (frequency domain).
SEOBNRv4_ROM	Low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv4. Remarks Implemented in lalsimulation (frequency domain).
SEOBNRv4HM_ROM	Low-mass double-spin frequency domain reduced order model of spin-aligned EOBNR model SEOBNRv4hm. Remarks Implemented in lalsimulation (frequency domain).
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. Remarks Implemented in lalsimulation (frequency domain).
SEOBNRv4_ROM_NRTidalv2	based on NRTidalv2; https://arxiv.org/abs/1905.06011. Remarks Implemented in lalsimulation (time domain and frequency domain).
SEOBNRv4_ROM_NRTidalv2_NSBH	NSBH model based on SEOBNRv4_ROM_NRTidalv2. Remarks Implemented in lalsimulation (frequency domain).
SEOBNRv4T_surrogate	Double-spin frequency domain surrogate model of spin-aligned tidal EOBNR model SEOBNRv4T. Remarks Implemented in lalsimulation (frequency domain).
HGimri	Time domain inspiral-merger-ringdown waveform for quasi-circular intermediate mass-ratio inspirals [Huerta & Gair arXiv:1009.1985]. Remarks Implemented in lalsimulation (time domain).
IMRPhenomA	Time domain (non-spinning) inspiral-merger-ringdown waveforms generated from the inverse FFT of IMRPhenomFA. Remarks Implemented in lalsimulation (time domain and frequency domain).
IMRPhenomB	Time domain (non-precessing spins) inspiral-merger-ringdown waveforms generated from the inverse FFT of IMRPhenomFB. Remarks Implemented in lalsimulation (time domain and frequency domain).
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]. Attention Not implemented in lalsimulation.
IMRPhenomFB	Frequency domain (non-precessing spins) inspiral-merger-ringdown templates of Ajith et al [Ajith_2009bn]. Attention Not implemented in lalsimulation.
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]. Remarks Implemented in lalsimulation (time domain and frequency domain).
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 ... Remarks Implemented in lalsimulation (frequency domain).
IMRPhenomD_NRTidal	Uses arxiv:1706.02969 to upgrad IMRPhenomD to a tidal approximant. Remarks Implemented in lalsimulation (frequency domain).
IMRPhenomD_NRTidalv2	NRTidalv2; https://arxiv.org/abs/1905.06011. Remarks Implemented in lalsimulation (time domain and frequency domain).
IMRPhenomNSBH	NSBH Tidal model. Remarks Implemented in lalsimulation (frequency domain).
IMRPhenomHM	Frequency domain with higher modes (non-precessing spins) inspiral-merger-ringdown templates, based on IMRPhenomD. Remarks Implemented in lalsimulation (frequency domain). Ref London et al, arXiv:1708.00404
IMRPhenomP	Frequency domain (generic spins) inspiral-merger-ringdown templates of Hannam et al., arXiv:1308.3271 [gr-qc]. Based on IMRPhenomC. Remarks Implemented in lalsimulation (frequency domain).
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. Remarks Implemented in lalsimulation (frequency domain).
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. Remarks Implemented in lalsimulation (time domain and frequency domain).
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]. Attention Not implemented in lalsimulation.
TaylorEt	UNDOCUMENTED. Remarks Implemented in lalsimulation (time domain).
TaylorT4	UNDOCUMENTED. Remarks Implemented in lalsimulation (time domain).
EccentricTD	Time domain Taylor T4 approximant including orbital eccentricity effects. Remarks Implemented in lalsimulation (time domain).
TaylorN	UNDOCUMENTED. Attention Not implemented in lalsimulation.
SpinTaylorT4Fourier	Frequency domain (generic spins) inspiral only waveforms based on TaylorT4, arXiv: 1408.5158. Remarks Implemented in lalsimulation (frequency domain).
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.) Remarks Implemented in lalsimulation (frequency domain).
SpinDominatedWf	Time domain, inspiral only, 1 spin, precessing waveform, Tapai et al, arXiv: 1209.1722. Remarks Implemented in lalsimulation (time domain).
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]. Remarks Implemented in lalsimulation (time domain).
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. Remarks Implemented in lalsimulation (frequency domain).
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. Remarks Implemented in lalsimulation (frequency domain).
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. Remarks Implemented in lalsimulation (time domain).
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 Remarks Implemented in lalsimulation (frequency domain).
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 Remarks Implemented in lalsimulation (frequency domain).
NumApproximants	Number of elements in enum, useful for checking bounds.

Definition at line 229 of file LALSimInspiral.h.

FrequencyFunction

enum FrequencyFunction

Enum of various frequency functions.

Enumerator
fSchwarzISCO	Schwarzschild ISCO.
fIMRPhenomAFinal	Final frequency of IMRPhenomA.
fIMRPhenomBFinal	Final of IMRPhenomB.
fIMRPhenomCFinal	Final of IMRPhenomC.
fIMRPhenomDPeak	Frequency of the peak amplitude in IMRPhenomD.
fEOBNRv2RD	Ringdown frequency of EOBNRv2.
fEOBNRv2HMRD	Ringdown frequency of highest harmonic in EOBNRv2HM.
fSEOBNRv1Peak	Frequency of the peak amplitude in SEOBNRv1.
fSEOBNRv1RD	Dominant ringdown frequency in SEOBNRv1.
fSEOBNRv2Peak	Frequency of the peak amplitude in SEOBNRv2.
fSEOBNRv2RD	Dominant ringdown frequency in SEOBNRv2.
fSEOBNRv4Peak	Frequency of the peak amplitude in SEOBNRv4.
fSEOBNRv4RD	Dominant ringdown frequency in SEOBNRv4.
fTEOBResumSFinal	Dominant ringdown frequency in TEOBResumS.
fSEOBNRv5Peak	Frequency of the peak amplitude in SEOBNRv5_ROM.
fSEOBNRv5RD	Dominant ringdown frequency in SEOBNRv5_ROM.
NumFreqFunctions	Number of elements in the enum.

Definition at line 454 of file LALSimInspiral.h.

LALPNOrder

enum LALPNOrder

Enum of possible values to use for post-Newtonian order.

Enumerator
LAL_PNORDER_NEWTONIAN	Newtonain (leading) order.
LAL_PNORDER_HALF	0.5PN <==> O(v)
LAL_PNORDER_ONE	1PN <==> O(v^2)
LAL_PNORDER_ONE_POINT_FIVE	1.5PN <==> O(v^3)
LAL_PNORDER_TWO	2PN <==> O(v^4)
LAL_PNORDER_TWO_POINT_FIVE	2.5PN <==> O(v^5)
LAL_PNORDER_THREE	3PN <==> O(v^6)
LAL_PNORDER_THREE_POINT_FIVE	3.5PN <==> O(v^7)
LAL_PNORDER_PSEUDO_FOUR	pseudo-4PN tuning coefficients included, true 4PN terms currently unknown
LAL_PNORDER_NUM_ORDER	Number of elements in enum, useful for checking bounds.

Definition at line 475 of file LALSimInspiral.h.

LALSimInspiralApplyTaper

enum LALSimInspiralApplyTaper

Enumeration to specify the tapering method to apply to the waveform.

Enumerator
LAL_SIM_INSPIRAL_TAPER_NONE	No tapering.
LAL_SIM_INSPIRAL_TAPER_START	Taper the start of the waveform.
LAL_SIM_INSPIRAL_TAPER_END	Taper the end of the waveform.
LAL_SIM_INSPIRAL_TAPER_STARTEND	Taper the start and the end of the waveform.
LAL_SIM_INSPIRAL_TAPER_NUM_OPTS	Number of elements in enum, useful for checking bounds.

Definition at line 489 of file LALSimInspiral.h.

LALSimulationDomain

enum LALSimulationDomain

Enumeration to specify time or frequency domain.

Enumerator
LAL_SIM_DOMAIN_TIME
LAL_SIM_DOMAIN_FREQUENCY

Definition at line 499 of file LALSimInspiral.h.

SpinSupport

enum SpinSupport

Enumerator
LAL_SIM_INSPIRAL_SPINLESS
LAL_SIM_INSPIRAL_SINGLESPIN	These approximants cannot include spin terms.
LAL_SIM_INSPIRAL_ALIGNEDSPIN	These approximants support a signle spin (by default that is the object 1)
LAL_SIM_INSPIRAL_PRECESSINGSPIN	These approximants can include spins aligned with L_N.
LAL_SIM_INSPIRAL_CASEBYCASE_SPINSUPPORT	These approximant support fully precessing spins.
LAL_SIM_INSPIRAL_NUMSPINSUPPORT	This approximant (ExternalPython) has spin support determined by the external python module on a case-by-case basis. Number of elements in enum, useful for checking bounds

Definition at line 504 of file LALSimInspiral.h.

SpinFreq

enum SpinFreq

Enumerator
LAL_SIM_INSPIRAL_SPINS_F_REF
LAL_SIM_INSPIRAL_SPINS_FLOW	These approximants are parameterized by the spins at f_ref.
LAL_SIM_INSPIRAL_SPINS_NONPRECESSING	These approximants are parameterized by the spins at flow.
LAL_SIM_INSPIRAL_SPINS_CASEBYCASE	These approximants have nonprecessing spins.
LAL_SIM_INSPIRAL_NUMSPINFREQ	These approximants (NR waveforms) have spins parameterized at different frequencies on a case-by-case basis. Number of elements in enum, useful for checking bounds

Definition at line 513 of file LALSimInspiral.h.

AllowZeroMinFreq

enum AllowZeroMinFreq

Enumerator
LAL_SIM_INSPIRAL_ALLOW_ZERO_FMIN
LAL_SIM_INSPIRAL_DISALLOW_ZERO_FMIN	These approximants allow f_min=0, which means the full length of the available waveform is returned.
LAL_SIM_INSPIRAL_NUMZEROFMIN	These approximants do not allow f_min=0. This is set as default. Number of elements in enum, useful for checking bounds

Definition at line 521 of file LALSimInspiral.h.

TestGRaccept

enum TestGRaccept

Enumerator
LAL_SIM_INSPIRAL_NO_TESTGR_PARAMS
LAL_SIM_INSPIRAL_TESTGR_PARAMS	These approximants cannot accept testGR params as input params.
LAL_SIM_INSPIRAL_CASEBYCASE_TESTGR_PARAMS	These approximants accept testGR params as input params.
LAL_SIM_INSPIRAL_NUM_TESTGR_ACCEPT	This approximant (ExternalPython) accept testGR parameters depending on the external python module loaded. Number of elements in enum, useful for checking bounds

Definition at line 527 of file LALSimInspiral.h.

LALSimInspiralSpinOrder

enum LALSimInspiralSpinOrder

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

Enumerator
LAL_SIM_INSPIRAL_SPIN_ORDER_0PN
LAL_SIM_INSPIRAL_SPIN_ORDER_05PN
LAL_SIM_INSPIRAL_SPIN_ORDER_1PN
LAL_SIM_INSPIRAL_SPIN_ORDER_15PN
LAL_SIM_INSPIRAL_SPIN_ORDER_2PN
LAL_SIM_INSPIRAL_SPIN_ORDER_25PN
LAL_SIM_INSPIRAL_SPIN_ORDER_3PN
LAL_SIM_INSPIRAL_SPIN_ORDER_35PN
LAL_SIM_INSPIRAL_SPIN_ORDER_ALL

Definition at line 58 of file LALSimInspiralWaveformFlags.h.

LALSimInspiralTidalOrder

enum LALSimInspiralTidalOrder

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).

Enumerator
LAL_SIM_INSPIRAL_TIDAL_ORDER_0PN
LAL_SIM_INSPIRAL_TIDAL_ORDER_5PN
LAL_SIM_INSPIRAL_TIDAL_ORDER_6PN
LAL_SIM_INSPIRAL_TIDAL_ORDER_65PN
LAL_SIM_INSPIRAL_TIDAL_ORDER_7PN
LAL_SIM_INSPIRAL_TIDAL_ORDER_75PN
LAL_SIM_INSPIRAL_TIDAL_ORDER_ALL

Definition at line 80 of file LALSimInspiralWaveformFlags.h.

LALSimInspiralGETides

enum LALSimInspiralGETides

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.

LALSimInspiralGMTides

enum LALSimInspiralGMTides

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.

LALSimInspiralFrameAxis

enum LALSimInspiralFrameAxis

Enumerator for choosing the reference frame associated with PSpinInspiralRD waveforms.

Enumerator
LAL_SIM_INSPIRAL_FRAME_AXIS_VIEW	Set z-axis along direction of GW propagation (line of sight)
LAL_SIM_INSPIRAL_FRAME_AXIS_TOTAL_J	Set z-axis along the initial total angular momentum.
LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L	Set z-axis along the initial orbital angular momentum.

Definition at line 110 of file LALSimInspiralWaveformFlags.h.

LALSimInspiralModesChoice

enum LALSimInspiralModesChoice

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.

Enumerator
LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT	Include only (2,2) or l=2 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_3L	Inlude only l=3 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3L	Inlude l=2,3 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_4L	Inlude only l=4 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4L	Include l=2,3,4 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4L	Include l=2,4 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4L	Include l=3,4 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_5L	Inlude only l=5 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND5L	Inlude l=2,5 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_3AND5L	Inlude l=3,5 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_4AND5L	Inlude l=4,5 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND5L	Inlude l=2,3,5 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4AND5L	Inlude l=2,4,5 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4AND5L	Inlude l=3,4,5 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4AND5L	Include l=2,3,4,5 modes.
LAL_SIM_INSPIRAL_MODES_CHOICE_ALL	Include all available modes.

Definition at line 124 of file LALSimInspiralWaveformFlags.h.

Macro Definition Documentation

LAL_PN_MODE_L_MAX

#define LAL_PN_MODE_L_MAX   3

Definition at line 218 of file LALSimInspiral.h.

LAL_MAX_PN_ORDER

#define LAL_MAX_PN_ORDER   8

Definition at line 220 of file LALSimInspiral.h.

LAL_MAX_ECC_PN_ORDER

#define LAL_MAX_ECC_PN_ORDER   6

Definition at line 221 of file LALSimInspiral.h.

LAL_DEFAULT_F_ECC

#define LAL_DEFAULT_F_ECC   -1.0

Definition at line 222 of file LALSimInspiral.h.

PN_PHASING_SERIES_MAX_ORDER

#define PN_PHASING_SERIES_MAX_ORDER   15

Structure for passing around PN phasing coefficients.

For use with the TaylorF2 waveform.

Definition at line 539 of file LALSimInspiral.h.

LAL_SIM_INSPIRAL_SPIN_ORDER_DEFAULT

#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.

LAL_SIM_INSPIRAL_TIDAL_ORDER_DEFAULT

#define LAL_SIM_INSPIRAL_TIDAL_ORDER_DEFAULT   LAL_SIM_INSPIRAL_TIDAL_ORDER_ALL

Definition at line 41 of file LALSimInspiralWaveformFlags.h.

LAL_SIM_INSPIRAL_GMTIDES_DEFAULT

#define LAL_SIM_INSPIRAL_GMTIDES_DEFAULT   LAL_SIM_INSPIRAL_GMTIDES_OFF

Definition at line 42 of file LALSimInspiralWaveformFlags.h.

LAL_SIM_INSPIRAL_FRAME_AXIS_DEFAULT

#define LAL_SIM_INSPIRAL_FRAME_AXIS_DEFAULT   LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L

Definition at line 43 of file LALSimInspiralWaveformFlags.h.

LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT

#define LAL_SIM_INSPIRAL_MODES_CHOICE_DEFAULT   LAL_SIM_INSPIRAL_MODES_CHOICE_RESTRICTED

Definition at line 44 of file LALSimInspiralWaveformFlags.h.

LAL_SIM_L_MAX_MODE_ARRAY

#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.