LALInspiral 5.0.3.1-eeff03c
LALEOBPPWaveform.c File Reference

Functions to generate the EOBNRv2 waveforms, as defined in Pan et al, arXiv:1106.1021v1 [gr-qc]. More...

Prototypes

static REAL8 XLALCalculateA5 (REAL8 eta)
 
static REAL8 XLALCalculateA6 (REAL8 eta)
 
static REAL8 omegaofrP4PN (const REAL8 r, const REAL8 eta, void *params)
 
static REAL8 nonKeplerianCoefficient (REAL8Vector *restrict values, const REAL8 eta, EOBACoefficients *coeffs)
 
static int LALHCapDerivativesP4PN (double t, const double values[], double dvalues[], void *funcParams)
 
static REAL8 XLALCalculateOmega (REAL8 eta, REAL8 r, REAL8 pr, REAL8 pPhi, EOBACoefficients *aCoeffs)
 
static int XLALFirstStoppingCondition (double t, const double values[], double dvalues[], void *funcParams)
 
static int XLALHighSRStoppingCondition (double t, const double values[], double dvalues[], void *funcParams)
 
static REAL8 XLALCalculateEOBA (const REAL8 r, EOBACoefficients *restrict coeffs)
 
static REAL8 XLALCalculateEOBD (REAL8 r, REAL8 eta)
 
static REAL8 XLALCalculateEOBdAdr (const REAL8 r, EOBACoefficients *restrict coeffs)
 
static REAL8 XLALEffectiveHamiltonian (const REAL8 eta, const REAL8 r, const REAL8 pr, const REAL8 pp, EOBACoefficients *aCoeffs)
 Function to calculate the EOB effective Hamiltonian for the given values of the dynamical variables. More...
 
static REAL8 XLALprInitP4PN (REAL8 p, void *params)
 
static REAL8 XLALpphiInitP4PN (const REAL8 r, EOBACoefficients *restrict coeffs)
 
static REAL8 XLALrOfOmegaP4PN (REAL8 r, void *params)
 
static REAL8 XLALvrP4PN (const REAL8 r, const REAL8 omega, pr3In *params)
 
static int XLALEOBPPWaveformEngine (REAL4Vector *signalvec1, REAL4Vector *signalvec2, REAL4Vector *h, const REAL8 *phiC, UINT4 *countback, InspiralTemplate *params, InspiralInit *paramsInit)
 
INT4 XLALGetFactorizedWaveform (COMPLEX16 *restrict hlm, REAL8Vector *restrict values, const REAL8 v, const INT4 l, const INT4 m, EOBParams *restrict params)
 
static REAL8 XLALCalculateA6 (const REAL8 UNUSED eta)
 
static int XLALCalculateEOBACoefficients (EOBACoefficients *const coeffs, const REAL8 eta)
 Function to pre-compute the coefficients in the EOB A potential function. More...
 
int LALHCapDerivativesP4PN (double UNUSED t, const REAL8 values[], REAL8 dvalues[], void *funcParams)
 
static int XLALFirstStoppingCondition (double UNUSED t, const double UNUSED values[], double dvalues[], void *funcParams)
 Function which will calculate the stopping condition for the initial sampling rate. More...
 
static int XLALHighSRStoppingCondition (double UNUSED t, const double values[], double dvalues[], void UNUSED *funcParams)
 Function which will calculate the stopping condition for the higher sampling rate. More...
 
static REAL8 GetRingdownAttachCombSize (INT4 l, INT4 m)
 
int XLALEOBPPWaveform (REAL4Vector *signalvec, InspiralTemplate *params)
 
int XLALEOBPPWaveformTemplates (REAL4Vector *signalvec1, REAL4Vector *signalvec2, InspiralTemplate *params)
 
int XLALEOBPPWaveformForInjection (CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)
 

Detailed Description

Functions to generate the EOBNRv2 waveforms, as defined in Pan et al, arXiv:1106.1021v1 [gr-qc].

Author
Craig Robinson

Prototypes

XLALEOBPPWaveform()

  • signalvec: Output containing the inspiral waveform.
  • params: Input containing binary chirp parameters.

