LALSimulation  5.4.0.1-08ee4f4
Prototypes | Macros | Variables
LALSimInspiral.c File Reference

Prototypes

static int delete_substring_in_list_from_string (char *string, const char *list[], size_t size)
 
int XLALSimInspiralPNPolarizationWaveformsFromModes (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8TimeSeries *v, REAL8TimeSeries *phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, REAL8 i, int O)
 Given time series for a binary's orbital dynamical variables, construct the waveform polarizations h+ and hx as a sum of -2 spin-weighted spherical harmonic modes, h_lm. More...
 
int XLALSimInspiralPolarizationsFromSphHarmTimeSeries (REAL8TimeSeries **hp, REAL8TimeSeries **hc, SphHarmTimeSeries *hlms, REAL8 iota, REAL8 phiRef)
 Compute the polarizations from all the -2 spin-weighted spherical harmonic modes stored in 'hlms'. More...
 
int XLALSimInspiralPolarizationsFromChooseFDModes (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8 m1, const REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 UNUSED longAscNodes, const REAL8 UNUSED eccentricity, const REAL8 UNUSED meanPerAno, const REAL8 deltaF, const REAL8 f_min, const REAL8 f_max, REAL8 f_ref, LALDict *LALparams, const Approximant approximant)
 Function returning the Fourier domain polarizations for positive frequencies built from the individual modes computed with ChooseFDModes. More...
 
int XLALSimInspiralPolarizationsFromSphHarmFrequencySeries (COMPLEX16FrequencySeries **hp, COMPLEX16FrequencySeries **hc, SphHarmFrequencySeries *hlms, REAL8 theta, REAL8 phi)
 Return polarizations for positive frequencies built by summing the individual modes present in the input array SphHarmFrequencySeries *hlms computed with ChooseFDModes. More...
 
int XLALSimInspiralPNPolarizationWaveformsEccentric (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8TimeSeries *V, REAL8TimeSeries *Ecc, REAL8TimeSeries *U, REAL8TimeSeries *Phi, REAL8 m1, REAL8 m2, REAL8 r, REAL8 i, int ampO, int ph_O)
 Given time series for a binary's orbital dynamical variables, computes the radial and angular orbital motion; then constructs the waveform polarizations h+ and hx in terms of the relative separation r, the true anomaly phi and their time derivatives. More...
 
int XLALSimInspiralPrecessingPolarizationWaveforms (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8TimeSeries *V, REAL8TimeSeries *Phi, REAL8TimeSeries *S1x, REAL8TimeSeries *S1y, REAL8TimeSeries *S1z, REAL8TimeSeries *S2x, REAL8TimeSeries *S2y, REAL8TimeSeries *S2z, REAL8TimeSeries *LNhatx, REAL8TimeSeries *LNhaty, REAL8TimeSeries *LNhatz, REAL8TimeSeries *E1x, REAL8TimeSeries *E1y, REAL8TimeSeries *E1z, REAL8 m1, REAL8 m2, REAL8 r, INT4 ampO)
 Computes polarizations h+ and hx for a spinning, precessing binary when provided time series of all the dynamical quantities. More...
 
int XLALSimInspiralPrecessingPolarizationWaveformHarmonic (COMPLEX16 *hplus, COMPLEX16 *hcross, REAL8 v, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 lnhx, REAL8 lnhy, REAL8 lnhz, REAL8 e1x, REAL8 e1y, REAL8 e1z, REAL8 dm, REAL8 eta, REAL8 v0, INT4 n, INT4 ampO)
 Computes polarizations h+ and hx for a spinning, precessing binary when provided a single value of all the dynamical quantities. More...
 
int XLALSimInspiralTransformPrecessingNewInitialConditions (REAL8 *incl, REAL8 *S1x, REAL8 *S1y, REAL8 *S1z, REAL8 *S2x, REAL8 *S2y, REAL8 *S2z, const REAL8 thetaJN, const REAL8 phiJL, const REAL8 theta1, const REAL8 theta2, const REAL8 phi12, const REAL8 chi1, const REAL8 chi2, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 fRef, const REAL8 phiRef)
 Transform Precessing Parameters. More...
 
New Interface Generator Routines
void XLALDestroySimInspiralGenerator (LALSimInspiralGenerator *generator)
 Destroy LALSimInspiralGenerator object. More...
 
LALSimInspiralGenerator * XLALCreateSimInspiralGenerator (const LALSimInspiralGenerator *generator, LALDict *params)
 Create LALSimInspiralGenerator object. More...
 
LALSimInspiralGenerator * XLALSimInspiralChooseGenerator (Approximant approx, LALDict *params)
 Returns LALSimInspiralGenerator object from approximant. More...
 
const char * XLALSimInspiralGeneratorName (LALSimInspiralGenerator *generator)
 Return approximant name from generator object. More...
 
New Interface Waveform Routines
int XLALSimInspiralGenerateTDWaveform (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, LALDict *params, LALSimInspiralGenerator *generator)
 Returns time-domain polarizations for a specific approximant. More...
 
int XLALSimInspiralGenerateTDModes (SphHarmTimeSeries **hlm, LALDict *params, LALSimInspiralGenerator *generator)
 Compute time-domain modes for a specific approximant. More...
 
int XLALSimInspiralGenerateFDWaveform (COMPLEX16FrequencySeries **hplus, COMPLEX16FrequencySeries **hcross, LALDict *params, LALSimInspiralGenerator *generator)
 Returns frequency-domain polarizations for a specific approximant. More...
 
int XLALSimInspiralGenerateFDModes (SphHarmFrequencySeries **hlm, LALDict *params, LALSimInspiralGenerator *generator)
 Compute frequency-domain modes for a specific approximant. More...
 
New Interface parse parameters Routines
void XLALSimInspiralParseDictionaryToChooseTDWaveform (REAL8 *m1, REAL8 *m2, REAL8 *S1x, REAL8 *S1y, REAL8 *S1z, REAL8 *S2x, REAL8 *S2y, REAL8 *S2z, REAL8 *distance, REAL8 *inclination, REAL8 *phiRef, REAL8 *longAscNodes, REAL8 *eccentricity, REAL8 *meanPerAno, REAL8 *deltaT, REAL8 *f_min, REAL8 *f_ref, LALDict *params)
 Insert all the input arguments needed by XALSimInspiralChooseTDWaveform() into a laldictionary. More...
 
void XLALSimInspiralParseDictionaryToChooseTDModes (REAL8 *phiRef, REAL8 *deltaT, REAL8 *m1, REAL8 *m2, REAL8 *S1x, REAL8 *S1y, REAL8 *S1z, REAL8 *S2x, REAL8 *S2y, REAL8 *S2z, REAL8 *f_min, REAL8 *f_ref, REAL8 *distance, INT4 *lmax, LALDict *params)
 Insert all the input arguments needed by XLALSimInspiralChooseTDModes() into a laldictionary. More...
 
void XLALSimInspiralParseDictionaryToChooseFDWaveform (REAL8 *m1, REAL8 *m2, REAL8 *S1x, REAL8 *S1y, REAL8 *S1z, REAL8 *S2x, REAL8 *S2y, REAL8 *S2z, REAL8 *distance, REAL8 *inclination, REAL8 *phiRef, REAL8 *longAscNodes, REAL8 *eccentricity, REAL8 *meanPerAno, REAL8 *deltaF, REAL8 *f_min, REAL8 *f_max, REAL8 *f_ref, LALDict *params)
 Insert all the input arguments needed by XLALSimInspiralChooseFDWaveform() into a laldictionary. More...
 
