Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALInspiral 5.0.3.1-ea7c608
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
LALInspiralTofVIntegrand.c
Go to the documentation of this file.
1/*
2* Copyright (C) 2007 David Churches, B.S. Sathyaprakash
3*
4* This program is free software; you can redistribute it and/or modify
5* it under the terms of the GNU General Public License as published by
6* the Free Software Foundation; either version 2 of the License, or
7* (at your option) any later version.
8*
9* This program is distributed in the hope that it will be useful,
10* but WITHOUT ANY WARRANTY; without even the implied warranty of
11* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12* GNU General Public License for more details.
13*
14* You should have received a copy of the GNU General Public License
15* along with with program; see the file COPYING. If not, write to the
16* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17* MA 02110-1301 USA
18*/
19
20/**
21 * \author Sathyaprakash, B. S.
22 * \file
23 * \ingroup LALInspiral_h
24 *
25 * \brief The function \c LALInspiralTofVIntegrand() calculates the quantity \f$E^{\prime}(v)/\mathcal{F}(v)\f$.
26 *
27 * ### Prototypes ###
28 *
29 * <tt>LALInspiralTofVIntegrand()</tt>
30 *
31 * ### Description ###
32 *
33 * The function \c LALInspiralTofVIntegrand() calculates the quantity \f$E^{\prime}(v)/\mathcal{F}(v)\f$.
34 * These are the energy and flux functions which are used in the gravitational wave phasing formula, which is
35 * defined as
36 *
37 * \f{eqnarray}{
38 * \label{phasing formula}
39 * t(v) & = & t_\textrm{ref} + m \int_v^{v_\textrm{ref}} \,
40 * \frac{E'(v)}{{\cal F}(v)} \, dv, \\
41 * \phi (v) & = & \phi_\textrm{ref} + 2 \int_v^{v_\textrm{ref}} v^3 \,
42 * \frac{E'(v)}{{\cal F}(v)} \, dv,
43 * \f}
44 *
45 * where \f$v=(\pi m F)^{1/3}\f$ is an invariantly defined velocity, \f$F\f$ is the instantaneous GW frequency, and
46 * \f$m\f$ is the total mass of the binary.
47 *
48 * ### Uses ###
49 *
50 * This function calls the function which represents \f$E^{\prime}(v)\f$ and \f$\mathcal{F}(v)\f$. The pointer to each
51 * of these functions is set by a call to the function \c LALInspiralChooseModel().
52 *
53 */
54
55#include <lal/LALAtomicDatatypes.h>
56#include <lal/LALInspiral.h>
57#include <lal/XLALError.h>
58
61 REAL8 v,
62 void *params
63 )
64{
65
66 TofVIntegrandIn *ak = NULL;
67
68 if ( !params )
70
71 if ( v <= 0.0 || v >= 1.0 )
73
74 ak = (TofVIntegrandIn *) params;
75 return ak->dEnergy( v, ak->coeffs ) / ak->flux( v, ak->coeffs );
76}
REAL8 XLALInspiralTofVIntegrand(REAL8 v, void *params)
double REAL8
#define XLAL_ERROR_REAL8(...)
XLAL_EFAULT
XLAL_EINVAL
EnergyFunction dEnergy
expnCoeffsdEnergyFlux * coeffs
FluxFunction flux