XLALEOBPPWaveformTemplates()

  • signalvec1: Output containing the 0-phase inspiral waveform.
  • signalvec2: Output containing the \(\pi/2\)-phase inspiral waveform.
  • params: Input containing binary chirp parameters.

XLALEOBPPWaveformForInjection()

  • waveform: Coherent GW structure containing output waveform
  • params: Input containing inspiral template parameters.
  • ppnParams Input containing other necessary parameters.

Definition in file LALEOBPPWaveform.c.

Go to the source code of this file.

Data Structures

struct  rOfOmegaIn
 
struct  pr3In
 

Macros

#define ninty4by3etc   18.687902694437592603 /* (94/3 -41/31*pi*pi) */
 

Variables

static const int EOBNRV2_NUM_MODES_MAX = 5
 

Macro Definition Documentation

◆ ninty4by3etc

#define ninty4by3etc   18.687902694437592603 /* (94/3 -41/31*pi*pi) */

Definition at line 62 of file LALEOBPPWaveform.c.

Function Documentation

◆ XLALCalculateA5()

static REAL8 XLALCalculateA5 ( REAL8  eta)
inlinestatic

Definition at line 536 of file LALEOBPPWaveform.c.

◆ XLALCalculateA6() [1/2]

static REAL8 XLALCalculateA6 ( REAL8  eta)
inlinestatic

◆ omegaofrP4PN()

static REAL8 omegaofrP4PN ( const REAL8  r,
const REAL8  eta,
void *  params 
)
static

Definition at line 766 of file LALEOBPPWaveform.c.

◆ nonKeplerianCoefficient()

static REAL8 nonKeplerianCoefficient ( REAL8Vector *restrict  values,
const REAL8  eta,
EOBACoefficients coeffs 
)
static

Definition at line 791 of file LALEOBPPWaveform.c.

◆ LALHCapDerivativesP4PN() [1/2]

static int LALHCapDerivativesP4PN ( double  t,
const double  values[],
double  dvalues[],
void *  funcParams 
)
static

◆ XLALCalculateOmega()

static REAL8 XLALCalculateOmega ( REAL8  eta,
REAL8  r,
REAL8  pr,
REAL8  pPhi,
EOBACoefficients aCoeffs 
)
static

Definition at line 922 of file LALEOBPPWaveform.c.

◆ XLALFirstStoppingCondition() [1/2]

static int XLALFirstStoppingCondition ( double  t,
const double  values[],
double  dvalues[],
void *  funcParams 
)
static

◆ XLALHighSRStoppingCondition() [1/2]

static int XLALHighSRStoppingCondition ( double  t,
const double  values[],
double  dvalues[],
void *  funcParams 
)
static

◆ XLALCalculateEOBA()

static REAL8 XLALCalculateEOBA ( const REAL8  r,
EOBACoefficients *restrict  coeffs 
)
static

Definition at line 585 of file LALEOBPPWaveform.c.

◆ XLALCalculateEOBD()

static REAL8 XLALCalculateEOBD ( REAL8  r,
REAL8  eta 
)
static

Definition at line 655 of file LALEOBPPWaveform.c.

◆ XLALCalculateEOBdAdr()

static REAL8 XLALCalculateEOBdAdr ( const REAL8  r,
EOBACoefficients *restrict  coeffs 
)
static

Definition at line 618 of file LALEOBPPWaveform.c.

◆ XLALEffectiveHamiltonian()

static REAL8 XLALEffectiveHamiltonian ( const REAL8  eta,
const REAL8  r,
const REAL8  pr,
const REAL8  pp,
EOBACoefficients aCoeffs 
)
static

Function to calculate the EOB effective Hamiltonian for the given values of the dynamical variables.

The coefficients in the A potential function should already have been computed. Note that the pr used here is the tortoise co-ordinate.

Definition at line 675 of file LALEOBPPWaveform.c.

◆ XLALprInitP4PN()

REAL8 XLALprInitP4PN ( REAL8  p,
void *  params 
)
static