void XLALSimInspiralParseDictionaryToChooseFDModes (REAL8 *m1, REAL8 *m2, REAL8 *S1x, REAL8 *S1y, REAL8 *S1z, REAL8 *S2x, REAL8 *S2y, REAL8 *S2z, REAL8 *deltaF, REAL8 *f_min, REAL8 *f_max, REAL8 *f_ref, REAL8 *phiRef, REAL8 *distance, REAL8 *inclination, LALDict *params)
 Insert all the input arguments needed by XLALSimInspiralChooseFDModes() into a laldictionary. More...
 
General Waveform Switching Generation Routines
int XLALSimInspiralChooseTDWaveform (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 m1, const REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 longAscNodes, const REAL8 eccentricity, const REAL8 UNUSED meanPerAno, const REAL8 deltaT, const REAL8 f_min, REAL8 f_ref, LALDict *params, const Approximant approximant)
 Chooses between different approximants when requesting a waveform to be generated For spinning waveforms, all known spin effects up to given PN order are included Returns the waveform in the time domain. More...
 
int XLALSimInspiralChooseFDWaveform (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8 m1, const REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 longAscNodes, const REAL8 eccentricity, const REAL8 UNUSED meanPerAno, const REAL8 deltaF, const REAL8 f_min, const REAL8 f_max, REAL8 f_ref, LALDict *params, const Approximant approximant)
 Chooses between different approximants when requesting a waveform to be generated For spinning waveforms, all known spin effects up to given PN order are included Returns the waveform in the frequency domain. More...
 
SphHarmTimeSeries * XLALSimInspiralTDModesFromPolarizations (REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 phiRef, REAL8 longAscNodes, REAL8 eccentricity, REAL8 meanPerAno, REAL8 deltaT, REAL8 f_min, REAL8 f_ref, LALDict *LALparams, Approximant approximant)
 Generates an time domain inspiral waveform using the specified approximant; the resulting waveform is appropriately conditioned, suitable for injection into data, and decomposed into the (2, \(\pm\) 2), spin -2 weighted spherical harmonic modes. More...
 
int XLALSimInspiralTDFromTD (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 longAscNodes, REAL8 eccentricity, REAL8 meanPerAno, REAL8 deltaT, REAL8 f_min, REAL8 f_ref, LALDict *LALparams, Approximant approximant)
 Helper routines for XLALSimInspiralTD(): performs conditioning of a TD waveform. More...
 
int XLALSimInspiralTDFromFD (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 longAscNodes, REAL8 eccentricity, REAL8 meanPerAno, REAL8 deltaT, REAL8 f_min, REAL8 f_ref, LALDict *LALparams, Approximant approximant)
 Helper routines for XLALSimInspiralTD(): performs conditioning of a FD waveform and transforms it to TD. More...
 
int XLALSimInspiralTD (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 longAscNodes, REAL8 eccentricity, REAL8 meanPerAno, REAL8 deltaT, REAL8 f_min, REAL8 f_ref, LALDict *LALparams, Approximant approximant)
 Generates an time domain inspiral waveform using the specified approximant; the resulting waveform is appropriately conditioned and suitable for injection into data. More...
 
int XLALSimInspiralFD (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 longAscNodes, REAL8 eccentricity, REAL8 meanPerAno, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 f_ref, LALDict *LALparams, Approximant approximant)
 Generates a frequency domain inspiral waveform using the specified approximant; the resulting waveform is appropriately conditioned and suitable for injection into data. More...
 
int XLALSimInspiralChooseWaveform (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 m1, const REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 longAscNodes, const REAL8 eccentricity, const REAL8 meanPerAno, const REAL8 deltaT, const REAL8 f_min, const REAL8 f_ref, LALDict *LALpars, const Approximant approximant)
 
General Waveform Switching Mode Generation Routines
SphHarmTimeSeries * XLALSimInspiralChooseTDModes (UNUSED REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 f_min, REAL8 f_ref, REAL8 distance, LALDict *params, int lmax, Approximant approximant)
 Interface to compute a set of -2 spin-weighted spherical harmonic modes for a binary inspiral for a given waveform approximant. More...
 
SphHarmFrequencySeries * XLALSimInspiralChooseFDModes (REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 f_ref, REAL8 phiRef, REAL8 distance, REAL8 inclination, LALDict *params, Approximant approximant)
 Interface to compute a set of -2 spin-weighted spherical harmonic modes for a binary merger for a given waveform approximant in the Fourier domain. More...
 
SphHarmTimeSeries * XLALSimInspiralModesTD (REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 f_ref, REAL8 r, LALDict *LALpars, int lmax, Approximant approximant)
 Interface to compute a conditioned set of -2 spin-weighted spherical harmonic modes for a binary inspiral. More...
 
COMPLEX16TimeSeries * XLALSimInspiralChooseTDMode (REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 f_min, REAL8 f_ref, REAL8 r, REAL8 lambda1, REAL8 lambda2, LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralTestGRParam *nonGRparams, int amplitudeO, int phaseO, int l, int m, Approximant approximant)
 Interface to compute a single -2 spin-weighted spherical harmonic mode for a binary inspiral of any available amplitude and phase PN order. More...
 
Routines for Generating Inspiral Waveforms from Orbital Data
int XLALSimInspiralPNPolarizationWaveforms (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8TimeSeries *V, REAL8TimeSeries *Phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, REAL8 i, int ampO)
 Given time series for a binary's orbital dynamical variables, construct the waveform polarizations h+ and hx directly. More...
 
int XLALSimInspiralTransformPrecessingWvf2PE (REAL8 *thetaJN, REAL8 *phiJL, REAL8 *theta1, REAL8 *theta2, REAL8 *phi12, REAL8 *chi1, REAL8 *chi2, const REAL8 incl, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 m1, const REAL8 m2, const REAL8 fRef, const REAL8 phiRef)
 inverse to XLALSimInspiralTransformPrecessingNewInitialConditions() More...
 
Routines for Handling Approximants, Order, Axis, Mode Information
int XLALSimInspiralImplementedTDApproximants (Approximant approximant)
 Checks whether the given approximant is implemented in lalsimulation's XLALSimInspiralChooseTDWaveform(). More...
 
int XLALSimInspiralImplementedFDApproximants (Approximant approximant)
 Checks whether the given approximant is implemented in lalsimulation's XLALSimInspiralChooseFDWaveform(). More...
 
int XLALSimInspiralDecomposeWaveformString (int *approximant, int *order, int *axis, const char *waveform)
 Parses a waveform string to determine approximant, PN order, and axis choice. More...
 
int XLALSimInspiralGetApproximantFromString (const char *waveform)
 Parses a waveform string to determine approximant. More...
 
int XLALGetApproximantFromString (const char *waveform)
 
int XLALSimInspiralGetPNOrderFromString (const char *waveform)
 Parses a waveform string to determine PN order. More...
 
int XLALGetOrderFromString (const char *waveform)
 
