Detailed Description

Routines for saving previously-computed waveforms for reuse.

Prototypes
int	XLALSimInspiralChooseTDWaveformFromCache (REAL8TimeSeries hplus, REAL8TimeSeries hcross, 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 r, REAL8 i, LALDict LALpars, Approximant approximant, LALSimInspiralWaveformCache cache)
	Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the time domain. More...

int	XLALSimInspiralChooseFDWaveformFromCache (COMPLEX16FrequencySeries hptilde, COMPLEX16FrequencySeries hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 f_min, REAL8 f_max, REAL8 f_ref, REAL8 r, REAL8 i, LALDict LALpars, Approximant approximant, LALSimInspiralWaveformCache cache, REAL8Sequence *frequencies)
	Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the frequency domain. More...

LALSimInspiralWaveformCache *	XLALCreateSimInspiralWaveformCache (void)
	Construct and initialize a waveform cache. More...

void	XLALDestroySimInspiralWaveformCache (LALSimInspiralWaveformCache *cache)
	Destroy a waveform cache. More...

Data Structures
struct	LALSimInspiralWaveformCacheOld
	Stores previously-computed waveforms and parameters to take advantage of approximant- and parameter-specific opportunities for accelerating waveform computation. More...

struct	LALSimInspiralWaveformCache

Function Documentation

◆ XLALSimInspiralChooseTDWaveformFromCache()

int XLALSimInspiralChooseTDWaveformFromCache	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		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	r,
		REAL8	i,
		LALDict *	LALpars,
		Approximant	approximant,
		LALSimInspiralWaveformCache *	cache
	)

Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the time domain.

The parameters passed must be in SI units.

This version allows caching of waveforms. The most recently generated waveform and its parameters are stored. If the next call requests a waveform that can be obtained by a simple transformation, then it is done. This bypasses the waveform generation and speeds up the code.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaT	sampling interval (s)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
S1x	x-component of the dimensionless spin of object 1
S1y	y-component of the dimensionless spin of object 1
S1z	z-component of the dimensionless spin of object 1
S2x	x-component of the dimensionless spin of object 2
S2y	y-component of the dimensionless spin of object 2
S2z	z-component of the dimensionless spin of object 2
f_min	starting GW frequency (Hz)
f_ref	reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
LALpars	LALDictionary containing non-mandatory variables/flags
approximant	post-Newtonian approximant to use for waveform production
cache	waveform cache structure; use NULL for no caching

Definition at line 109 of file LALSimInspiralWaveformCache.c.

◆ XLALSimInspiralChooseFDWaveformFromCache()

int XLALSimInspiralChooseFDWaveformFromCache	(	COMPLEX16FrequencySeries **	hptilde,
		COMPLEX16FrequencySeries **	hctilde,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	m1,
		REAL8	m2,
		REAL8	S1x,
		REAL8	S1y,
		REAL8	S1z,
		REAL8	S2x,
		REAL8	S2y,
		REAL8	S2z,
		REAL8	f_min,
		REAL8	f_max,
		REAL8	f_ref,
		REAL8	r,
		REAL8	i,
		LALDict *	LALpars,
		Approximant	approximant,
		LALSimInspiralWaveformCache *	cache,
		REAL8Sequence *	frequencies
	)

Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the frequency domain.

The parameters passed must be in SI units.

This version allows caching of waveforms. The most recently generated waveform and its parameters are stored. If the next call requests a waveform that can be obtained by a simple transformation, then it is done. This bypasses the waveform generation and speeds up the code.

Parameters

hptilde	+-polarization waveform
hctilde	x-polarization waveform
phiRef	reference orbital phase (rad)
deltaF	sampling interval (Hz)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
S1x	x-component of the dimensionless spin of object 1
S1y	y-component of the dimensionless spin of object 1
S1z	z-component of the dimensionless spin of object 1
S2x	x-component of the dimensionless spin of object 2
S2y	y-component of the dimensionless spin of object 2
S2z	z-component of the dimensionless spin of object 2
f_min	starting GW frequency (Hz)
f_max	ending GW frequency (Hz)
f_ref	Reference GW frequency (Hz)
r	distance of source (m)
i	inclination of source (rad)
LALpars	LALDictionary containing non-mandatory variables/flags
approximant	post-Newtonian approximant to use for waveform production
cache	waveform cache structure
frequencies	sequence of frequencies for which the waveform will be computed. Pass in NULL (or None in python) for standard f_min to f_max sequence.

Definition at line 436 of file LALSimInspiralWaveformCache.c.

◆ XLALCreateSimInspiralWaveformCache()

LALSimInspiralWaveformCache * XLALCreateSimInspiralWaveformCache ( void )

Construct and initialize a waveform cache.

Caches are used to avoid re-computation of waveforms that differ only by simple scaling relations in extrinsic parameters.

Definition at line 631 of file LALSimInspiralWaveformCache.c.

◆ XLALDestroySimInspiralWaveformCache()

void XLALDestroySimInspiralWaveformCache ( LALSimInspiralWaveformCache * cache )

Destroy a waveform cache.

Definition at line 642 of file LALSimInspiralWaveformCache.c.