Processing math: 100%
LALInspiral 5.0.3.1-ea7c608
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
LALInspiralChooseModel.c File Reference

Module to set the pointers to the required energy and flux functions. Normally, a user is not required to call this function to generate a waveform. More...

Prototypes

static REAL8 dEt0 (REAL8 v, expnCoeffs *ak)
 
static REAL8 dEt2 (REAL8 v, expnCoeffs *ak)
 
static REAL8 dEt4 (REAL8 v, expnCoeffs *ak)
 
static REAL8 dEt6 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Ft0 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Ft2 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Ft3 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Ft4 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Ft5 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Ft6 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Ft7 (REAL8 v, expnCoeffs *ak)
 
static REAL8 ep2 (REAL8 v, expnCoeffs *ak)
 
static REAL8 ep4 (REAL8 v, expnCoeffs *ak)
 
static REAL8 ep6 (REAL8 v, expnCoeffs *ak)
 
static REAL8 dEp2 (REAL8 v, expnCoeffs *ak)
 
static REAL8 dEp4 (REAL8 v, expnCoeffs *ak)
 
static REAL8 dEp6 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Fp3 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Fp4 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Fp5 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Fp6 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Fp7 (REAL8 v, expnCoeffs *ak)
 
static REAL8 Fp8PP (REAL8 v, expnCoeffs *ak)
 
void LALInspiralChooseModel (LALStatus *status, expnFunc *f, expnCoeffs *ak, InspiralTemplate *params)
 
int XLALInspiralChooseModel (expnFunc *f, expnCoeffs *ak, InspiralTemplate *params)
 

Detailed Description

Module to set the pointers to the required energy and flux functions. Normally, a user is not required to call this function to generate a waveform.

Author
Sathyaprakash, B. S.

Prototypes

LALInspiralChooseModel()

  • f: Output containing the pointers to the appropriate energy, flux, frequency, timing and phasing functions.
  • ak: Output containing the PN expnasion coefficients.
  • params: Input containing binary chirp parameters.

Description

This module gives the post-Newtonian expansions and/or P-approximants to the energy, its derivative and gravitational-wave flux functions. More specifically, the static REAL8 functions below give Taylor expansions of dE/dv, and {\cal F}(v), P-approximants of e(v), dE/dv (derived from e(v)) and {\cal F}(v).

LALInspiralChooseModel is used to set pointers to the required energy and flux functions E^{\prime}_T(v), \mathcal{F}_T(v), E^{\prime}_P(v) and \mathcal{F}_P(v), in expnFunc, as also the GW phasing and frequency fucntions used in the various approximants to generate the waveform. More specifically pointers are set to the following functions in the structure expnFunc:

  • EnergyFunction *dEnergy
  • FluxFunction *flux
  • InspiralTiming2 *timing2
  • InspiralPhasing2 *phasing2
  • InspiralPhasing3 *phasing3
  • InspiralFrequency3 *frequency3

LALInspiralChooseModel also outputs in ak the last stable orbit (LSO) velocity v_\textrm{LSO} (as ak->vn) defined by the equation E'(v_\textrm{LSO})=0, the values of the GW frequency f_\textrm{LSO}=v_\textrm{LSO}^3/(\pi m) (as ak->fn) and time (as ak->tn) elapsed from params->fLower to smaller of fCutOff and ak->fn by evaluating the integral

\begin{equation} t_n = t_{0} - m \int^{v_n}_{v_0} \frac{E^{\prime}(v)}{\mathcal{F}(v)} \, dv\,, \end{equation}

where t_{0} (usually equal to zero) is the user specified starting time for the waveform when the wave frequency reaches params->fLower and v_{0}= (\pi m f)^{1/3} (with f=<tt>params->fLower</tt>) is the velocity at time t_{0}. Note that E'(v) and {\cal F}(v) are defined in f->dEnergy and f->flux.

Algorithm

Numerical integration is used to compute ak->tn.

Uses

LALInspiralTofV

Notes

  • See Damour, Iyer and Sathyaprakash, PRD 57, 885, 1998 for further details. Damour, Iyer and Sathyaprakash, PRD 63, 044023, 2001 is a resource paper that summarizes how to generate waveforms in different approximations to the dynamics of a compact binary under radiation reaction.
  • The Pade Approximant for the 1PN expansion is undefined as also EOB at orders less than 2PN. BCV is independent of the PN order. Spinning waveforms are only defined at the highest PN order.

Definition in file LALInspiralChooseModel.c.

Go to the source code of this file.

Function Documentation

◆ dEt0()

static REAL8 dEt0 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 102 of file LALInspiralChooseModel.c.

◆ dEt2()

static REAL8 dEt2 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 110 of file LALInspiralChooseModel.c.

◆ dEt4()

static REAL8 dEt4 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 119 of file LALInspiralChooseModel.c.

◆ dEt6()

static REAL8 dEt6 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 129 of file LALInspiralChooseModel.c.

◆ Ft0()

static REAL8 Ft0 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 142 of file LALInspiralChooseModel.c.

◆ Ft2()

static REAL8 Ft2 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 154 of file LALInspiralChooseModel.c.

◆ Ft3()

static REAL8 Ft3 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 166 of file LALInspiralChooseModel.c.

◆ Ft4()

static REAL8 Ft4 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 178 of file LALInspiralChooseModel.c.

◆ Ft5()

static REAL8 Ft5 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 190 of file LALInspiralChooseModel.c.

◆ Ft6()

static REAL8 Ft6 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 203 of file LALInspiralChooseModel.c.

◆ Ft7()

static REAL8 Ft7 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 217 of file LALInspiralChooseModel.c.

◆ ep2()

static REAL8 ep2 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 243 of file LALInspiralChooseModel.c.

◆ ep4()

static REAL8 ep4 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 252 of file LALInspiralChooseModel.c.

◆ ep6()

static REAL8 ep6 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 261 of file LALInspiralChooseModel.c.

◆ dEp2()

static REAL8 dEp2 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 283 of file LALInspiralChooseModel.c.

◆ dEp4()

static REAL8 dEp4 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 296 of file LALInspiralChooseModel.c.

◆ dEp6()

static REAL8 dEp6 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 313 of file LALInspiralChooseModel.c.

◆ Fp3()

static REAL8 Fp3 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 374 of file LALInspiralChooseModel.c.

◆ Fp4()

static REAL8 Fp4 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 387 of file LALInspiralChooseModel.c.

◆ Fp5()

static REAL8 Fp5 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 400 of file LALInspiralChooseModel.c.

◆ Fp6()

static REAL8 Fp6 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 413 of file LALInspiralChooseModel.c.

◆ Fp7()

static REAL8 Fp7 ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 430 of file LALInspiralChooseModel.c.

◆ Fp8PP()

static REAL8 Fp8PP ( REAL8  v,
expnCoeffs ak 
)
static

Definition at line 446 of file LALInspiralChooseModel.c.

◆ LALInspiralChooseModel()

void LALInspiralChooseModel ( LALStatus status,
expnFunc f,
expnCoeffs ak,
InspiralTemplate params 
)

Definition at line 486 of file LALInspiralChooseModel.c.

◆ XLALInspiralChooseModel()

int XLALInspiralChooseModel ( expnFunc f,
expnCoeffs ak,
InspiralTemplate params 
)

Definition at line 506 of file LALInspiralChooseModel.c.