int XLALSimInspiralGetFrameAxisFromString (const char *waveform)
 Parses a waveform string to determine frame axis. More...
 
int XLALGetFrameAxisFromString (const char *waveform)
 
int XLALSimInspiralGetTaperFromString (const char *string)
 Parses a string to determine the LALSimInspiralApplyTaper enum value. More...
 
int XLALGetTaperFromString (const char *string)
 
int XLALSimInspiralGetHigherModesFromString (const char *string)
 Parses a string to determine the LALSimInspiralModesChoice enum value. More...
 
int XLALGetHigherModesFromString (const char *string)
 
const char * XLALSimInspiralGetStringFromApproximant (Approximant approximant)
 Returns a string associated with an Approximant enum value. More...
 
const char * XLALGetStringFromApproximant (Approximant approximant)
 
const char * XLALSimInspiralGetStringFromPNOrder (LALPNOrder order)
 Returns a string associated with a LALPNOrder enum value. More...
 
const char * XLALSimInspiralGetStringFromTaper (LALSimInspiralApplyTaper taper)
 Returns a string associated with a LALSimInspiralApplyTaper enum value. More...
 
const char * XLALSimInspiralGetStringFromFrameAxis (LALSimInspiralFrameAxis axis)
 Returns a string associated with a LALSimInspiralFrameAxis enum value. More...
 
const char * XLALSimInspiralGetStringFromModesChoice (LALSimInspiralModesChoice modes)
 Returns a string associated with a LALSimInspiralModesChoice enum value. More...
 
int XLALSimInspiralGetSpinSupportFromApproximant (Approximant approx)
 
int XLALSimInspiralGetSpinFreqFromApproximant (Approximant approx)
 
int XLALSimInspiralGetAllowZeroMinFreqFromApproximant (Approximant approx)
 
int XLALSimInspiralApproximantAcceptTestGRParams (Approximant approx)
 
int XLALSimLorentzInvarianceViolationTerm (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1, REAL8 m2, REAL8 r, LALDict *LALparams)
 
Routines Determining Waveform Durations and Frequencies
REAL8 XLALSimInspiralChirpTimeBound (REAL8 fstart, REAL8 m1, REAL8 m2, REAL8 s1, REAL8 s2)
 Routine to compute an overestimate of the inspiral time from a given frequency. More...
 
REAL8 XLALSimInspiralMergeTimeBound (REAL8 m1, REAL8 m2)
 Routine to compute an overestimate of the merger time. More...
 
REAL8 XLALSimInspiralRingdownTimeBound (REAL8 M, REAL8 s)
 Routine to compute an overestimate of the ringdown time. More...
 
REAL8 XLALSimInspiralFinalBlackHoleSpinBound (REAL8 S1z, REAL8 S2z)
 Routine to compute an overestimate of a final black hole dimensionless spin. More...
 
REAL8 XLALSimInspiralChirpStartFrequencyBound (REAL8 tchirp, REAL8 m1, REAL8 m2)
 Routine to compute an underestimate of the starting frequency for a given chirp time. More...
 
double XLALSimInspiralGetFrequency (REAL8 m1, REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, FrequencyFunction freqFunc)
 Function that gives the value of the desired frequency given some physical parameters. More...
 
double XLALSimInspiralGetFinalFreq (REAL8 m1, REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, Approximant approximant)
 Function that gives the default ending frequencies of the given approximant. More...
 
Waveform Conditioning Helper Routines
int XLALSimInspiralTDConditionStage1 (REAL8TimeSeries *hplus, REAL8TimeSeries *hcross, REAL8 textra, REAL8 f_min)
 First stage of conditioning of time-domain waveforms. More...
 
int XLALSimInspiralTDConditionStage2 (REAL8TimeSeries *hplus, REAL8TimeSeries *hcross, REAL8 f_min, REAL8 f_max)
 Second stage of conditioning of time-domain waveforms. More...
 
REAL8 XLALSimInspiralfLow2fStart (REAL8 fLow, INT4 ampOrder, INT4 approximant)
 Function for determining the starting frequency of the (2,2) mode when the highest order contribution starts at fLow. More...
 
int XLALSimInspiralChooseTDWaveformOLD (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 m1, const REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 longAscNodes, const REAL8 eccentricity, const REAL8 UNUSED meanPerAno, const REAL8 deltaT, const REAL8 f_min, REAL8 f_ref, const REAL8 lambda1, const REAL8 lambda2, const REAL8 dQuadParam1, const REAL8 dQuadParam2, LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralTestGRParam *nonGRparams, int amplitudeO, const int phaseO, const Approximant approximant)
 
int XLALSimInspiralChooseFDWaveformOLD (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8 m1, const REAL8 m2, const REAL8 S1x, const REAL8 S1y, const REAL8 S1z, const REAL8 S2x, const REAL8 S2y, const REAL8 S2z, const REAL8 distance, const REAL8 inclination, const REAL8 phiRef, const REAL8 longAscNodes, const REAL8 eccentricity, const REAL8 UNUSED meanPerAno, const REAL8 deltaF, const REAL8 f_min, const REAL8 f_max, REAL8 f_ref, const REAL8 lambda1, const REAL8 lambda2, const REAL8 dQuadParam1, const REAL8 dQuadParam2, LALSimInspiralWaveformFlags *waveFlags, LALSimInspiralTestGRParam *nonGRparams, int amplitudeO, const int phaseO, const Approximant approximant)
 
int XLALSimInspiralSetQuadMonParamsFromLambdas (LALDict *LALparams)
 if you do NOT provide a quadparam[1,2] term and you DO provide lamdba[1,2] then we calculate quad-mono term using universal relations quadparam[1,2]_UR: Quadrupole-Monopole parameter computed using universal relations (UR) More...
 

Go to the source code of this file.

Macros

#define MAX_NONPRECESSING_AMP_PN_ORDER   6
 (Twice) the highest known PN order of amplitude correction for non-precessing binaries. More...
 
#define MAX_PRECESSING_AMP_PN_ORDER   3
 (Twice) the highest known PN order of amplitude correction for precessing binaries. More...
 
#define INITIALIZE_NAME(a)   [a] = #a
 
#define DELETE_SUBSTRING_IN_LIST_FROM_STRING(string, list)   delete_substring_in_list_from_string(string, list, sizeof(list)/sizeof(*list))
 

Variables

static const char * lalSimulationApproximantNames []
 
static const char * lalSimulationPNOrderNames []
 
static const char * lalSimulationTaperNames []
 
static const char * lalSimulationFrameAxisNames []
 
static const char * lalSimulationModesChoiceNames []
 
const LALSimInspiralGenerator * lalSimInspiralGeneratorTemplates [NumApproximants]
 

Macro Definition Documentation

◆ MAX_NONPRECESSING_AMP_PN_ORDER

#define MAX_NONPRECESSING_AMP_PN_ORDER   6

(Twice) the highest known PN order of amplitude correction for non-precessing binaries.

Definition at line 65 of file LALSimInspiral.c.

◆ MAX_PRECESSING_AMP_PN_ORDER

#define MAX_PRECESSING_AMP_PN_ORDER   3

(Twice) the highest known PN order of amplitude correction for precessing binaries.

