LALSimInspiral.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2008 J. Creighton, S. Fairhurst, B. Krishnan, L. Santamaria
00003  *
00004  *  This program is free software; you can redistribute it and/or modify
00005  *  it under the terms of the GNU General Public License as published by
00006  *  the Free Software Foundation; either version 2 of the License, or
00007  *  (at your option) any later version.
00008  *
00009  *  This program is distributed in the hope that it will be useful,
00010  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  *  GNU General Public License for more details.
00013  *
00014  *  You should have received a copy of the GNU General Public License
00015  *  along with with program; see the file COPYING. If not, write to the 
00016  *  Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, 
00017  *  MA  02111-1307  USA
00018  */
00019 #include <lal/LALDatatypes.h>
00020 NRCSID(LALSIMINSPIRALH, "$Id: LALSimInspiral.h,v 1.4 2008/03/20 00:31:57 jolien Exp $");
00021 
00022 #define LAL_PN_MODE_L_MAX 3 
00023 
00024 /**
00025  * Computes h(2,2) mode of spherical harmonic decomposition of
00026  * the post-Newtonian inspiral waveform.
00027  *
00028  * Implements Equation (79) of:
00029  * Lawrence E. Kidder, "Using Full Information When Computing Modes of
00030  * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular
00031  * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].
00032  */
00033 COMPLEX16 XLALSimInspiralPNMode22(
00034                 REAL8 x,      /**< post-Newtonian parameter */
00035                 REAL8 phi,    /**< orbital phase */
00036                 REAL8 logx,   /**< log(x/x0) tail gauge parameter */
00037                 REAL8 m1,     /**< mass of companion 1 */
00038                 REAL8 m2,     /**< mass of companion 2 */
00039                 REAL8 r,      /**< distance of source */
00040                 int O         /**< twice post-Newtonian order */
00041                 );
00042 
00043 /**
00044  * Computes h(2,1) mode of spherical harmonic decomposition of
00045  * the post-Newtonian inspiral waveform.
00046  *
00047  * Implements Equation (80) of:
00048  * Lawrence E. Kidder, "Using Full Information When Computing Modes of
00049  * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular
00050  * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].
00051  */
00052 COMPLEX16 XLALSimInspiralPNMode21(
00053                 REAL8 x,      /**< post-Newtonian parameter */
00054                 REAL8 phi,    /**< orbital phase */
00055                 REAL8 logx,   /**< log(x/x0) tail gauge parameter */
00056                 REAL8 m1,     /**< mass of companion 1 */
00057                 REAL8 m2,     /**< mass of companion 2 */
00058                 REAL8 r,      /**< distance of source */
00059                 int O         /**< twice post-Newtonian order */
00060                 );
00061 
00062 /**
00063  * Computes h(3,3) mode of spherical harmonic decomposition of
00064  * the post-Newtonian inspiral waveform.
00065  *
00066  * Implements Equation (82) of:
00067  * Lawrence E. Kidder, "Using Full Information When Computing Modes of
00068  * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular
00069  * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].
00070  */
00071 COMPLEX16 XLALSimInspiralPNMode33(
00072                 REAL8 x,      /**< post-Newtonian parameter */
00073                 REAL8 phi,    /**< orbital phase */
00074                 REAL8 logx,   /**< log(x/x0) tail gauge parameter */
00075                 REAL8 m1,     /**< mass of companion 1 */
00076                 REAL8 m2,     /**< mass of companion 2 */
00077                 REAL8 r,      /**< distance of source */
00078                 int O         /**< twice post-Newtonian order */
00079                 );
00080 
00081 /**
00082  * Computes h(3,2) mode of spherical harmonic decomposition of
00083  * the post-Newtonian inspiral waveform.
00084  *
00085  * Implements Equation (83) of:
00086  * Lawrence E. Kidder, "Using Full Information When Computing Modes of
00087  * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular
00088  * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].
00089  */
00090 COMPLEX16 XLALSimInspiralPNMode32(
00091                 REAL8 x,      /**< post-Newtonian parameter */
00092                 REAL8 phi,    /**< orbital phase */
00093                 REAL8 logx,   /**< log(x/x0) tail gauge parameter */
00094                 REAL8 m1,     /**< mass of companion 1 */
00095                 REAL8 m2,     /**< mass of companion 2 */
00096                 REAL8 r,      /**< distance of source */
00097                 int O         /**< twice post-Newtonian order */
00098                 );
00099 
00100 /**
00101  * Computes h(3,1) mode of spherical harmonic decomposition of
00102  * the post-Newtonian inspiral waveform.
00103  *
00104  * Implements Equation (84) of:
00105  * Lawrence E. Kidder, "Using Full Information When Computing Modes of
00106  * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular
00107  * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].
00108  */
00109 COMPLEX16 XLALSimInspiralPNMode31(
00110                 REAL8 x,      /**< post-Newtonian parameter */
00111                 REAL8 phi,    /**< orbital phase */
00112                 REAL8 logx,   /**< log(x/x0) tail gauge parameter */
00113                 REAL8 m1,     /**< mass of companion 1 */
00114                 REAL8 m2,     /**< mass of companion 2 */
00115                 REAL8 r,      /**< distance of source */
00116                 int O         /**< twice post-Newtonian order */
00117                 );
00118 
00119 /**
00120  * Computes the (s)Y(l,m) spin-weighted spherical harmonic.
00121  *
00122  * From somewhere ....
00123  *
00124  * See also:
00125  * Implements Equations (II.9)-(II.13) of
00126  * D. A. Brown, S. Fairhurst, B. Krishnan, R. A. Mercer, R. K. Kopparapu,
00127  * L. Santamaria, and J. T. Whelan,
00128  * "Data formats for numerical relativity waves",
00129  * arXiv:0709.0093v1 (2007).
00130  *
00131  * Currently only supports s=-2, l=2,3,4,5 modes.
00132  */
00133 COMPLEX16 XLALSpinWeightedSphericalHarmonic(
00134                 REAL8 theta,  /**< polar angle (rad) */
00135                 REAL8 phi,    /**< azimuthal angle (rad) */
00136                 int s,        /**< spin weight */
00137                 int l,        /**< mode number l */
00138                 int m         /**< mode number m */
00139                 );
00140 
00141 /**
00142  * Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic
00143  * to obtain hplus - i hcross, which is added to the time series.
00144  *
00145  * Implements the sum of a single term of Eq. (11) of:
00146  * Lawrence E. Kidder, "Using Full Information When Computing Modes of
00147  * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular
00148  * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].
00149  *
00150  * If sym is non-zero, symmetrically add the m and -m terms assuming
00151  * that h(l,-m) = (-1)^l h(l,m)*; see Eq. (78) ibid.
00152  */
00153 int XLALSimAddMode(
00154                 REAL8TimeSeries *hplus,      /**< +-polarization waveform */
00155                 REAL8TimeSeries *hcross,     /**< x-polarization waveform */
00156                 COMPLEX16TimeSeries *hmode,  /**< complex mode h(l,m) */
00157                 REAL8 theta,                 /**< polar angle (rad) */
00158                 REAL8 phi,                   /**< azimuthal angle (rad) */
00159                 int l,                       /**< mode number l */
00160                 int m,                       /**< mode number m */
00161                 int sym                      /**< flag to add -m mode too */
00162                 );
00163 
00164 /**
00165  * Computes the rate of increase of the orbital frequency for a post-Newtonian
00166  * inspiral.  This function returns dx/dt rather than the true angular
00167  * acceleration.
00168  *
00169  * Implements Equation (6) of
00170  * Yi Pan, Alessandra Buonanno, Yanbei Chen, and Michele Vallisneri,
00171  * "A physical template family for gravitational waves from precessing
00172  * binaries of spinning compact objects: Application to single-spin binaries"
00173  * arXiv:gr-qc/0310034v3 (2007).
00174  *
00175  * Note: this equation is actually dx/dt rather than (domega/dt)/(omega)^2
00176  * so the leading coefficient is different.  Also, this function applies
00177  * for non-spinning objects.
00178  *
00179  * Compare the overall coefficient, with nu=1/4, to Equation (45) of
00180  * Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, 
00181  * Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsky 
00182  * "High-accuracy comparison of numerical relativity simulations with
00183  * post-Newtonian expansions"
00184  * arXiv:0710.0158v1 (2007).
00185  */
00186 REAL8 XLALSimInspiralPNAngularAcceleration(
00187                 REAL8 x,  /**< post-Newtonian parameter */
00188                 REAL8 m1, /**< mass of companion 1 */
00189                 REAL8 m2, /**< mass of companion 2 */
00190                 int O     /**< twice post-Newtonian order */
00191                 );
00192 
00193 /**
00194  * Computes the orbital angular velocity from the quantity x.
00195  * This is from the definition of x.
00196  *
00197  * Implements Equation (46) of
00198  * Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, 
00199  * Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsky 
00200  * "High-accuracy comparison of numerical relativity simulations with
00201  * post-Newtonian expansions"
00202  * arXiv:0710.0158v1 (2007).
00203  */
00204 REAL8 XLALSimInspiralPNAngularVelocity(
00205                 REAL8 x,  /**< post-Newtonian parameter */
00206                 REAL8 m1, /**< mass of companion 1 */
00207                 REAL8 m2  /**< mass of companion 2 */
00208                 );
00209 
00210 /**
00211  * Computes the orbital energy at a fixed frequency and pN order.
00212  *
00213  * Implements Equation (152) of
00214  * Luc Blanchet,
00215  * "Gravitational Radiation from Post-Newtonian Sources and Inspiralling
00216  * Compact Binaries",
00217  * http://www.livingreviews.org/lrr-2006-4/index.html
00218  *
00219  * This is the same as Equation (10) (where the spin of the objects
00220  * is zero) of:
00221  * Yi Pan, Alessandra Buonanno, Yanbei Chen, and Michele Vallisneri,
00222  * "A physical template family for gravitational waves from precessing
00223  * binaries of spinning compact objects: Application to single-spin binaries"
00224  * arXiv:gr-qc/0310034v3 (2007). 
00225  * Note: this equation is actually dx/dt rather than (domega/dt)/(omega)^2
00226  * so the leading coefficient is different.
00227  */
00228 REAL8 XLALSimInspiralPNEnergy(
00229                 REAL8 x,  /**< post-Newtonian parameter */
00230                 REAL8 m1, /**< mass of companion 1 */
00231                 REAL8 m2, /**< mass of companion 2 */
00232                 int O     /**< twice post-Newtonian order */
00233                 );
00234 
00235 /**
00236  * Evolves a post-Newtonian orbit using the Taylor T4 method.
00237  *
00238  * See:
00239  * Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, 
00240  * Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsky 
00241  * "High-accuracy comparison of numerical relativity simulations with
00242  * post-Newtonian expansions"
00243  * arXiv:0710.0158v1 (2007).
00244  */
00245 int XLALSimInspiralPNEvolveOrbitTaylorT4(
00246                 REAL8TimeSeries **x,   /**< post-Newtonian parameter [returned] */
00247                 REAL8TimeSeries **phi, /**< orbital phase [returned] */
00248                 LIGOTimeGPS *tc,       /**< coalescence time */
00249                 REAL8 phic,            /**< coalescence phase */
00250                 REAL8 deltaT,          /**< sampling interval */
00251                 REAL8 m1,              /**< mass of companion 1 */
00252                 REAL8 m2,              /**< mass of companion 2 */
00253                 REAL8 fmin,            /**< start frequency */
00254                 int O                  /**< twice post-Newtonian order */
00255                 );
00256 
00257 /**
00258  * Computes h(l,m) mode timeseries of spherical harmonic decomposition of
00259  * the post-Newtonian inspiral waveform.
00260  *
00261  * See Eqns. (79)-(116) of:
00262  * Lawrence E. Kidder, "Using Full Information When Computing Modes of
00263  * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular
00264  * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].
00265  */
00266 COMPLEX16TimeSeries *XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries(
00267                 REAL8TimeSeries *x,   /**< post-Newtonian parameter */
00268                 REAL8TimeSeries *phi, /**< orbital phase */
00269                 REAL8 x0,             /**< tail-term gauge choice thing (if you don't know, just set it to zero) */
00270                 REAL8 m1,             /**< mass of companion 1 */
00271                 REAL8 m2,             /**< mass of companion 2 */
00272                 REAL8 r,              /**< distance of source */
00273                 int O,                /**< twice post-Newtonain order */
00274                 int l,                /**< mode number l */
00275                 int m                 /**< mode number m */
00276                 );
00277 
00278 /**
00279  * Given an orbit evolution phasing, construct the waveform h+ and hx.
00280  *
00281  * Implements Equation (11) of:
00282  * Lawrence E. Kidder, "Using Full Information When Computing Modes of
00283  * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular
00284  * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].
00285  */
00286 int XLALSimInspiralPNPolarizationWaveforms(
00287                 REAL8TimeSeries **hplus,  /**< +-polarization waveform [returned] */
00288                 REAL8TimeSeries **hcross, /**< x-polarization waveform [returned] */
00289                 REAL8TimeSeries *x,       /**< post-Newtonian parameter */
00290                 REAL8TimeSeries *phi,     /**< orbital phase */
00291                 REAL8 x0,                 /**< tail-term gauge choice thing (if you don't know, just set it to zero) */
00292                 REAL8 m1,                 /**< mass of companion 1 */
00293                 REAL8 m2,                 /**< mass of companion 2 */
00294                 REAL8 r,                  /**< distance of source */
00295                 REAL8 i,                  /**< inclination of source (rad) */
00296                 int O                     /**< twice post-Newtonian order */
00297                 );
00298 
00299 /**
00300  * Driver routine to compute the post-Newtonian inspiral waveform.
00301  * 
00302  * This routine uses the same pN order for phasing and amplitude
00303  * (unless the order is -1 in which case the highest available
00304  * order is used for both of these -- which might not be the same).
00305  *
00306  * Log terms in amplitudes are ignored.  This is a gauge choice.
00307  */
00308 int XLALSimInspiralPN(
00309                 REAL8TimeSeries **hplus,  /**< +-polarization waveform */
00310                 REAL8TimeSeries **hcross, /**< x-polarization waveform */
00311                 LIGOTimeGPS *tc,          /**< coalescence time */
00312                 REAL8 phic,               /**< coalescence phase */
00313                 REAL8 deltaT,             /**< sampling interval */
00314                 REAL8 m1,                 /**< mass of companion 1 */
00315                 REAL8 m2,                 /**< mass of companion 2 */
00316                 REAL8 fmin,               /**< start frequency */
00317                 REAL8 r,                  /**< distance of source */
00318                 REAL8 i,                  /**< inclination of source (rad) */
00319                 int O                     /**< twice post-Newtonian order */
00320                 );
00321 
00322 /**
00323  * Driver routine to compute the restricted post-Newtonian inspiral waveform.
00324  * 
00325  * This routine computes the phasing to the specified order, but
00326  * only computes the amplitudes to the Newtonian (quadrupole) order.
00327  *
00328  * Log terms in amplitudes are ignored.  This is a gauge choice.
00329  */
00330 int XLALSimInspiralPNRestricted(
00331                 REAL8TimeSeries **hplus,  /**< +-polarization waveform */
00332                 REAL8TimeSeries **hcross, /**< x-polarization waveform */
00333                 LIGOTimeGPS *tc,          /**< coalescence time */
00334                 REAL8 phic,               /**< coalescence phase */
00335                 REAL8 deltaT,             /**< sampling interval */
00336                 REAL8 m1,                 /**< mass of companion 1 */
00337                 REAL8 m2,                 /**< mass of companion 2 */
00338                 REAL8 fmin,               /**< start frequency */
00339                 REAL8 r,                  /**< distance of source */
00340                 REAL8 i,                  /**< inclination of source (rad) */
00341                 int O                     /**< twice post-Newtonian phase order */
00342                 );

Generated on Fri Aug 29 02:49:00 2008 for LAL by  doxygen 1.5.2