| LALSimInspiral.h | | LALSimInspiral.h | |
| | | | |
| skipping to change at line 57 | | skipping to change at line 57 | |
| * obtained by iteratively solving post-Newtonian e
xpansions \f$\varphi(v)\f$ and \f$t(v)\f$; | | * obtained by iteratively solving post-Newtonian e
xpansions \f$\varphi(v)\f$ and \f$t(v)\f$; | |
| * Outputs a time-domain wave. | | * Outputs a time-domain wave. | |
| */ | | */ | |
| TaylorT3, /**< Time domain Taylor approximant in which phase i
s explicitly given as a function | | TaylorT3, /**< Time domain Taylor approximant in which phase i
s explicitly given as a function | |
| * of time; outputs a time-domain wave. | | * of time; outputs a time-domain wave. | |
| */ | | */ | |
| TaylorF1, /**< The stationary phase approximation that correct
ly represents, in the Fourier domain, | | TaylorF1, /**< The stationary phase approximation that correct
ly represents, in the Fourier domain, | |
| * the waveform given by \c TaylorT1 approximant (s
ee [\ref dis2000] for details); | | * the waveform given by \c TaylorT1 approximant (s
ee [\ref dis2000] for details); | |
| * Outputs a frequency-domain wave. */ | | * Outputs a frequency-domain wave. */ | |
| TaylorF2, /**< The standard stationary phase approximation; Ou
tputs a frequency-domain wave. */ | | TaylorF2, /**< The standard stationary phase approximation; Ou
tputs a frequency-domain wave. */ | |
|
| TaylorF2RedSpin, /**< TaylorF2 waveforms for non-precessing s | | TaylorF2RedSpin, /**< TaylorF2 waveforms for non-precessing s | |
| pins, defined in terms of a single (reduced-spin) parameter [\ref Ajith:201 | | pins, defined in terms of a single (reduced-spin) parameter [Ajith_2011ec]* | |
| 1ec]*/ | | / | |
| TaylorF2RedSpinTidal, /**< TaylorF2 waveforms for non-prec | | TaylorF2RedSpinTidal, /**< TaylorF2 waveforms for non-prec | |
| essing spins, defined in terms of a single (reduced-spin) parameter [\ref A | | essing spins, defined in terms of a single (reduced-spin) parameter [Ajith_ | |
| jith:2011ec] plus tidal terms (http://arxiv.org/abs/1101.1673) */ | | 2011ec] plus tidal terms (http://arxiv.org/abs/1101.1673) */ | |
| PadeT1, /**< Time-domain P-approximant; Outputs a time-domai
n wave. */ | | PadeT1, /**< Time-domain P-approximant; Outputs a time-domai
n wave. */ | |
| PadeF1, /**< Frequency-domain P-approximant (not yet impleme
nted). */ | | PadeF1, /**< Frequency-domain P-approximant (not yet impleme
nted). */ | |
| EOB, /**< Effective one-body waveform; Outputs a
time-domain wave. */ | | EOB, /**< Effective one-body waveform; Outputs a
time-domain wave. */ | |
| BCV, /**< Detection template family of Buonanno,
Chen and Vallisneri [\ref BCV03]; Outputs a frequency-domain wave. */ | | BCV, /**< Detection template family of Buonanno,
Chen and Vallisneri [\ref BCV03]; Outputs a frequency-domain wave. */ | |
| BCVSpin, /**< Detection template family of Buonanno, Chen and
Vallisneri including spin effects [\ref BCV03b]; Outputs a frequency-doma
in wave. */ | | BCVSpin, /**< Detection template family of Buonanno, Chen and
Vallisneri including spin effects [\ref BCV03b]; Outputs a frequency-doma
in wave. */ | |
| SpinTaylorT3, /**< Spinning case T3 models */ | | SpinTaylorT3, /**< Spinning case T3 models */ | |
| SpinTaylorT4, /**< Spinning case T4 models (lalsimulation's equiva
lent of SpinTaylorFrameless) */ | | SpinTaylorT4, /**< Spinning case T4 models (lalsimulation's equiva
lent of SpinTaylorFrameless) */ | |
| SpinTaylorFrameless, /**< Spinning case PN models (replace SpinTa
ylor by removing the coordinate singularity) */ | | SpinTaylorFrameless, /**< Spinning case PN models (replace SpinTa
ylor by removing the coordinate singularity) */ | |
| SpinTaylor, /**< Spinning case PN models (should replace SpinTay
lorT3 in the future) */ | | SpinTaylor, /**< Spinning case PN models (should replace SpinTay
lorT3 in the future) */ | |
| PhenSpinTaylorRD, /**< Phenomenological waveforms, interpolating betwe
en a T4 spin-inspiral and the ringdown. */ | | PhenSpinTaylorRD, /**< Phenomenological waveforms, interpolating betwe
en a T4 spin-inspiral and the ringdown. */ | |
| | | | |
| skipping to change at line 81 | | skipping to change at line 81 | |
| FindChirpSP, /**< The stationary phase templates implemen
ted by FindChirpSPTemplate in the findchirp package (equivalent to TaylorF2
at twoPN order). */ | | FindChirpSP, /**< The stationary phase templates implemen
ted by FindChirpSPTemplate in the findchirp package (equivalent to TaylorF2
at twoPN order). */ | |
| FindChirpPTF, /**< UNDOCUMENTED */ | | FindChirpPTF, /**< UNDOCUMENTED */ | |
| GeneratePPN, /**< The time domain templates generated by
LALGeneratePPNInspiral() in the inject package (equivalent to TaylorT3 at t
woPN order). */ | | GeneratePPN, /**< The time domain templates generated by
LALGeneratePPNInspiral() in the inject package (equivalent to TaylorT3 at t
woPN order). */ | |
| BCVC, /**< UNDOCUMENTED */ | | BCVC, /**< UNDOCUMENTED */ | |
| FrameFile, /**< The waveform contains arbitrary data read from
a frame file. */ | | FrameFile, /**< The waveform contains arbitrary data read from
a frame file. */ | |
| AmpCorPPN, /**< UNDOCUMENTED */ | | AmpCorPPN, /**< UNDOCUMENTED */ | |
| NumRel, /**< UNDOCUMENTED */ | | NumRel, /**< UNDOCUMENTED */ | |
| NumRelNinja2, /**< The waveform contains REAL8 data generated by l
alapps_fr_ninja from a file in the format described in arXiv:0709.0093v3 */ | | NumRelNinja2, /**< The waveform contains REAL8 data generated by l
alapps_fr_ninja from a file in the format described in arXiv:0709.0093v3 */ | |
| Eccentricity, /**< UNDOCUMENTED */ | | Eccentricity, /**< UNDOCUMENTED */ | |
| EOBNR, /**< UNDOCUMENTED */ | | EOBNR, /**< UNDOCUMENTED */ | |
|
| EOBNRv2, | | EOBNRv2, /**< UNDOCUMENTED */ | |
| EOBNRv2HM, | | EOBNRv2HM, /**< UNDOCUMENTED */ | |
| SEOBNRv1, /**< Spin-aligned EOBNR model */ | | SEOBNRv1, /**< Spin-aligned EOBNR model */ | |
| IMRPhenomA, /**< Time domain (non-spinning) inspiral-merger-ring
down waveforms generated from the inverse FFT of IMRPhenomFA */ | | IMRPhenomA, /**< Time domain (non-spinning) inspiral-merger-ring
down waveforms generated from the inverse FFT of IMRPhenomFA */ | |
| IMRPhenomB, /**< Time domain (non-precessing spins) inspiral-mer
ger-ringdown waveforms generated from the inverse FFT of IMRPhenomFB */ | | IMRPhenomB, /**< Time domain (non-precessing spins) inspiral-mer
ger-ringdown waveforms generated from the inverse FFT of IMRPhenomFB */ | |
|
| IMRPhenomFA, /**< Frequency domain (non-spinning) inspira | | IMRPhenomFA, /**< Frequency domain (non-spinning) inspira | |
| l-merger-ringdown templates of Ajith et al [\ref Ajith:2007kx] with phenome | | l-merger-ringdown templates of Ajith et al [Ajith_2007kx] with phenomenolog | |
| nological coefficients defined in the Table I of [\ref Ajith:2007xh]*/ | | ical coefficients defined in the Table I of [Ajith_2007xh]*/ | |
| IMRPhenomFB, /**< Frequency domain (non-precessing spins) | | IMRPhenomFB, /**< Frequency domain (non-precessing spins) | |
| inspiral-merger-ringdown templates of Ajith et al [\ref Ajith:2009bn] */ | | inspiral-merger-ringdown templates of Ajith et al [Ajith_2009bn] */ | |
| TaylorEt, /**< UNDOCUMENTED */ | | TaylorEt, /**< UNDOCUMENTED */ | |
| TaylorT4, /**< UNDOCUMENTED */ | | TaylorT4, /**< UNDOCUMENTED */ | |
| TaylorN, /**< UNDOCUMENTED */ | | TaylorN, /**< UNDOCUMENTED */ | |
| NumApproximants /**< UNDOCUMENTED */ | | NumApproximants /**< UNDOCUMENTED */ | |
| } Approximant; | | } Approximant; | |
| | | | |
| /** Enumeration to specify which interaction will be used in the waveform | | /** Enumeration to specify which interaction will be used in the waveform | |
| * generation. Their combination also can be used by the bitwise or. | | * generation. Their combination also can be used by the bitwise or. | |
| **/ | | **/ | |
| typedef enum { | | typedef enum { | |
| | | | |
| skipping to change at line 142 | | skipping to change at line 142 | |
| int XLALSimInspiralREAL8WaveTaper( | | int XLALSimInspiralREAL8WaveTaper( | |
| REAL8Vector *signalvec, /**< pointer to wave
form vector */ | | REAL8Vector *signalvec, /**< pointer to wave
form vector */ | |
| LALSimInspiralApplyTaper bookends /**< taper type enum
erator */ | | LALSimInspiralApplyTaper bookends /**< taper type enum
erator */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Computes h(2,2) mode of spherical harmonic decomposition of | | * Computes h(2,2) mode of spherical harmonic decomposition of | |
| * the post-Newtonian inspiral waveform. | | * the post-Newtonian inspiral waveform. | |
| * | | * | |
| * Implements Equation (79) of: | | * Implements Equation (79) of: | |
|
| * Lawrence E. Kidder, "Using Full Information When Computing Modes of | | * Lawrence E. Kidder, \"Using Full Information When Computing Modes of | |
| * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | | * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | |
|
| * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | | * Orbit\", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | |
| */ | | */ | |
| COMPLEX16 XLALSimInspiralPNMode22( | | COMPLEX16 XLALSimInspiralPNMode22( | |
| REAL8 v, /**< post-Newtonian parameter */ | | REAL8 v, /**< post-Newtonian parameter */ | |
| REAL8 phi, /**< orbital phase */ | | REAL8 phi, /**< orbital phase */ | |
| REAL8 v0, /**< tail gauge parameter */ | | REAL8 v0, /**< tail gauge parameter */ | |
| REAL8 m1, /**< mass of companion 1 */ | | REAL8 m1, /**< mass of companion 1 */ | |
| REAL8 m2, /**< mass of companion 2 */ | | REAL8 m2, /**< mass of companion 2 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Computes h(2,1) mode of spherical harmonic decomposition of | | * Computes h(2,1) mode of spherical harmonic decomposition of | |
| * the post-Newtonian inspiral waveform. | | * the post-Newtonian inspiral waveform. | |
| * | | * | |
| * Implements Equation (80) of: | | * Implements Equation (80) of: | |
|
| * Lawrence E. Kidder, "Using Full Information When Computing Modes of | | * Lawrence E. Kidder, \"Using Full Information When Computing Modes of | |
| * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | | * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | |
|
| * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | | * Orbit\", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | |
| */ | | */ | |
| COMPLEX16 XLALSimInspiralPNMode21( | | COMPLEX16 XLALSimInspiralPNMode21( | |
| REAL8 v, /**< post-Newtonian parameter */ | | REAL8 v, /**< post-Newtonian parameter */ | |
| REAL8 phi, /**< orbital phase */ | | REAL8 phi, /**< orbital phase */ | |
| REAL8 v0, /**< tail gauge parameter */ | | REAL8 v0, /**< tail gauge parameter */ | |
| REAL8 m1, /**< mass of companion 1 */ | | REAL8 m1, /**< mass of companion 1 */ | |
| REAL8 m2, /**< mass of companion 2 */ | | REAL8 m2, /**< mass of companion 2 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Computes h(3,3) mode of spherical harmonic decomposition of | | * Computes h(3,3) mode of spherical harmonic decomposition of | |
| * the post-Newtonian inspiral waveform. | | * the post-Newtonian inspiral waveform. | |
| * | | * | |
| * Implements Equation (82) of: | | * Implements Equation (82) of: | |
|
| * Lawrence E. Kidder, "Using Full Information When Computing Modes of | | * Lawrence E. Kidder, \"Using Full Information When Computing Modes of | |
| * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | | * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | |
|
| * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | | * Orbit\", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | |
| */ | | */ | |
| COMPLEX16 XLALSimInspiralPNMode33( | | COMPLEX16 XLALSimInspiralPNMode33( | |
| REAL8 v, /**< post-Newtonian parameter */ | | REAL8 v, /**< post-Newtonian parameter */ | |
| REAL8 phi, /**< orbital phase */ | | REAL8 phi, /**< orbital phase */ | |
| REAL8 v0, /**< tail gauge parameter */ | | REAL8 v0, /**< tail gauge parameter */ | |
| REAL8 m1, /**< mass of companion 1 */ | | REAL8 m1, /**< mass of companion 1 */ | |
| REAL8 m2, /**< mass of companion 2 */ | | REAL8 m2, /**< mass of companion 2 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Computes h(3,2) mode of spherical harmonic decomposition of | | * Computes h(3,2) mode of spherical harmonic decomposition of | |
| * the post-Newtonian inspiral waveform. | | * the post-Newtonian inspiral waveform. | |
| * | | * | |
| * Implements Equation (83) of: | | * Implements Equation (83) of: | |
|
| * Lawrence E. Kidder, "Using Full Information When Computing Modes of | | * Lawrence E. Kidder, \"Using Full Information When Computing Modes of | |
| * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | | * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | |
|
| * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | | * Orbit\", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | |
| */ | | */ | |
| COMPLEX16 XLALSimInspiralPNMode32( | | COMPLEX16 XLALSimInspiralPNMode32( | |
| REAL8 v, /**< post-Newtonian parameter */ | | REAL8 v, /**< post-Newtonian parameter */ | |
| REAL8 phi, /**< orbital phase */ | | REAL8 phi, /**< orbital phase */ | |
| REAL8 v0, /**< tail gauge parameter */ | | REAL8 v0, /**< tail gauge parameter */ | |
| REAL8 m1, /**< mass of companion 1 */ | | REAL8 m1, /**< mass of companion 1 */ | |
| REAL8 m2, /**< mass of companion 2 */ | | REAL8 m2, /**< mass of companion 2 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Computes h(3,1) mode of spherical harmonic decomposition of | | * Computes h(3,1) mode of spherical harmonic decomposition of | |
| * the post-Newtonian inspiral waveform. | | * the post-Newtonian inspiral waveform. | |
| * | | * | |
| * Implements Equation (84) of: | | * Implements Equation (84) of: | |
|
| * Lawrence E. Kidder, "Using Full Information When Computing Modes of | | * Lawrence E. Kidder, \"Using Full Information When Computing Modes of | |
| * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | | * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | |
|
| * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | | * Orbit\", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | |
| */ | | */ | |
| COMPLEX16 XLALSimInspiralPNMode31( | | COMPLEX16 XLALSimInspiralPNMode31( | |
| REAL8 v, /**< post-Newtonian parameter */ | | REAL8 v, /**< post-Newtonian parameter */ | |
| REAL8 phi, /**< orbital phase */ | | REAL8 phi, /**< orbital phase */ | |
| REAL8 v0, /**< tail gauge parameter */ | | REAL8 v0, /**< tail gauge parameter */ | |
| REAL8 m1, /**< mass of companion 1 */ | | REAL8 m1, /**< mass of companion 1 */ | |
| REAL8 m2, /**< mass of companion 2 */ | | REAL8 m2, /**< mass of companion 2 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic | | * Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic | |
| * to obtain hplus - i hcross, which is added to the time series. | | * to obtain hplus - i hcross, which is added to the time series. | |
| * | | * | |
| * Implements the sum of a single term of Eq. (11) of: | | * Implements the sum of a single term of Eq. (11) of: | |
|
| * Lawrence E. Kidder, "Using Full Information When Computing Modes of | | * Lawrence E. Kidder, \"Using Full Information When Computing Modes of | |
| * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | | * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | |
|
| * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | | * Orbit\", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | |
| * | | * | |
| * If sym is non-zero, symmetrically add the m and -m terms assuming | | * If sym is non-zero, symmetrically add the m and -m terms assuming | |
| * that h(l,-m) = (-1)^l h(l,m)*; see Eq. (78) ibid. | | * that h(l,-m) = (-1)^l h(l,m)*; see Eq. (78) ibid. | |
| */ | | */ | |
| int XLALSimAddMode( | | int XLALSimAddMode( | |
| REAL8TimeSeries *hplus, /**< +-polarization waveform */ | | REAL8TimeSeries *hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries *hcross, /**< x-polarization waveform */ | | REAL8TimeSeries *hcross, /**< x-polarization waveform */ | |
| COMPLEX16TimeSeries *hmode, /**< complex mode h(l,m) */ | | COMPLEX16TimeSeries *hmode, /**< complex mode h(l,m) */ | |
| REAL8 theta, /**< polar angle (rad) */ | | REAL8 theta, /**< polar angle (rad) */ | |
| REAL8 phi, /**< azimuthal angle (rad) */ | | REAL8 phi, /**< azimuthal angle (rad) */ | |
| int l, /**< mode number l */ | | int l, /**< mode number l */ | |
| int m, /**< mode number m */ | | int m, /**< mode number m */ | |
| int sym /**< flag to add -m mode too */ | | int sym /**< flag to add -m mode too */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Computes h(l,m) mode timeseries of spherical harmonic decomposition of | | * Computes h(l,m) mode timeseries of spherical harmonic decomposition of | |
| * the post-Newtonian inspiral waveform. | | * the post-Newtonian inspiral waveform. | |
| * | | * | |
| * See Eqns. (79)-(116) of: | | * See Eqns. (79)-(116) of: | |
|
| * Lawrence E. Kidder, "Using Full Information When Computing Modes of | | * Lawrence E. Kidder, \"Using Full Information When Computing Modes of | |
| * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | | * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | |
|
| * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | | * Orbit\", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | |
| */ | | */ | |
| COMPLEX16TimeSeries *XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries( | | COMPLEX16TimeSeries *XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries( | |
| REAL8TimeSeries *v, /**< post-Newtonian parameter */ | | REAL8TimeSeries *v, /**< post-Newtonian parameter */ | |
| REAL8TimeSeries *phi, /**< orbital phase */ | | REAL8TimeSeries *phi, /**< orbital phase */ | |
| REAL8 v0, /**< tail-term gauge choice (default =
1) */ | | REAL8 v0, /**< tail-term gauge choice (default =
1) */ | |
| REAL8 m1, /**< mass of companion 1 */ | | REAL8 m1, /**< mass of companion 1 */ | |
| REAL8 m2, /**< mass of companion 2 */ | | REAL8 m2, /**< mass of companion 2 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| int O, /**< twice post-Newtonain order */ | | int O, /**< twice post-Newtonain order */ | |
| int l, /**< mode number l */ | | int l, /**< mode number l */ | |
| int m /**< mode number m */ | | int m /**< mode number m */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Given time series for a binary's orbital dynamical variables, | | * Given time series for a binary's orbital dynamical variables, | |
| * construct the waveform polarizations h+ and hx as a sum of | | * construct the waveform polarizations h+ and hx as a sum of | |
| * -2 spin-weighted spherical harmonic modes, h_lm. | | * -2 spin-weighted spherical harmonic modes, h_lm. | |
| * NB: Valid only for non-precessing systems! | | * NB: Valid only for non-precessing systems! | |
| * | | * | |
| * Implements Equation (11) of: | | * Implements Equation (11) of: | |
|
| * Lawrence E. Kidder, "Using Full Information When Computing Modes of | | * Lawrence E. Kidder, \"Using Full Information When Computing Modes of | |
| * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | | * Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular | |
|
| * Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | | * Orbit\", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc]. | |
| * | | * | |
|
| * FIXME: change the PN variable from x to v = \sqrt{x} | | * FIXME: change the PN variable from \f$x\f$ to \f$v = \sqrt{x}\f$ | |
| */ | | */ | |
| int XLALSimInspiralPNPolarizationWaveformsFromModes( | | int XLALSimInspiralPNPolarizationWaveformsFromModes( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform [retu
rned] */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform [retu
rned] */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform [retu
rned] */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform [retu
rned] */ | |
| REAL8TimeSeries *v, /**< post-Newtonian parameter */ | | REAL8TimeSeries *v, /**< post-Newtonian parameter */ | |
| REAL8TimeSeries *phi, /**< orbital phase */ | | REAL8TimeSeries *phi, /**< orbital phase */ | |
| REAL8 v0, /**< tail-term gauge choice (defau
lt = 1) */ | | REAL8 v0, /**< tail-term gauge choice (defau
lt = 1) */ | |
| REAL8 m1, /**< mass of companion 1 */ | | REAL8 m1, /**< mass of companion 1 */ | |
| REAL8 m2, /**< mass of companion 2 */ | | REAL8 m2, /**< mass of companion 2 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| | | | |
| skipping to change at line 309 | | skipping to change at line 309 | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Given time series for a binary's orbital dynamical variables, | | * Given time series for a binary's orbital dynamical variables, | |
| * construct the waveform polarizations h+ and hx directly. | | * construct the waveform polarizations h+ and hx directly. | |
| * NB: Valid only for non-precessing binaries! | | * NB: Valid only for non-precessing binaries! | |
| * | | * | |
| * Implements Equations (8.8) - (8.10) of: | | * Implements Equations (8.8) - (8.10) of: | |
| * Luc Blanchet, Guillaume Faye, Bala R. Iyer and Siddhartha Sinha, | | * Luc Blanchet, Guillaume Faye, Bala R. Iyer and Siddhartha Sinha, | |
|
| * "The third post-Newtonian gravitational wave polarisations | | * \"The third post-Newtonian gravitational wave polarisations | |
| * and associated spherical harmonic modes for inspiralling compact binarie
s | | * and associated spherical harmonic modes for inspiralling compact binarie
s | |
|
| * in quasi-circular orbits", Class. Quant. Grav. 25 165003 (2008); | | * in quasi-circular orbits\", Class. Quant. Grav. 25 165003 (2008); | |
| * arXiv:0802.1249 | | * arXiv:0802.1249 | |
| * | | * | |
|
| * Note however, that we do not include the constant "memory" terms | | * Note however, that we do not include the constant \"memory\" terms | |
| */ | | */ | |
| | | | |
| int XLALSimInspiralPNPolarizationWaveforms( | | int XLALSimInspiralPNPolarizationWaveforms( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform [returned] *
/ | | REAL8TimeSeries **hplus, /**< +-polarization waveform [returned] *
/ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform [returned] *
/ | | REAL8TimeSeries **hcross, /**< x-polarization waveform [returned] *
/ | |
| REAL8TimeSeries *V, /**< post-Newtonian (PN) parameter */ | | REAL8TimeSeries *V, /**< post-Newtonian (PN) parameter */ | |
| REAL8TimeSeries *Phi, /**< orbital phase */ | | REAL8TimeSeries *Phi, /**< orbital phase */ | |
| REAL8 v0, /**< tail-term gauge choice (default = 1)
*/ | | REAL8 v0, /**< tail-term gauge choice (default = 1)
*/ | |
| REAL8 m1, /**< mass of companion 1 (kg) */ | | REAL8 m1, /**< mass of companion 1 (kg) */ | |
| REAL8 m2, /**< mass of companion 2 (kg) */ | | REAL8 m2, /**< mass of companion 2 (kg) */ | |
| | | | |
| skipping to change at line 336 | | skipping to change at line 336 | |
| REAL8 i, /**< inclination of source (rad) */ | | REAL8 i, /**< inclination of source (rad) */ | |
| int ampO /**< twice PN order of the amplitude */ | | int ampO /**< twice PN order of the amplitude */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Computes polarizations h+ and hx for a spinning, precessing binary | | * Computes polarizations h+ and hx for a spinning, precessing binary | |
| * when provided time series of all the dynamical quantities. | | * when provided time series of all the dynamical quantities. | |
| * Amplitude can be chosen between 1.5PN and Newtonian orders (inclusive). | | * Amplitude can be chosen between 1.5PN and Newtonian orders (inclusive). | |
| * | | * | |
| * Based on K.G. Arun, Alesssandra Buonanno, Guillaume Faye and Evan Ochsne
r | | * Based on K.G. Arun, Alesssandra Buonanno, Guillaume Faye and Evan Ochsne
r | |
|
| * "Higher-order spin effects in the amplitude and phase of gravitational | | * \"Higher-order spin effects in the amplitude and phase of gravitational | |
| * waveforms emitted by inspiraling compact binaries: Ready-to-use | | * waveforms emitted by inspiraling compact binaries: Ready-to-use | |
|
| * gravitational waveforms", Phys Rev. D 79, 104023 (2009), arXiv:0810.5336 | | * gravitational waveforms\", Phys Rev. D 79, 104023 (2009), arXiv:0810.533
6 | |
| * | | * | |
| * HOWEVER, the formulae have been adapted to use the output of the so-call
ed | | * HOWEVER, the formulae have been adapted to use the output of the so-call
ed | |
|
| * "Frameless" convention for evolving precessing binary dynamics, | | * \"Frameless\" convention for evolving precessing binary dynamics, | |
| * which is not susceptible to hitting coordinate singularities. | | * which is not susceptible to hitting coordinate singularities. | |
| * | | * | |
| * FIXME: Clean up and commit Mathematica NB Showing correctness. Cite here
. | | * FIXME: Clean up and commit Mathematica NB Showing correctness. Cite here
. | |
| * | | * | |
| * NOTE: The vectors MUST be given in the so-called radiation frame where | | * NOTE: The vectors MUST be given in the so-called radiation frame where | |
| * Z is the direction of propagation, X is the principal '+' axis and Y = Z
x X | | * Z is the direction of propagation, X is the principal '+' axis and Y = Z
x X | |
| */ | | */ | |
| int XLALSimInspiralPrecessingPolarizationWaveforms( | | int XLALSimInspiralPrecessingPolarizationWaveforms( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform [returned] */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform [returned] */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform [returned] */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform [returned] */ | |
| | | | |
| skipping to change at line 507 | | skipping to change at line 507 | |
| ); | | ); | |
| | | | |
| /* TaylorT4 functions */ | | /* TaylorT4 functions */ | |
| | | | |
| /** | | /** | |
| * Evolves a post-Newtonian orbit using the Taylor T4 method. | | * Evolves a post-Newtonian orbit using the Taylor T4 method. | |
| * | | * | |
| * See: | | * See: | |
| * Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, | | * Michael Boyle, Duncan A. Brown, Lawrence E. Kidder, Abdul H. Mroue, | |
| * Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsk
y | | * Harald P. Pfeiffer, Mark A. Scheel, Gregory B. Cook, and Saul A. Teukolsk
y | |
|
| * "High-accuracy comparison of numerical relativity simulations with | | * \"High-accuracy comparison of numerical relativity simulations with | |
| * post-Newtonian expansions" | | * post-Newtonian expansions\" | |
| * <a href="http://arxiv.org/abs/0710.0158v2">arXiv:0710.0158v2</a>. | | * <a href="http://arxiv.org/abs/0710.0158v2">arXiv:0710.0158v2</a>. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT4PNEvolveOrbit( | | int XLALSimInspiralTaylorT4PNEvolveOrbit( | |
| REAL8TimeSeries **V, /**< post-Newtonian parameter [return
ed] */ | | REAL8TimeSeries **V, /**< post-Newtonian parameter [return
ed] */ | |
| REAL8TimeSeries **phi, /**< orbital phase [returned] */ | | REAL8TimeSeries **phi, /**< orbital phase [returned] */ | |
| REAL8 phic, /**< coalescence phase */ | | REAL8 phic, /**< coalescence phase */ | |
| REAL8 deltaT, /**< sampling interval */ | | REAL8 deltaT, /**< sampling interval */ | |
| REAL8 m1, /**< mass of companion 1 */ | | REAL8 m1, /**< mass of companion 1 */ | |
| REAL8 m2, /**< mass of companion 2 */ | | REAL8 m2, /**< mass of companion 2 */ | |
| REAL8 f_min, /**< start frequency */ | | REAL8 f_min, /**< start frequency */ | |
| | | | |
| skipping to change at line 913 | | skipping to change at line 913 | |
| int O /**< twice post-Newtonian phase or
der */ | | int O /**< twice post-Newtonian phase or
der */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Functions for generic spinning waveforms. | | * Functions for generic spinning waveforms. | |
| * Reproduce and extend old SpinTaylor(Frameless) and SQTPN waveforms | | * Reproduce and extend old SpinTaylor(Frameless) and SQTPN waveforms | |
| */ | | */ | |
| | | | |
| /** | | /** | |
| * This function evolves the orbital equations for a precessing binary usin
g | | * This function evolves the orbital equations for a precessing binary usin
g | |
|
| * the "TaylorT4" approximant for solving the orbital dynamics | | * the \"TaylorT4\" approximant for solving the orbital dynamics | |
| * (see arXiv:0907.0700 for a review of the various PN approximants). | | * (see arXiv:0907.0700 for a review of the various PN approximants). | |
| * | | * | |
|
| * It returns time series of the "orbital velocity", orbital phase, | | * It returns time series of the \"orbital velocity\", orbital phase, | |
| * and components for both individual spin vectors, the "Newtonian" | | * and components for both individual spin vectors, the \"Newtonian\" | |
| * orbital angular momentum (which defines the instantaneous plane) | | * orbital angular momentum (which defines the instantaneous plane) | |
|
| * and "E1", a basis vector in the instantaneous orbital plane. | | * and \"E1\", a basis vector in the instantaneous orbital plane. | |
| * Note that LNhat and E1 completely specify the instantaneous orbital plan
e. | | * Note that LNhat and E1 completely specify the instantaneous orbital plan
e. | |
| * It also returns the time and phase of the final time step | | * It also returns the time and phase of the final time step | |
| * | | * | |
| * For input, the function takes the two masses, the initial orbital phase, | | * For input, the function takes the two masses, the initial orbital phase, | |
| * Components for S1, S2, LNhat, E1 vectors at starting time, | | * Components for S1, S2, LNhat, E1 vectors at starting time, | |
| * the desired time step size, the starting GW frequency, | | * the desired time step size, the starting GW frequency, | |
| * and PN order at which to evolve the phase, | | * and PN order at which to evolve the phase, | |
| * | | * | |
|
| * NOTE: All vectors are given in the so-called "radiation frame", | | * NOTE: All vectors are given in the so-called \"radiation frame\", | |
| * where the direction of propagation is the z-axis, the principal "+" | | * where the direction of propagation is the z-axis, the principal \"+\" | |
| * polarization axis is the x-axis, and the y-axis is given by the RH rule. | | * polarization axis is the x-axis, and the y-axis is given by the RH rule. | |
| * You must give the initial values in this frame, and the time series of t
he | | * You must give the initial values in this frame, and the time series of t
he | |
| * vector components will also be returned in this frame | | * vector components will also be returned in this frame | |
| */ | | */ | |
| int XLALSimInspiralPNEvolveOrbitSpinTaylorT4( | | int XLALSimInspiralPNEvolveOrbitSpinTaylorT4( | |
| REAL8TimeSeries **V, /**< post-Newtonian parameter [returned]*/ | | REAL8TimeSeries **V, /**< post-Newtonian parameter [returned]*/ | |
| REAL8TimeSeries **Phi, /**< orbital phase [returned]*/ | | REAL8TimeSeries **Phi, /**< orbital phase [returned]*/ | |
| REAL8TimeSeries **S1x, /**< Spin1 vector x component [returned]*/ | | REAL8TimeSeries **S1x, /**< Spin1 vector x component [returned]*/ | |
|
| REAL8TimeSeries **S1y, /**< " " " y component [returned]*/ | | REAL8TimeSeries **S1y, /**< -- y component [returned]*/ | |
| REAL8TimeSeries **S1z, /**< " " " z component [returned]*/ | | REAL8TimeSeries **S1z, /**< -- z component [returned]*/ | |
| REAL8TimeSeries **S2x, /**< Spin2 vector x component [returned]*/ | | REAL8TimeSeries **S2x, /**< Spin2 vector x component [returned]*/ | |
|
| REAL8TimeSeries **S2y, /**< " " " y component [returned]*/ | | REAL8TimeSeries **S2y, /**< -- y component [returned]*/ | |
| REAL8TimeSeries **S2z, /**< " " " z component [returned]*/ | | REAL8TimeSeries **S2z, /**< -- z component [returned]*/ | |
| REAL8TimeSeries **LNhatx, /**< unit orbital ang. mom. x [returned]*/ | | REAL8TimeSeries **LNhatx, /**< unit orbital ang. mom. x [returned]*/ | |
|
| REAL8TimeSeries **LNhaty, /**< " " " y component [returned]*/ | | REAL8TimeSeries **LNhaty, /**< -- y component [returned]*/ | |
| REAL8TimeSeries **LNhatz, /**< " " " z component [returned]*/ | | REAL8TimeSeries **LNhatz, /**< -- z component [returned]*/ | |
| REAL8TimeSeries **E1x, /**< orb. plane basis vector x[returned]*/ | | REAL8TimeSeries **E1x, /**< orb. plane basis vector x[returned]*/ | |
|
| REAL8TimeSeries **E1y, /**< " " " y component [returned]*/ | | REAL8TimeSeries **E1y, /**< -- y component [returned]*/ | |
| REAL8TimeSeries **E1z, /**< " " " z component [returned]*/ | | REAL8TimeSeries **E1z, /**< -- z component [returned]*/ | |
| REAL8 phi_end, /**< orbital phase at last sample */ | | REAL8 phi_end, /**< orbital phase at last sample */ | |
| REAL8 deltaT, /**< sampling interval (s) */ | | REAL8 deltaT, /**< sampling interval (s) */ | |
| REAL8 m1, /**< mass of companion 1 (kg) */ | | REAL8 m1, /**< mass of companion 1 (kg) */ | |
| REAL8 m2, /**< mass of companion 2 (kg) */ | | REAL8 m2, /**< mass of companion 2 (kg) */ | |
| REAL8 fStart, /**< start frequency */ | | REAL8 fStart, /**< start frequency */ | |
| REAL8 s1x, /**< initial value of S1x */ | | REAL8 s1x, /**< initial value of S1x */ | |
| REAL8 s1y, /**< initial value of S1y */ | | REAL8 s1y, /**< initial value of S1y */ | |
| REAL8 s1z, /**< initial value of S1z */ | | REAL8 s1z, /**< initial value of S1z */ | |
| REAL8 s2x, /**< initial value of S2x */ | | REAL8 s2x, /**< initial value of S2x */ | |
| REAL8 s2y, /**< initial value of S2y */ | | REAL8 s2y, /**< initial value of S2y */ | |
| | | | |
| skipping to change at line 974 | | skipping to change at line 974 | |
| REAL8 e1y, /**< initial value of E1y */ | | REAL8 e1y, /**< initial value of E1y */ | |
| REAL8 e1z, /**< initial value of E1z */ | | REAL8 e1z, /**< initial value of E1z */ | |
| REAL8 lambda1, /**< (tidal deformability of mass 1) /
(total mass)^5 (dimensionless) */ | | REAL8 lambda1, /**< (tidal deformability of mass 1) /
(total mass)^5 (dimensionless) */ | |
| REAL8 lambda2, /**< (tidal deformability of mass 2) /
(total mass)^5 (dimensionless) */ | | REAL8 lambda2, /**< (tidal deformability of mass 2) /
(total mass)^5 (dimensionless) */ | |
| LALSimInspiralInteraction interactionFlags, /**< flag to control
spin and tidal effects */ | | LALSimInspiralInteraction interactionFlags, /**< flag to control
spin and tidal effects */ | |
| INT4 phaseO /**< twice post-Newtonian order */ | | INT4 phaseO /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute a precessing post-Newtonian inspiral waveform | | * Driver routine to compute a precessing post-Newtonian inspiral waveform | |
|
| * with phasing computed from energy balance using the so-called "T4" metho
d. | | * with phasing computed from energy balance using the so-called \"T4\" met
hod. | |
| * | | * | |
| * This routine allows the user to specify different pN orders | | * This routine allows the user to specify different pN orders | |
| * for phasing calcuation vs. amplitude calculations. | | * for phasing calcuation vs. amplitude calculations. | |
| */ | | */ | |
| int XLALSimInspiralSpinTaylorT4( | | int XLALSimInspiralSpinTaylorT4( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| REAL8 phi_end, /**< GW phase of final sample (rad
) */ | | REAL8 phi_end, /**< GW phase of final sample (rad
) */ | |
| REAL8 v0, /**< tail gauge term (default = 1)
*/ | | REAL8 v0, /**< tail gauge term (default = 1)
*/ | |
| REAL8 deltaT, /**< sampling interval (s) */ | | REAL8 deltaT, /**< sampling interval (s) */ | |
| | | | |
| skipping to change at line 1010 | | skipping to change at line 1010 | |
| REAL8 e1z, /**< initial value of E1z */ | | REAL8 e1z, /**< initial value of E1z */ | |
| REAL8 lambda1, /**< (tidal deformability of mass
1) / (total mass)^5 (dimensionless) */ | | REAL8 lambda1, /**< (tidal deformability of mass
1) / (total mass)^5 (dimensionless) */ | |
| REAL8 lambda2, /**< (tidal deformability of mass
2) / (total mass)^5 (dimensionless) */ | | REAL8 lambda2, /**< (tidal deformability of mass
2) / (total mass)^5 (dimensionless) */ | |
| LALSimInspiralInteraction interactionFlags, /**< flag to con
trol spin and tidal effects */ | | LALSimInspiralInteraction interactionFlags, /**< flag to con
trol spin and tidal effects */ | |
| int phaseO, /**< twice PN phase order */ | | int phaseO, /**< twice PN phase order */ | |
| int amplitudeO /**< twice PN amplitude order */ | | int amplitudeO /**< twice PN amplitude order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute a precessing post-Newtonian inspiral waveform | | * Driver routine to compute a precessing post-Newtonian inspiral waveform | |
|
| * with phasing computed from energy balance using the so-called "T4" metho
d. | | * with phasing computed from energy balance using the so-called \"T4\" met
hod. | |
| * | | * | |
| * This routine assumes leading-order amplitude dependence (restricted wave
form) | | * This routine assumes leading-order amplitude dependence (restricted wave
form) | |
| * but allows hte user to specify the phase PN order | | * but allows hte user to specify the phase PN order | |
| */ | | */ | |
| int XLALSimInspiralRestrictedSpinTaylorT4( | | int XLALSimInspiralRestrictedSpinTaylorT4( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| REAL8 phi_end, /**< GW phase of final sample (rad
) */ | | REAL8 phi_end, /**< GW phase of final sample (rad
) */ | |
| REAL8 v0, /**< tail gauge term (default = 1)
*/ | | REAL8 v0, /**< tail gauge term (default = 1)
*/ | |
| REAL8 deltaT, /**< sampling interval (s) */ | | REAL8 deltaT, /**< sampling interval (s) */ | |
| | | | |
| skipping to change at line 1046 | | skipping to change at line 1046 | |
| REAL8 e1z, /**< initial value of E1z */ | | REAL8 e1z, /**< initial value of E1z */ | |
| REAL8 lambda1, /**< (tidal deformability of mass
1) / (total mass)^5 (dimensionless) */ | | REAL8 lambda1, /**< (tidal deformability of mass
1) / (total mass)^5 (dimensionless) */ | |
| REAL8 lambda2, /**< (tidal deformability of mass
2) / (total mass)^5 (dimensionless) */ | | REAL8 lambda2, /**< (tidal deformability of mass
2) / (total mass)^5 (dimensionless) */ | |
| LALSimInspiralInteraction interactionFlags, /**< flag to control
spin and tidal effects */ | | LALSimInspiralInteraction interactionFlags, /**< flag to control
spin and tidal effects */ | |
| int phaseO /**< twice PN phase order */ | | int phaseO /**< twice PN phase order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Function to specify the desired orientation of a precessing binary in te
rms | | * Function to specify the desired orientation of a precessing binary in te
rms | |
| * of several angles and then compute the vector components in the so-calle
d | | * of several angles and then compute the vector components in the so-calle
d | |
|
| * "radiation frame" (with the z-axis along the direction of propagation) a
s | | * \"radiation frame\" (with the z-axis along the direction of propagation)
as | |
| * needed for initial conditions for the SpinTaylorT4 waveform routines. | | * needed for initial conditions for the SpinTaylorT4 waveform routines. | |
| * | | * | |
| * Input: | | * Input: | |
| * thetaJN, phiJN are angles describing the desired orientation of the | | * thetaJN, phiJN are angles describing the desired orientation of the | |
| * total angular momentum (J) relative to direction of propagation (N) | | * total angular momentum (J) relative to direction of propagation (N) | |
| * theta1, phi1, theta2, phi2 are angles describing the desired orienta
tion | | * theta1, phi1, theta2, phi2 are angles describing the desired orienta
tion | |
| * of spin 1 and 2 relative to the Newtonian orbital angular momentum (L_N) | | * of spin 1 and 2 relative to the Newtonian orbital angular momentum (L_N) | |
| * m1, m2, f0 are the component masses and initial GW frequency, | | * m1, m2, f0 are the component masses and initial GW frequency, | |
| * they are needed to compute the magnitude of L_N, and thus J | | * they are needed to compute the magnitude of L_N, and thus J | |
| * chi1, chi2 are the dimensionless spin magnitudes ( 0 <= chi1,2 <= 1)
, | | * chi1, chi2 are the dimensionless spin magnitudes ( 0 <= chi1,2 <= 1)
, | |
| * they are needed to compute the magnitude of S1 and S2, and thus J | | * they are needed to compute the magnitude of S1 and S2, and thus J | |
| * | | * | |
| * Output: | | * Output: | |
| * x, y, z components of LNhat (unit vector along orbital angular momen
tum), | | * x, y, z components of LNhat (unit vector along orbital angular momen
tum), | |
| * x, y, z components of E1 (unit vector in the initial orbital plane) | | * x, y, z components of E1 (unit vector in the initial orbital plane) | |
| * x, y, z components S1 and S2 (unit spin vectors times their | | * x, y, z components S1 and S2 (unit spin vectors times their | |
| * dimensionless spin magnitudes - i.e. they have unit magnitude for | | * dimensionless spin magnitudes - i.e. they have unit magnitude for | |
| * extremal BHs and smaller magnitude for slower spins) | | * extremal BHs and smaller magnitude for slower spins) | |
| * | | * | |
|
| * NOTE: Here the "total" angular momentum is computed as | | * NOTE: Here the \"total\" angular momentum is computed as | |
| * J = L_N + S1 + S2 | | * J = L_N + S1 + S2 | |
| * where L_N is the Newtonian orbital angular momentum. In fact, there are | | * where L_N is the Newtonian orbital angular momentum. In fact, there are | |
| * PN corrections to L which contribute to J that are NOT ACCOUNTED FOR | | * PN corrections to L which contribute to J that are NOT ACCOUNTED FOR | |
| * in this function. This is done so the function does not need to know abo
ut | | * in this function. This is done so the function does not need to know abo
ut | |
| * the PN order of the system and to avoid subtleties with spin-orbit | | * the PN order of the system and to avoid subtleties with spin-orbit | |
| * contributions to L. Also, it is believed that the difference in Jhat | | * contributions to L. Also, it is believed that the difference in Jhat | |
| * with or without these PN corrections to L is quite small. | | * with or without these PN corrections to L is quite small. | |
| */ | | */ | |
| int XLALSimInspiralTransformPrecessingInitialConditions( | | int XLALSimInspiralTransformPrecessingInitialConditions( | |
| REAL8 *LNhatx, /**< LNhat x component (returned) */ | | REAL8 *LNhatx, /**< LNhat x component (returned) */ | |
| | | | |
| skipping to change at line 1117 | | skipping to change at line 1117 | |
| * | | * | |
| * A note from Evan Ochsner on differences with respect to TaylorF2: | | * A note from Evan Ochsner on differences with respect to TaylorF2: | |
| * | | * | |
| * The amplitude-corrected SPA/F2 waveforms are derived and explicitly give
n in | | * The amplitude-corrected SPA/F2 waveforms are derived and explicitly give
n in | |
| * <http://arxiv.org/abs/gr-qc/0607092> Sec. II and Appendix A (non-spinnin
g) | | * <http://arxiv.org/abs/gr-qc/0607092> Sec. II and Appendix A (non-spinnin
g) | |
| * and <http://arxiv.org/abs/0810.5336> Sec. VI and Appendix D (spin-aligne
d). | | * and <http://arxiv.org/abs/0810.5336> Sec. VI and Appendix D (spin-aligne
d). | |
| * | | * | |
| * The difference between F2 and F2ReducedSpin is that F2ReducedSpin always | | * The difference between F2 and F2ReducedSpin is that F2ReducedSpin always | |
| * keeps only the leading-order TD amplitude multiplying the 2nd harmonic ( | | * keeps only the leading-order TD amplitude multiplying the 2nd harmonic ( | |
| * A_(2,0)(t) in Eq. 2.3 of the first paper OR alpha/beta_2^(0)(t) in Eq. 6
.7 | | * A_(2,0)(t) in Eq. 2.3 of the first paper OR alpha/beta_2^(0)(t) in Eq. 6
.7 | |
|
| * of the second paper) but expands out the 1/\sqrt{\dot{F}} ( Eq. 5.3 OR E
q. | | * of the second paper) but expands out the \f$1/\sqrt{\dot{F}}\f$ ( Eq. 5.
3 OR Eq. | |
| * 6.10-6.11 resp.) to whichever order is given as 'ampO' in the code. | | * 6.10-6.11 resp.) to whichever order is given as 'ampO' in the code. | |
| * | | * | |
| * On the other hand, the F2 model in the papers above will PN expand BOTH
the | | * On the other hand, the F2 model in the papers above will PN expand BOTH
the | |
|
| * TD amplitude and the factor 1/\sqrt{\dot{F}}, take their product, and ke
ep | | * TD amplitude and the factor \f$1/\sqrt{\dot{F}}\f$, take their product,
and keep | |
| * all terms up to the desired amplitude order, as in Eq. 6.13-6.14 of the | | * all terms up to the desired amplitude order, as in Eq. 6.13-6.14 of the | |
| * second paper. | | * second paper. | |
| * | | * | |
| * In particular, the F2ReducedSpin will always have only the 2nd harmonic,
but | | * In particular, the F2ReducedSpin will always have only the 2nd harmonic,
but | |
| * F2 will have multiple harmonics starting at ampO = 0.5PN. Even if you we
re | | * F2 will have multiple harmonics starting at ampO = 0.5PN. Even if you we
re | |
| * to compare just the 2nd harmonic, you would have a difference starting a
t | | * to compare just the 2nd harmonic, you would have a difference starting a
t | |
| * 1PN ampO, because the F2 has a 1PN TD amp. correction to the 2nd harmoni
c | | * 1PN ampO, because the F2 has a 1PN TD amp. correction to the 2nd harmoni
c | |
| * (alpha/beta_2^(2)(t)) which will not be accounted for by the F2ReducedSp
in. | | * (alpha/beta_2^(2)(t)) which will not be accounted for by the F2ReducedSp
in. | |
| * So, the two should agree when ampO=0, but will be different in any other | | * So, the two should agree when ampO=0, but will be different in any other | |
| * case. | | * case. | |
| | | | |
| skipping to change at line 1147 | | skipping to change at line 1147 | |
| const REAL8 m1_SI, /**< mass of companion 1 (k
g) */ | | const REAL8 m1_SI, /**< mass of companion 1 (k
g) */ | |
| const REAL8 m2_SI, /**< mass of companion 2 (k
g) */ | | const REAL8 m2_SI, /**< mass of companion 2 (k
g) */ | |
| const REAL8 chi, /**< dimensionless aligned-
spin param */ | | const REAL8 chi, /**< dimensionless aligned-
spin param */ | |
| const REAL8 fStart, /**< start GW frequency (Hz
) */ | | const REAL8 fStart, /**< start GW frequency (Hz
) */ | |
| const REAL8 r, /**< distance of source (m)
*/ | | const REAL8 r, /**< distance of source (m)
*/ | |
| const UINT4 phaseO, /**< twice PN phase order *
/ | | const UINT4 phaseO, /**< twice PN phase order *
/ | |
| const UINT4 ampO /**< twice PN amplitude ord
er */ | | const UINT4 ampO /**< twice PN amplitude ord
er */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
|
| * Generate the "reduced-spin templates" proposed in http://arxiv.org/abs/1
107.1267 | | * Generate the \"reduced-spin templates\" proposed in http://arxiv.org/abs
/1107.1267 | |
| * Add the tidal phase terms from http://arxiv.org/abs/1101.1673 (Eqs. 3.9,
3.10) | | * Add the tidal phase terms from http://arxiv.org/abs/1101.1673 (Eqs. 3.9,
3.10) | |
| * The chi parameter should be determined from XLALSimInspiralTaylorF2Reduc
edSpinComputeChi. | | * The chi parameter should be determined from XLALSimInspiralTaylorF2Reduc
edSpinComputeChi. | |
| */ | | */ | |
| int XLALSimInspiralTaylorF2ReducedSpinTidal( | | int XLALSimInspiralTaylorF2ReducedSpinTidal( | |
| COMPLEX16FrequencySeries **htilde, /**< FD waveform */ | | COMPLEX16FrequencySeries **htilde, /**< FD waveform */ | |
| const REAL8 phiStart, /**< initial GW phase (rad)
*/ | | const REAL8 phiStart, /**< initial GW phase (rad)
*/ | |
| const REAL8 deltaF, /**< frequency resolution *
/ | | const REAL8 deltaF, /**< frequency resolution *
/ | |
| const REAL8 m1_SI, /**< mass of companion 1 (k
g) */ | | const REAL8 m1_SI, /**< mass of companion 1 (k
g) */ | |
| const REAL8 m2_SI, /**< mass of companion 2 (k
g) */ | | const REAL8 m2_SI, /**< mass of companion 2 (k
g) */ | |
| const REAL8 chi, /**< dimensionless aligned-
spin param */ | | const REAL8 chi, /**< dimensionless aligned-
spin param */ | |
| const REAL8 lam1, /**< dimensionless deformab
ility of 1 */ | | const REAL8 lam1, /**< dimensionless deformab
ility of 1 */ | |
| const REAL8 lam2, /**< dimensionless deformab
ility of 2 */ | | const REAL8 lam2, /**< dimensionless deformab
ility of 2 */ | |
| const REAL8 fStart, /**< start GW frequency (Hz
) */ | | const REAL8 fStart, /**< start GW frequency (Hz
) */ | |
| const REAL8 r, /**< distance of source (m)
*/ | | const REAL8 r, /**< distance of source (m)
*/ | |
| const UINT4 phaseO, /**< twice PN phase order *
/ | | const UINT4 phaseO, /**< twice PN phase order *
/ | |
| const UINT4 ampO /**< twice PN amplitude ord
er */ | | const UINT4 ampO /**< twice PN amplitude ord
er */ | |
| ); | | ); | |
| /** | | /** | |
|
| * Compute the chirp time of the "reduced-spin" templates, described in | | * Compute the chirp time of the \"reduced-spin\" templates, described in | |
| * http://arxiv.org/abs/1107.1267. | | * http://arxiv.org/abs/1107.1267. | |
| */ | | */ | |
| REAL8 XLALSimInspiralTaylorF2ReducedSpinChirpTime( | | REAL8 XLALSimInspiralTaylorF2ReducedSpinChirpTime( | |
| const REAL8 fStart, /**< start GW frequency (Hz) */ | | const REAL8 fStart, /**< start GW frequency (Hz) */ | |
| const REAL8 m1_SI, /**< mass of companion 1 (kg) */ | | const REAL8 m1_SI, /**< mass of companion 1 (kg) */ | |
| const REAL8 m2_SI, /**< mass of companion 2 (kg) */ | | const REAL8 m2_SI, /**< mass of companion 2 (kg) */ | |
| const REAL8 chi, /**< dimensionless aligned-spin param *
/ | | const REAL8 chi, /**< dimensionless aligned-spin param *
/ | |
| const UINT4 O /**< twice PN phase order */ | | const UINT4 O /**< twice PN phase order */ | |
| ); | | ); | |
| | | | |
| | | | |
| skipping to change at line 1190 | | skipping to change at line 1190 | |
| * Reference: http://arxiv.org/abs/1107.1267, paragraph 3. | | * Reference: http://arxiv.org/abs/1107.1267, paragraph 3. | |
| */ | | */ | |
| REAL8 XLALSimInspiralTaylorF2ReducedSpinComputeChi( | | REAL8 XLALSimInspiralTaylorF2ReducedSpinComputeChi( | |
| const REAL8 m1, /**< mass of companion 1 */ | | const REAL8 m1, /**< mass of companion 1 */ | |
| const REAL8 m2, /**< mass of companion 2 */ | | const REAL8 m2, /**< mass of companion 2 */ | |
| const REAL8 s1z, /**< dimensionless spin of com
panion 1 */ | | const REAL8 s1z, /**< dimensionless spin of com
panion 1 */ | |
| const REAL8 s2z /**< dimensionless spin of com
panion 2 */ | | const REAL8 s2z /**< dimensionless spin of com
panion 2 */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
|
| * Compute the template-space metric of "reduced-spin" PN templates in | | * Compute the template-space metric of \"reduced-spin\" PN templates in | |
| * Mchirp-eta-chi parameter space. | | * Mchirp-eta-chi parameter space. | |
| */ | | */ | |
| int XLALSimInspiralTaylorF2RedSpinMetricMChirpEtaChi( | | int XLALSimInspiralTaylorF2RedSpinMetricMChirpEtaChi( | |
| REAL8 *gamma00, /**< template metric coeff. 00 in mChirp-eta-chi */ | | REAL8 *gamma00, /**< template metric coeff. 00 in mChirp-eta-chi */ | |
| REAL8 *gamma01, /**< template metric coeff. 01/10 in mChirp-eta-chi */ | | REAL8 *gamma01, /**< template metric coeff. 01/10 in mChirp-eta-chi */ | |
| REAL8 *gamma02, /**< template metric coeff. 02/20 in mChirp-eta-chi */ | | REAL8 *gamma02, /**< template metric coeff. 02/20 in mChirp-eta-chi */ | |
| REAL8 *gamma11, /**< template metric coeff. 11 in mChirp-eta-chi */ | | REAL8 *gamma11, /**< template metric coeff. 11 in mChirp-eta-chi */ | |
| REAL8 *gamma12, /**< template metric coeff. 12/21 in mChirp-eta-chi */ | | REAL8 *gamma12, /**< template metric coeff. 12/21 in mChirp-eta-chi */ | |
| REAL8 *gamma22, /**< template metric coeff. 22 in mChirp-eta-chi */ | | REAL8 *gamma22, /**< template metric coeff. 22 in mChirp-eta-chi */ | |
| const REAL8 mc, /**< chirp mass (in solar mass) */ | | const REAL8 mc, /**< chirp mass (in solar mass) */ | |
| | | | |
End of changes. 44 change blocks. |
| 62 lines changed or deleted | | 62 lines changed or added | |
|