Definition at line 71 of file LALSimInspiral.c.

◆ INITIALIZE_NAME

#define INITIALIZE_NAME (   a)    [a] = #a

Definition at line 76 of file LALSimInspiral.c.

◆ DELETE_SUBSTRING_IN_LIST_FROM_STRING

#define DELETE_SUBSTRING_IN_LIST_FROM_STRING (   string,
  list 
)    delete_substring_in_list_from_string(string, list, sizeof(list)/sizeof(*list))

Function Documentation

◆ delete_substring_in_list_from_string()

static int delete_substring_in_list_from_string ( char *  string,
const char *  list[],
size_t  size 
)
static

Definition at line 248 of file LALSimInspiral.c.

◆ XLALSimInspiralImplementedTDApproximants()

int XLALSimInspiralImplementedTDApproximants ( Approximant  approximant)

Checks whether the given approximant is implemented in lalsimulation's XLALSimInspiralChooseTDWaveform().

returns 1 if the approximant is implemented, 0 otherwise.

Parameters
approximantpost-Newtonian approximant for use in waveform production

Definition at line 3953 of file LALSimInspiral.c.

◆ XLALSimInspiralImplementedFDApproximants()

int XLALSimInspiralImplementedFDApproximants ( Approximant  approximant)

Checks whether the given approximant is implemented in lalsimulation's XLALSimInspiralChooseFDWaveform().

returns 1 if the approximant is implemented, 0 otherwise.

Parameters
approximantpost-Newtonian approximant for use in waveform production

Definition at line 4035 of file LALSimInspiral.c.

◆ XLALSimInspiralDecomposeWaveformString()

int XLALSimInspiralDecomposeWaveformString ( int *  approximant,
int *  order,
int *  axis,
const char *  waveform 
)

Parses a waveform string to determine approximant, PN order, and axis choice.

A waveform string can contain substrings specifying the approximant, the PN order, and the frame axis. This routine decomposes the waveform string to extract this information. Here we assume that there are no extraneous characters in the waveform string that do not encode this information. If extra characters are detected then this routine returns a failure code.

If one of the output parameters is set to NULL, this routine does not return the value for that parameter, and does not fail if that parameter cannot be determined from the waveform string; however, the full waveform string must be valid. If the axis parameter is not NULL but information about the frame axis is not found in the string then the default value axis is set to the default value LAL_SIM_INSPIRAL_FRAME_AXIS_VIEW. However, if the approximant or order parameters are not NULL and the approximant and order cannot be determined from the waveform string, then this routine produces an error.

Parsing is not case sensitive (using the "C" locale).

Parameters
[out]approximantThe approximate value from Approximate enum.
[out]orderThe PN order value from LALPNOrder enum.
[out]axisThe frame axis value from LALPNOrder enum.
[in]waveformThe waveform string.
Return values
0Success.
<0Failure.
Note
Users of the SWIG-Python interface probably want to use the routines XLALSimInspiralGetApproximantFromString(), XLALSimInspiralGetPNOrderFromString(), and XLALSimInspiralGetFrameAxisFromString() since there is no way to disable required matching of the PN order with the SWIG-wrapped version of this routine.

Definition at line 4134 of file LALSimInspiral.c.

◆ XLALSimInspiralGetApproximantFromString()

int XLALSimInspiralGetApproximantFromString ( const char *  waveform)

Parses a waveform string to determine approximant.

This routine uses XLALSimInspiralDecomposeWaveformString() to determine the approximant from the waveform string.

Parameters
[in]waveformThe waveform string.
Returns
The Approximant enum value, or -1 on error.

Definition at line 4190 of file LALSimInspiral.c.

◆ XLALGetApproximantFromString()

int XLALGetApproximantFromString ( const char *  waveform)
Deprecated:
Like XLALSimInspiralGetApproximantFromString() but doesn't demand that the remainder of the waveform string be valid.

Definition at line 4206 of file LALSimInspiral.c.

◆ XLALSimInspiralGetPNOrderFromString()

int XLALSimInspiralGetPNOrderFromString ( const char *  waveform)

Parses a waveform string to determine PN order.

This routine uses XLALSimInspiralDecomposeWaveformString() to determine the PN order from the waveform string.

Parameters
[in]waveformThe waveform string.
Returns
The LALPNOrder enum value, or -1 on error.

Definition at line 4228 of file LALSimInspiral.c.

◆ XLALGetOrderFromString()

int XLALGetOrderFromString ( const char *  waveform)
Deprecated:
Like XLALSimInspiralGetPNOrderFromString() but doesn't demand that the remainder of the waveform string be valid.

Definition at line 4241 of file LALSimInspiral.c.

◆ XLALSimInspiralGetFrameAxisFromString()

int XLALSimInspiralGetFrameAxisFromString ( const char *  waveform)

Parses a waveform string to determine frame axis.

This routine uses XLALSimInspiralDecomposeWaveformString() to determine the frame axis from the waveform string. If the frame axis cannot be determined, the value LAL_SIM_INSPIRAL_FRAME_AXIS_VIEW is returned.

Parameters
[in]waveformThe waveform string.
Returns
The LALPNOrder enum value, or -1 on error.

Definition at line 4265 of file LALSimInspiral.c.

◆ XLALGetFrameAxisFromString()

int XLALGetFrameAxisFromString ( const char *  waveform)
Deprecated:
Like XLALSimInspiralGetFrameAxisFromString() but doesn't demand that the remainder of the waveform string be valid.

Definition at line 4278 of file LALSimInspiral.c.

◆ XLALSimInspiralGetTaperFromString()

int XLALSimInspiralGetTaperFromString ( const char *  string)

Parses a string to determine the LALSimInspiralApplyTaper enum value.

Parses a string to determine the LALSimInspiralApplyTaper enum value. Parsing is not case sensitive (using the "C" locale).

Parameters
[in]stringThe string to be parsed.
Returns
The LALSimInspiralApplyTaper enum value, or -1 on error.

Definition at line 4300 of file LALSimInspiral.c.

◆ XLALGetTaperFromString()

int XLALGetTaperFromString ( const char *  string)
Deprecated:
Use XLALSimInspiralGetTaperFromString() instead.

Definition at line 4321 of file LALSimInspiral.c.

◆ XLALSimInspiralGetHigherModesFromString()

int XLALSimInspiralGetHigherModesFromString ( const char *  string)

Parses a string to determine the LALSimInspiralModesChoice enum value.

Parses a string to determine the LALSimInspiralModesChoice enum value. Parsing is not case sensitive (using the "C" locale).

Parameters
[in]stringThe string to be parsed.
Returns
The LALSimInspiralModesChoice enum value, or 0 on error.
Note
The normal error code -1 is actually a valid mode choice so this routine returns 0 (which is not a valid modes choice) on error rather than -1.

Definition at line 4338 of file LALSimInspiral.c.

◆ XLALGetHigherModesFromString()

int XLALGetHigherModesFromString ( const char *  string)
Deprecated:
Use XLALSimInspiralHigherModesFromString() instead.

Definition at line 4363 of file LALSimInspiral.c.

◆ XLALSimInspiralGetStringFromApproximant()

const char* XLALSimInspiralGetStringFromApproximant ( Approximant  approximant)

Returns a string associated with an Approximant enum value.

