LALSimulation  5.4.0.1-fe68b98
LALSimInspiralGeneratorLegacy.c File Reference

Prototypes

static int XLALSimInspiralChooseTDWaveform_legacy (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 *params, Approximant approximant)
 Copy of the old code of XLALSimInspiralChooseTDWaveform(). More...
 
static int XLALSimInspiralChooseFDWaveform_legacy (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 *params, Approximant approximant)
 
static SphHarmTimeSeriesXLALSimInspiralChooseTDModes_legacy (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, LALDict *LALpars, int lmax, Approximant approximant)
 Copy of the old code of XLALSimInspiralChooseTDModes(). More...
 
static SphHarmFrequencySeriesXLALSimInspiralChooseFDModes_legacy (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)
 Copy of the old code of XLALSimInspiralChooseFDModes(). More...
 
static int initialize (LALSimInspiralGenerator *myself, LALDict *params)
 Method to initialize generator. More...
 
static int generate_fd_modes (SphHarmFrequencySeries **hlm, LALDict *params, LALSimInspiralGenerator *myself)
 Define waveform generator methods to generate polarizations or modes in time or Fourier domain for legacy approximants. More...
 
static int generate_fd_waveform (COMPLEX16FrequencySeries **hplus, COMPLEX16FrequencySeries **hcross, LALDict *params, LALSimInspiralGenerator *myself)
 Fourier domain polarizations. More...
 
static int generate_td_modes (SphHarmTimeSeries **hlm, LALDict *params, LALSimInspiralGenerator *myself)
 Time domain modes. More...
 
static int generate_td_waveform (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, LALDict *params, LALSimInspiralGenerator *myself)
 Time domain polarizations. More...
 
static int XLALSimInspiralChooseFDWaveform_legacy (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 UNUSED meanPerAno, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 f_ref, LALDict *params, Approximant approximant)
 Copy of the old code of XLALSimInspiralChooseFDWaveform(). More...
 

Go to the source code of this file.

Macros

#define DEFINE_GENERATOR_TEMPLATE(approx, fd_modes, fd_waveform, td_modes, td_waveform)
 Define which methods are supported by every legacy approximant. More...
 
#define DEBUG   0
 

Macro Definition Documentation

◆ DEFINE_GENERATOR_TEMPLATE

#define DEFINE_GENERATOR_TEMPLATE (   approx,
  fd_modes,
  fd_waveform,
  td_modes,
  td_waveform 
)
Value:
static Approximant _lal ## approx ## GeneratorInternalData = approx; \
const LALSimInspiralGenerator lal ## approx ## GeneratorTemplate = { \
.name = #approx, \
.initialize = initialize, \
.finalize = NULL, \
.generate_fd_modes = fd_modes, \
.generate_fd_waveform = fd_waveform, \
.generate_td_modes = td_modes, \
.generate_td_waveform = td_waveform, \
.internal_data = &_lal ## approx ## GeneratorInternalData \
};
static int initialize(LALSimInspiralGenerator *myself, LALDict *params)
Method to initialize generator.
Approximant
Enum that specifies the PN approximant to be used in computing the waveform.

Define which methods are supported by every legacy approximant.

Definition at line 218 of file LALSimInspiralGeneratorLegacy.c.

◆ DEBUG

#define DEBUG   0

Function Documentation

◆ XLALSimInspiralChooseTDWaveform_legacy()

static int XLALSimInspiralChooseTDWaveform_legacy ( 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 *  params,
Approximant  approximant 
)
static

Copy of the old code of XLALSimInspiralChooseTDWaveform().

The new version of XLALSimInspiralChooseTDWaveform() is just a wrapper over XLALSimInspiralGenerateTDWaveform(). XLALSimInspiralGenerateTDWaveform() internally calls this function for legacy approximants.

Definition at line 337 of file LALSimInspiralGeneratorLegacy.c.

◆ XLALSimInspiralChooseFDWaveform_legacy() [1/2]

static int XLALSimInspiralChooseFDWaveform_legacy ( 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 *  params,
Approximant  approximant 
)
static

◆ XLALSimInspiralChooseTDModes_legacy()

static SphHarmTimeSeries * XLALSimInspiralChooseTDModes_legacy ( 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,
LALDict *  LALpars,
int  lmax,
Approximant  approximant 
)
static

Copy of the old code of XLALSimInspiralChooseTDModes().

The new version of XLALSimInspiralChooseTDModes() is just a wrapper over XLALSimInspiralGenerateTDModes(). XLALSimInspiralGenerateTDModes() internally calls this function for legacy approximants.

Definition at line 2549 of file LALSimInspiralGeneratorLegacy.c.

◆ XLALSimInspiralChooseFDModes_legacy()

static SphHarmFrequencySeries * XLALSimInspiralChooseFDModes_legacy ( 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 
)
static

Copy of the old code of XLALSimInspiralChooseFDModes().

The new version of XLALSimInspiralChooseFDModes() is just a wrapper over XLALSimInspiralGenerateFDModes(). XLALSimInspiralGeenrateFDModes() internally calls this function for legacy approximants.

Definition at line 3025 of file LALSimInspiralGeneratorLegacy.c.

◆ initialize()

static int initialize ( LALSimInspiralGenerator *  myself,
LALDict *  params 
)
static

Method to initialize generator.

This activates the conditioning for proper Fourier transform in the option condition is on in the LALDict

Definition at line 114 of file LALSimInspiralGeneratorLegacy.c.

◆ generate_fd_modes()

static int generate_fd_modes ( SphHarmFrequencySeries **  hlm,
LALDict *  params,
LALSimInspiralGenerator *  myself 
)
static

Define waveform generator methods to generate polarizations or modes in time or Fourier domain for legacy approximants.

Fourier domain modes

Definition at line 135 of file LALSimInspiralGeneratorLegacy.c.

◆ generate_fd_waveform()

static int generate_fd_waveform ( COMPLEX16FrequencySeries **  hplus,
COMPLEX16FrequencySeries **  hcross,
LALDict *  params,
LALSimInspiralGenerator *  myself 
)
static

Fourier domain polarizations.

Definition at line 155 of file LALSimInspiralGeneratorLegacy.c.

◆ generate_td_modes()

static int generate_td_modes ( SphHarmTimeSeries **  hlm,
LALDict *  params,
LALSimInspiralGenerator *  myself 
)
static

Time domain modes.

Definition at line 174 of file LALSimInspiralGeneratorLegacy.c.

◆ generate_td_waveform()

static int generate_td_waveform ( REAL8TimeSeries **  hplus,
REAL8TimeSeries **  hcross,
LALDict *  params,
LALSimInspiralGenerator *  myself 
)
static

Time domain polarizations.

Definition at line 195 of file LALSimInspiralGeneratorLegacy.c.

◆ XLALSimInspiralChooseFDWaveform_legacy() [2/2]

static int XLALSimInspiralChooseFDWaveform_legacy ( 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 UNUSED  meanPerAno,
REAL8  deltaF,
REAL8  f_min,
REAL8  f_max,
REAL8  f_ref,
LALDict *  params,
Approximant  approximant 
)
static

Copy of the old code of XLALSimInspiralChooseFDWaveform().

The new version of XLALSimInspiralChooseFDWaveform() is just a wrapper over XLALSimInspiralGenerateFDWaveform. XLALSimInspiralGenerateFDWaveform() internally calls this function for legacy approximants.

get f_ecc

Definition at line 1254 of file LALSimInspiralGeneratorLegacy.c.