Definition at line 720 of file LALEOBPPWaveform.c.

◆ XLALpphiInitP4PN()

REAL8 XLALpphiInitP4PN ( const REAL8  r,
EOBACoefficients *restrict  coeffs 
)
static

Definition at line 699 of file LALEOBPPWaveform.c.

◆ XLALrOfOmegaP4PN()

REAL8 XLALrOfOmegaP4PN ( REAL8  r,
void *  params 
)
static

Definition at line 811 of file LALEOBPPWaveform.c.

◆ XLALvrP4PN()

REAL8 XLALvrP4PN ( const REAL8  r,
const REAL8  omega,
pr3In params 
)
static

Definition at line 993 of file LALEOBPPWaveform.c.

◆ XLALEOBPPWaveformEngine()

static int XLALEOBPPWaveformEngine ( REAL4Vector signalvec1,
REAL4Vector signalvec2,
REAL4Vector h,
const REAL8 phiC,
UINT4 countback,
InspiralTemplate params,
InspiralInit paramsInit 
)
static

Definition at line 1419 of file LALEOBPPWaveform.c.

◆ XLALGetFactorizedWaveform()

INT4 XLALGetFactorizedWaveform ( COMPLEX16 *restrict  hlm,
REAL8Vector *restrict  values,
const REAL8  v,
const INT4  l,
const INT4  m,
EOBParams *restrict  params 
)

Definition at line 163 of file LALEOBPPWaveform.c.

◆ XLALCalculateA6() [2/2]

static REAL8 XLALCalculateA6 ( const REAL8 UNUSED  eta)
inlinestatic

Definition at line 542 of file LALEOBPPWaveform.c.

◆ XLALCalculateEOBACoefficients()

static int XLALCalculateEOBACoefficients ( EOBACoefficients *const  coeffs,
const REAL8  eta 
)
static

Function to pre-compute the coefficients in the EOB A potential function.

Definition at line 553 of file LALEOBPPWaveform.c.

◆ LALHCapDerivativesP4PN() [2/2]

int LALHCapDerivativesP4PN ( double UNUSED  t,
const REAL8  values[],
REAL8  dvalues[],
void *  funcParams 
)

Definition at line 832 of file LALEOBPPWaveform.c.

◆ XLALFirstStoppingCondition() [2/2]

static int XLALFirstStoppingCondition ( double UNUSED  t,
const double UNUSED  values[],
double  dvalues[],
void *  funcParams 
)
static

Function which will calculate the stopping condition for the initial sampling rate.

Definition at line 944 of file LALEOBPPWaveform.c.

◆ XLALHighSRStoppingCondition() [2/2]

static int XLALHighSRStoppingCondition ( double UNUSED  t,
const double  values[],
double  dvalues[],
void UNUSED *  funcParams 
)
static

Function which will calculate the stopping condition for the higher sampling rate.

Definition at line 968 of file LALEOBPPWaveform.c.

◆ GetRingdownAttachCombSize()

static REAL8 GetRingdownAttachCombSize ( INT4  l,
INT4  m 
)
static

Definition at line 1060 of file LALEOBPPWaveform.c.

◆ XLALEOBPPWaveform()

int XLALEOBPPWaveform ( REAL4Vector signalvec,
InspiralTemplate params 
)

Definition at line 1124 of file LALEOBPPWaveform.c.

◆ XLALEOBPPWaveformTemplates()

int XLALEOBPPWaveformTemplates ( REAL4Vector signalvec1,
REAL4Vector signalvec2,
InspiralTemplate params 
)

Definition at line 1193 of file LALEOBPPWaveform.c.

◆ XLALEOBPPWaveformForInjection()

int XLALEOBPPWaveformForInjection ( CoherentGW waveform,
InspiralTemplate params,
PPNParamStruc ppnParams 
)

Definition at line 1275 of file LALEOBPPWaveform.c.

Variable Documentation

◆ EOBNRV2_NUM_MODES_MAX

const int EOBNRV2_NUM_MODES_MAX = 5
static

Definition at line 64 of file LALEOBPPWaveform.c.