Parameters
[in]approximantThe Approximant enum value.
Returns
A constant string or NULL if there is an error.

Definition at line 4374 of file LALSimInspiral.c.

◆ XLALGetStringFromApproximant()

const char* XLALGetStringFromApproximant ( Approximant  approximant)
Deprecated:
Use XLALSimInspiralHigherModesFromString() instead.

Definition at line 4389 of file LALSimInspiral.c.

◆ XLALSimInspiralGetStringFromPNOrder()

const char* XLALSimInspiralGetStringFromPNOrder ( LALPNOrder  order)

Returns a string associated with a LALPNOrder enum value.

Parameters
[in]orderThe LALPNOrder enum value.
Returns
A constant string or NULL if there is an error.

Definition at line 4400 of file LALSimInspiral.c.

◆ XLALSimInspiralGetStringFromTaper()

const char* XLALSimInspiralGetStringFromTaper ( LALSimInspiralApplyTaper  taper)

Returns a string associated with a LALSimInspiralApplyTaper enum value.

Parameters
[in]taperThe LALSimInspiralApplyTaper enum value.
Returns
A constant string or NULL if there is an error.

Definition at line 4416 of file LALSimInspiral.c.

◆ XLALSimInspiralGetStringFromFrameAxis()

const char* XLALSimInspiralGetStringFromFrameAxis ( LALSimInspiralFrameAxis  axis)

Returns a string associated with a LALSimInspiralFrameAxis enum value.

Parameters
[in]axisThe LALSimInspiralFrameAxis enum value.
Returns
A constant string or NULL if there is an error.

Definition at line 4432 of file LALSimInspiral.c.

◆ XLALSimInspiralGetStringFromModesChoice()

const char* XLALSimInspiralGetStringFromModesChoice ( LALSimInspiralModesChoice  modes)

Returns a string associated with a LALSimInspiralModesChoice enum value.

Parameters
[in]modesThe LALSimInspiralModesChoice enum value.
Returns
A constant string or NULL if there is an error.

Definition at line 4448 of file LALSimInspiral.c.

◆ XLALSimInspiralGetSpinSupportFromApproximant()

int XLALSimInspiralGetSpinSupportFromApproximant ( Approximant  approx)

Definition at line 4461 of file LALSimInspiral.c.

◆ XLALSimInspiralGetSpinFreqFromApproximant()

int XLALSimInspiralGetSpinFreqFromApproximant ( Approximant  approx)

Definition at line 4585 of file LALSimInspiral.c.

◆ XLALSimInspiralGetAllowZeroMinFreqFromApproximant()

int XLALSimInspiralGetAllowZeroMinFreqFromApproximant ( Approximant  approx)

Definition at line 4707 of file LALSimInspiral.c.

◆ XLALSimInspiralApproximantAcceptTestGRParams()

int XLALSimInspiralApproximantAcceptTestGRParams ( Approximant  approx)

Definition at line 4731 of file LALSimInspiral.c.

◆ XLALSimLorentzInvarianceViolationTerm()

int XLALSimLorentzInvarianceViolationTerm ( COMPLEX16FrequencySeries **  hptilde,
COMPLEX16FrequencySeries **  hctilde,
REAL8  m1,
REAL8  m2,
REAL8  r,
LALDict *  LALparams 
)
Parameters
hptildeFrequency-domain waveform h+
hctildeFrequency-domain waveform hx
m1Mass 1 in solar masses
m2Mass 2 in solar masses
rdistance in metres
LALparamsLAL dictionary containing accessory parameters

Definition at line 4865 of file LALSimInspiral.c.

◆ XLALSimInspiralChirpTimeBound()

REAL8 XLALSimInspiralChirpTimeBound ( REAL8  fstart,
REAL8  m1,
REAL8  m2,
REAL8  s1,
REAL8  s2 
)

Routine to compute an overestimate of the inspiral time from a given frequency.

This routine estimates the time it will take for point-particle inspiral from a specified frequency to infinite frequency. The estimate is intended to be an over-estimate, so that the true inspiral time is always smaller than the time this routine returns. To obtain this estimate, the 2pN chirp time is used where all negative contributions are discarded.

Parameters
fstartThe starting frequency in Hz.
m1The mass of the first component in kg.
m2The mass of the second component in kg.
s1The dimensionless spin of the first component.
s2The dimensionless spin of the second component.
Returns
Upper bound on chirp time of post-Newtonian inspiral in seconds.

Definition at line 4959 of file LALSimInspiral.c.

◆ XLALSimInspiralMergeTimeBound()

REAL8 XLALSimInspiralMergeTimeBound ( REAL8  m1,
REAL8  m2 
)

Routine to compute an overestimate of the merger time.

This routine provides an upper bound on the time it will take for compact binaries to plunge and merge at the end of the quasi-stationary inspiral. This is quite vague since the notion of a innermost stable circular orbit is ill-defined except in a test mass limit. Nevertheless, this routine assumes (i) that the innermost stable circular orbit occurs at v = c / 3, or r = 9 G M / c^3 (in Boyer-Lindquist coordinates), which is roughly right for an extreme Kerr black hole counter-rotating with a test particle, and (ii) the plunge lasts for a shorter period than one cycle at this innermost stable circular orbit.

Parameters
m1The mass of the first component in kg.
m2The mass of the second component in kg.
Returns
Upper bound on the merger time in seconds.

Definition at line 4998 of file LALSimInspiral.c.

◆ XLALSimInspiralRingdownTimeBound()

REAL8 XLALSimInspiralRingdownTimeBound ( REAL8  M,
REAL8  s 
)

Routine to compute an overestimate of the ringdown time.

This routine provides an upper bound on the time it will take for a black hole produced by compact binary merger to ring down through quasinormal mode radiation. An approximate formula for the frequency and quality of the longest-lived fundamental (n=0) dominant (l=m=2) quasinormal mode * is given by Eqs. (E1) and (E2) along with Table VIII of Berti, Cardoso, and Will, Physical Review D (2006) 064030. Waveform generators produce 10 e-folds of ringdown radiation, so this routine goes up to 11 to provide an over-estimate of the ringdown time.

Parameters
MThe mass of the final black hole in kg.
sThe dimensionless spin of the final black hole.
Returns
Upper bound on the merger time in seconds.
See also
Emanuele Berti, Vitor Cardoso, and Clifford M. Will, Physical Review D 73, 064030 (2006) DOI: 10.1103/PhysRevD.73.064030

Definition at line 5023 of file LALSimInspiral.c.

◆ XLALSimInspiralFinalBlackHoleSpinBound()

REAL8 XLALSimInspiralFinalBlackHoleSpinBound ( REAL8  S1z,
REAL8  S2z 
)

Routine to compute an overestimate of a final black hole dimensionless spin.

This routine provides an upper bound on the dimensionless spin of a black hole produced in a compact binary merger. Uses the formula in Tichy and Marronetti, Physical Review D 78 081501 (2008), Eq. (1) and Table 1, for equal mass black holes, or the larger of the two spins (which covers the extreme mass case). If the result is larger than a maximum realistic black hole spin, truncate at this maximum value.

Parameters
S1zThe z-component of the dimensionless spin of body 1.
S2zThe z-component of the dimensionless spin of body 2.
Returns
Upper bound on final black hole dimensionless spin.
See also
Tichy and Marronetti, Physical Review D 78 081501 (2008).
Todo:
It has been suggested that Barausse, Rezzolla (arXiv: 0904.2577) is more accurate

Definition at line 5057 of file LALSimInspiral.c.

◆ XLALSimInspiralChirpStartFrequencyBound()

REAL8 XLALSimInspiralChirpStartFrequencyBound ( REAL8  tchirp,
REAL8  m1,
REAL8  m2 
)

Routine to compute an underestimate of the starting frequency for a given chirp time.

This routine estimates a start frequency for a binary inspiral from which the actual inspiral chirp time will be shorter than the specified chirp time. To obtain this estimate, only the leading order Newtonian coefficient is used. The frequency returned by this routine is guaranteed to be less than the frequency passed to XLALSimInspiralChirpTimeBound() if the returned value of that routine is passed to this routine as tchirp.

Parameters
tchirpThe chirp time of post-Newtonian inspiral s.
m1The mass of the first component in kg.
m2The mass of the second component in kg.
Returns
Lower bound on the starting frequency of a post-Newtonian inspiral in Hz.

Definition at line 5094 of file LALSimInspiral.c.

◆ XLALSimInspiralGetFrequency()

double XLALSimInspiralGetFrequency ( REAL8  m1,
REAL8  m2,
const REAL8  S1x,
const REAL8  S1y,
const REAL8  S1z,
const REAL8  S2x,
const REAL8  S2y,
const REAL8  S2z,
FrequencyFunction  freqFunc 
)

Function that gives the value of the desired frequency given some physical parameters.

Parameters
m1mass of companion 1 (kg)
m2mass of companion 2 (kg)
S1xx-component of the dimensionless spin of object 1
S1yy-component of the dimensionless spin of object 1
S1zz-component of the dimensionless spin of object 1
S2xx-component of the dimensionless spin of object 2
S2yy-component of the dimensionless spin of object 2
S2zz-component of the dimensionless spin of object 2
freqFuncname of the function to use

Definition at line 5107 of file LALSimInspiral.c.

◆ XLALSimInspiralGetFinalFreq()

double XLALSimInspiralGetFinalFreq ( REAL8  m1,
REAL8  m2,
const REAL8  S1x,
const REAL8  S1y,
const REAL8  S1z,
const REAL8  S2x,
const REAL8  S2y,
const REAL8  S2z,
Approximant  approximant 
)

Function that gives the default ending frequencies of the given approximant.

Parameters
m1mass of companion 1 (kg)
m2mass of companion 2 (kg)
S1xx-component of the dimensionless spin of object 1
S1yy-component of the dimensionless spin of object 1
S1zz-component of the dimensionless spin of object 1
S2xx-component of the dimensionless spin of object 2
S2yy-component of the dimensionless spin of object 2
S2zz-component of the dimensionless spin of object 2
approximantpost-Newtonian approximant to use for waveform production

Definition at line 5253 of file LALSimInspiral.c.

◆ XLALSimInspiralTDConditionStage1()

int XLALSimInspiralTDConditionStage1 ( REAL8TimeSeries *  hplus,
REAL8TimeSeries *  hcross,
REAL8  textra,
REAL8  f_min 
)

First stage of conditioning of time-domain waveforms.

The conditioning of time-domain waveforms is done in two stages:

  1. Take a waveform that is generated so that begins a time at least textra before it reaches f_min and apply a taper over this duration textra; follow this up by high-pass filtering the data at frequency f_min; finally, if the original waveform was zero-padded, strip off this padding.
  2. The high-pass filtered waveform might have transients remaining at the beginning and at the end; furthermore, the waveform might end at a non-zero value (especially for non-IMR waveforms). The second stage tapers one cycle at f_min from the beginning of the waveform and one cycle at f_max from the end of the waveform. There is a minimum number of samples that will be used in the tapering and if the waveform is shorter than twice this minimum number then no Stage 2 conditioning is done.

This routine performs Stage 1 conditioning. This stage is only performed for waveforms originally produced in the time domain. (Frequency domain waveforms that have been transformed into the time domain have a different Stage 1 conditioning.)

Parameters
hplusPointer to the plus-polarization timeseries.
hcrossPointer to the cross-polarization timeseries.
textraExtra time at beginning of waveform to taper (s).
f_minMinimum frequency for high-pass filtering (Hz).
Return values
0Success.
<0Failure.

Definition at line 5430 of file LALSimInspiral.c.

◆ XLALSimInspiralTDConditionStage2()

int XLALSimInspiralTDConditionStage2 ( REAL8TimeSeries *  hplus,
REAL8TimeSeries *  hcross,
REAL8  f_min,
REAL8  f_max 
)

Second stage of conditioning of time-domain waveforms.

The conditioning of time-domain waveforms is done in two stages:

  1. Take a waveform that is generated so that begins a time at least textra before it reaches f_min and apply a taper over this duration textra; follow this up by high-pass filtering the data at frequency f_min; finally, if the original waveform was zero-padded, strip off this padding.
  2. The high-pass filtered waveform might have transients remaining at the beginning and at the end; furthermore, the waveform might end at a non-zero value (especially for non-IMR waveforms). The second stage tapers one cycle at f_min from the beginning of the waveform and one cycle at f_max from the end of the waveform. There is a minimum number of samples that will be used in the tapering and if the waveform is shorter than twice this minimum number then no Stage 2 conditioning is done.

This routine performs Stage 2 conditioning. This stage is performed both for waveforms originally produced in the time domain, and for waveforms that were originally produced in the frequency domain and then transformed to the time domain. This stage follows some form of Stage 1 conditioning, which is different depending on whether the original waveform was generated in the time domain or in the frequency domain.

Parameters
hplusPointer to the plus-polarization timeseries.
hcrossPointer to the cross-polarization timeseries.
f_minMinimum frequency for tapering at the start (Hz).
f_maxMinimum frequency for tapering at the end (Hz).
Return values
0Success.
<0Failure.

Definition at line 5494 of file LALSimInspiral.c.

◆ XLALSimInspiralfLow2fStart()

REAL8 XLALSimInspiralfLow2fStart ( REAL8  fLow,
INT4  ampOrder,
INT4  approximant 
)

Function for determining the starting frequency of the (2,2) mode when the highest order contribution starts at fLow.

Compute the minimum frequency for waveform generation using amplitude orders above Newtonian. The waveform generator turns on all orders at the orbital associated with fMin, so information from higher orders is not included at fLow unless fMin is sufficiently low.

Parameters
fLowRequested lower frequency.
ampOrderRequested amplitude order.
approximantLALApproximant
Return values
fStartThe lower frequency to use to include corrections.

Definition at line 5551 of file LALSimInspiral.c.

◆ XLALSimInspiralChooseTDWaveformOLD()

int XLALSimInspiralChooseTDWaveformOLD ( REAL8TimeSeries **  hplus,
REAL8TimeSeries **  hcross,
const REAL8  m1,
const REAL8  m2,
const REAL8  S1x,
const REAL8  S1y,
const REAL8  S1z,
const REAL8  S2x,
const REAL8  S2y,
const REAL8  S2z,
const REAL8  distance,
const REAL8  inclination,
const REAL8  phiRef,
const REAL8  longAscNodes,
const REAL8  eccentricity,
const REAL8 UNUSED  meanPerAno,
const REAL8  deltaT,
const REAL8  f_min,
REAL8  f_ref,
const REAL8  lambda1,
const REAL8  lambda2,
const REAL8  dQuadParam1,
const REAL8  dQuadParam2,
LALSimInspiralWaveformFlags *  waveFlags,
LALSimInspiralTestGRParam *  nonGRparams,
int  amplitudeO,
const int  phaseO,
const Approximant  approximant 
)
Deprecated:
Use XLALSimInspiralChooseTDWaveform() instead Chooses between different approximants when requesting a waveform to be generated For spinning waveforms, all known spin effects up to given PN order are included Returns the waveform in the time domain.

The parameters passed must be in SI units.

Parameters
hplus+-polarization waveform
hcrossx-polarization waveform
m1mass of companion 1 (kg)
m2mass of companion 2 (kg)
S1xx-component of the dimensionless spin of object 1
S1yy-component of the dimensionless spin of object 1
S1zz-component of the dimensionless spin of object 1
S2xx-component of the dimensionless spin of object 2
S2yy-component of the dimensionless spin of object 2
S2zz-component of the dimensionless spin of object 2
distancedistance of source (m)
inclinationinclination of source (rad)
phiRefreference orbital phase (rad)
longAscNodeslongitude of ascending nodes, degenerate with the polarization angle, Omega in documentation
eccentricityeccentrocity at reference epoch
meanPerAnomean anomaly of periastron
deltaTsampling interval (s)
f_minstarting GW frequency (Hz)
f_refreference GW frequency (Hz)
lambda1(tidal deformability of mass 1) / m1^5 (dimensionless)
lambda2(tidal deformability of mass 2) / m2^5 (dimensionless)
dQuadParam1(quad-monop parameter of mass 1) / m1^5 -1 (dimensionless), give 0 for BHs
dQuadParam2(quad-monop parameter of mass 2) / m2^5 -1 (dimensionless), give 0 for BHs
waveFlagsSet of flags to control special behavior of some waveform families. Pass in NULL (or None in python) for default flags
nonGRparamsLinked list of non-GR parameters. Pass in NULL (or None in python) for standard GR waveforms
amplitudeOtwice post-Newtonian amplitude order
phaseOtwice post-Newtonian order
approximantpost-Newtonian approximant to use for waveform production

Definition at line 5573 of file LALSimInspiral.c.

◆ XLALSimInspiralChooseFDWaveformOLD()

int XLALSimInspiralChooseFDWaveformOLD ( COMPLEX16FrequencySeries **  hptilde,
COMPLEX16FrequencySeries **  hctilde,
const REAL8  m1,
const REAL8  m2,
const REAL8  S1x,
const REAL8  S1y,
const REAL8  S1z,
const REAL8  S2x,
const REAL8  S2y,
const REAL8  S2z,
const REAL8  distance,
const REAL8  inclination,
const REAL8  phiRef,
const REAL8  longAscNodes,
const REAL8  eccentricity,
const REAL8 UNUSED  meanPerAno,
const REAL8  deltaF,
const REAL8  f_min,
const REAL8  f_max,
REAL8  f_ref,
const REAL8  lambda1,
const REAL8  lambda2,
const REAL8  dQuadParam1,
const REAL8  dQuadParam2,
LALSimInspiralWaveformFlags *  waveFlags,
LALSimInspiralTestGRParam *  nonGRparams,
int  amplitudeO,
const int  phaseO,
const Approximant  approximant 
)
Deprecated:
Use XLALSimInspiralChooseFDWaveform() instead Chooses between different approximants when requesting a waveform to be generated For spinning waveforms, all known spin effects up to given PN order are included Returns the waveform in the frequency domain.
Parameters
hptildeFD plus polarization
hctildeFD cross polarization
m1mass of companion 1 (kg)
m2mass of companion 2 (kg)
S1xx-component of the dimensionless spin of object 1
S1yy-component of the dimensionless spin of object 1
S1zz-component of the dimensionless spin of object 1
S2xx-component of the dimensionless spin of object 2
S2yy-component of the dimensionless spin of object 2
S2zz-component of the dimensionless spin of object 2
distancedistance of source (m)
inclinationinclination of source (rad)
phiRefreference orbital phase (rad)
longAscNodeslongitude of ascending nodes, degenerate with the polarization angle, Omega in documentation
eccentricityeccentricity at reference epoch
meanPerAnomean anomaly of periastron
deltaFsampling interval (Hz)
f_minstarting GW frequency (Hz)
f_maxending GW frequency (Hz)
f_refReference frequency (Hz)
lambda1(tidal deformability of mass 1) / m1^5 (dimensionless)
lambda2(tidal deformability of mass 2) / m2^5 (dimensionless)
dQuadParam1(quad-monop parameter of mass 1) / m1^5 -1 (dimensionless), give 0 for BHs
dQuadParam2(quad-monop parameter of mass 2) / m2^5 -1 (dimensionless), give 0 for BHs
waveFlagsSet of flags to control special behavior of some waveform families. Pass in NULL (or None in python) for default flags
nonGRparamsLinked list of non-GR parameters. Pass in NULL (or None in python) for standard GR waveforms
amplitudeOtwice post-Newtonian amplitude order
phaseOtwice post-Newtonian order
approximantpost-Newtonian approximant to use for waveform production

Definition at line 6158 of file LALSimInspiral.c.

◆ XLALSimInspiralSetQuadMonParamsFromLambdas()

int XLALSimInspiralSetQuadMonParamsFromLambdas ( LALDict *  LALparams)

if you do NOT provide a quadparam[1,2] term and you DO provide lamdba[1,2] then we calculate quad-mono term using universal relations quadparam[1,2]_UR: Quadrupole-Monopole parameter computed using universal relations (UR)

Parameters
LALparamsLAL dictionary containing accessory parameters

Definition at line 6782 of file LALSimInspiral.c.

Variable Documentation

◆ lalSimulationApproximantNames

const char* lalSimulationApproximantNames[]
static

Definition at line 78 of file LALSimInspiral.c.

◆ lalSimulationPNOrderNames

const char* lalSimulationPNOrderNames[]
static
Initial value:
= {
[LAL_PNORDER_NEWTONIAN] = "newtonian",
[LAL_PNORDER_HALF] = "oneHalfPN",
[LAL_PNORDER_ONE] = "onePN",
[LAL_PNORDER_ONE_POINT_FIVE] = "onePointFivePN",
[LAL_PNORDER_TWO] = "twoPN",
[LAL_PNORDER_TWO_POINT_FIVE] = "twoPointFivePN",
[LAL_PNORDER_THREE] = "threePN",
[LAL_PNORDER_THREE_POINT_FIVE] = "threePointFivePN",
[LAL_PNORDER_PSEUDO_FOUR] = "pseudoFourPN",
}
LAL_PNORDER_TWO_POINT_FIVE
@ LAL_PNORDER_TWO_POINT_FIVE
2.5PN <==> O(v^5)
Definition: LALSimInspiral.h:481
LAL_PNORDER_THREE
@ LAL_PNORDER_THREE
3PN <==> O(v^6)
Definition: LALSimInspiral.h:482
LAL_PNORDER_TWO
@ LAL_PNORDER_TWO
2PN <==> O(v^4)
Definition: LALSimInspiral.h:480
LAL_PNORDER_ONE
@ LAL_PNORDER_ONE
1PN <==> O(v^2)
Definition: LALSimInspiral.h:478
LAL_PNORDER_PSEUDO_FOUR
@ LAL_PNORDER_PSEUDO_FOUR
pseudo-4PN tuning coefficients included, true 4PN terms currently unknown
Definition: LALSimInspiral.h:484
LAL_PNORDER_THREE_POINT_FIVE
@ LAL_PNORDER_THREE_POINT_FIVE
3.5PN <==> O(v^7)
Definition: LALSimInspiral.h:483
LAL_PNORDER_HALF
@ LAL_PNORDER_HALF
0.5PN <==> O(v)
Definition: LALSimInspiral.h:477
LAL_PNORDER_ONE_POINT_FIVE
@ LAL_PNORDER_ONE_POINT_FIVE
1.5PN <==> O(v^3)
Definition: LALSimInspiral.h:479
LAL_PNORDER_NEWTONIAN
@ LAL_PNORDER_NEWTONIAN
Newtonain (leading) order.
Definition: LALSimInspiral.h:476

Definition at line 197 of file LALSimInspiral.c.

◆ lalSimulationTaperNames

const char* lalSimulationTaperNames[]
static
Initial value:
= {
[LAL_SIM_INSPIRAL_TAPER_NONE] = "TAPER_NONE",
[LAL_SIM_INSPIRAL_TAPER_START] = "TAPER_START",
[LAL_SIM_INSPIRAL_TAPER_END] = "TAPER_END",
[LAL_SIM_INSPIRAL_TAPER_STARTEND] = "TAPER_STARTEND",
}
LAL_SIM_INSPIRAL_TAPER_START
@ LAL_SIM_INSPIRAL_TAPER_START
Taper the start of the waveform.
Definition: LALSimInspiral.h:492
LAL_SIM_INSPIRAL_TAPER_STARTEND
@ LAL_SIM_INSPIRAL_TAPER_STARTEND
Taper the start and the end of the waveform.
Definition: LALSimInspiral.h:494
LAL_SIM_INSPIRAL_TAPER_END
@ LAL_SIM_INSPIRAL_TAPER_END
Taper the end of the waveform.
Definition: LALSimInspiral.h:493
LAL_SIM_INSPIRAL_TAPER_NONE
@ LAL_SIM_INSPIRAL_TAPER_NONE
No tapering.
Definition: LALSimInspiral.h:491

Definition at line 210 of file LALSimInspiral.c.

◆ lalSimulationFrameAxisNames

const char* lalSimulationFrameAxisNames[]
static
Initial value:
= {
[LAL_SIM_INSPIRAL_FRAME_AXIS_TOTAL_J] = "TotalJ",
[LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L] = "OrbitalL",
[LAL_SIM_INSPIRAL_FRAME_AXIS_VIEW] = "View",
}
LAL_SIM_INSPIRAL_FRAME_AXIS_VIEW
@ LAL_SIM_INSPIRAL_FRAME_AXIS_VIEW
Set z-axis along direction of GW propagation (line of sight)
Definition: LALSimInspiralWaveformFlags.h:111
LAL_SIM_INSPIRAL_FRAME_AXIS_TOTAL_J
@ LAL_SIM_INSPIRAL_FRAME_AXIS_TOTAL_J
Set z-axis along the initial total angular momentum.
Definition: LALSimInspiralWaveformFlags.h:112
LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L
@ LAL_SIM_INSPIRAL_FRAME_AXIS_ORBITAL_L
Set z-axis along the initial orbital angular momentum.
Definition: LALSimInspiralWaveformFlags.h:113

Definition at line 218 of file LALSimInspiral.c.

◆ lalSimulationModesChoiceNames

const char* lalSimulationModesChoiceNames[]
static
Initial value:
= {
[LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4AND5L] = "L2345",
[LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4L] = "L234",
[LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND5L] = "L235",
[LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4AND5L] = "L245",
[LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4AND5L] = "L345",
[LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3L] = "L23",
[LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4L] = "L24",
[LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4L] = "L34",
[LAL_SIM_INSPIRAL_MODES_CHOICE_2AND5L] = "L25",
[LAL_SIM_INSPIRAL_MODES_CHOICE_3AND5L] = "L35",
[LAL_SIM_INSPIRAL_MODES_CHOICE_4AND5L] = "L45",
[LAL_SIM_INSPIRAL_MODES_CHOICE_RESTRICTED] = "L2",
[LAL_SIM_INSPIRAL_MODES_CHOICE_3L] = "L3",
[LAL_SIM_INSPIRAL_MODES_CHOICE_4L] = "L4",
[LAL_SIM_INSPIRAL_MODES_CHOICE_5L] = "L5",
}
LAL_SIM_INSPIRAL_MODES_CHOICE_3L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_3L
Inlude only l=3 modes.
Definition: LALSimInspiralWaveformFlags.h:126
LAL_SIM_INSPIRAL_MODES_CHOICE_4AND5L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_4AND5L
Inlude l=4,5 modes.
Definition: LALSimInspiralWaveformFlags.h:135
LAL_SIM_INSPIRAL_MODES_CHOICE_4L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_4L
Inlude only l=4 modes.
Definition: LALSimInspiralWaveformFlags.h:128
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3L
Inlude l=2,3 modes.
Definition: LALSimInspiralWaveformFlags.h:127
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND5L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND5L
Inlude l=2,3,5 modes.
Definition: LALSimInspiralWaveformFlags.h:136
LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4L
Include l=3,4 modes.
Definition: LALSimInspiralWaveformFlags.h:131
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND5L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_2AND5L
Inlude l=2,5 modes.
Definition: LALSimInspiralWaveformFlags.h:133
LAL_SIM_INSPIRAL_MODES_CHOICE_3AND5L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_3AND5L
Inlude l=3,5 modes.
Definition: LALSimInspiralWaveformFlags.h:134
LAL_SIM_INSPIRAL_MODES_CHOICE_5L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_5L
Inlude only l=5 modes.
Definition: LALSimInspiralWaveformFlags.h:132
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4AND5L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4AND5L
Inlude l=2,4,5 modes.
Definition: LALSimInspiralWaveformFlags.h:137
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4L
Include l=2,3,4 modes.
Definition: LALSimInspiralWaveformFlags.h:129
LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4AND5L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_3AND4AND5L
Inlude l=3,4,5 modes.
Definition: LALSimInspiralWaveformFlags.h:138
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4AND5L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_2AND3AND4AND5L
Include l=2,3,4,5 modes.
Definition: LALSimInspiralWaveformFlags.h:139
LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4L
@ LAL_SIM_INSPIRAL_MODES_CHOICE_2AND4L
Include l=2,4 modes.
Definition: LALSimInspiralWaveformFlags.h:130

Definition at line 225 of file LALSimInspiral.c.

◆ lalSimInspiralGeneratorTemplates

const LALSimInspiralGenerator* lalSimInspiralGeneratorTemplates[NumApproximants]

Definition at line 282 of file LALSimInspiral.c.