| LALSimInspiral.h | | LALSimInspiral.h | |
| | | | |
| skipping to change at line 37 | | skipping to change at line 37 | |
| | | | |
| #include <lal/LALDatatypes.h> | | #include <lal/LALDatatypes.h> | |
| #include <lal/LALSimIMR.h> | | #include <lal/LALSimIMR.h> | |
| | | | |
| #if defined(__cplusplus) | | #if defined(__cplusplus) | |
| extern "C" { | | extern "C" { | |
| #elif 0 | | #elif 0 | |
| } /* so that editors will match preceding brace */ | | } /* so that editors will match preceding brace */ | |
| #endif | | #endif | |
| | | | |
|
| NRCSID(LALSIMINSPIRALH, "$Id$"); | | | |
| | | | |
| #define LAL_PN_MODE_L_MAX 3 | | #define LAL_PN_MODE_L_MAX 3 | |
| | | | |
| /** Enum that specifies the PN approximant to be used in computing the wave
form. | | /** Enum that specifies the PN approximant to be used in computing the wave
form. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| TaylorT1, /**< Time domain Taylor approximant in which the ene
rgy and flux are both kept | | TaylorT1, /**< Time domain Taylor approximant in which the ene
rgy and flux are both kept | |
| * as Taylor expansions and a first order ordinary
differential equation is solved | | * as Taylor expansions and a first order ordinary
differential equation is solved | |
| * or the GW phase as a function of \f$t\f$; Output
s a time-domain wave. | | * or the GW phase as a function of \f$t\f$; Output
s a time-domain wave. | |
| */ | | */ | |
| TaylorT2, /**< Time domain Taylor approximant in which the pha
se evolution \f$\varphi(t)\f$ is | | TaylorT2, /**< Time domain Taylor approximant in which the pha
se evolution \f$\varphi(t)\f$ is | |
| | | | |
| skipping to change at line 67 | | skipping to change at line 65 | |
| * 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
pins, defined in terms of a single (reduced-spin) parameter [\ref Ajith:201
1ec]*/ | | TaylorF2RedSpin, /**< TaylorF2 waveforms for non-precessing s
pins, defined in terms of a single (reduced-spin) parameter [\ref Ajith:201
1ec]*/ | |
| TaylorF2RedSpinTidal, /**< TaylorF2 waveforms for non-prec
essing spins, defined in terms of a single (reduced-spin) parameter [\ref A
jith:2011ec] plus tidal terms (http://arxiv.org/abs/1101.1673) */ | | TaylorF2RedSpinTidal, /**< TaylorF2 waveforms for non-prec
essing spins, defined in terms of a single (reduced-spin) parameter [\ref A
jith: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) */ | |
| 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. */ | |
| PhenSpinTaylorRDF, /**< UNDOCUMENTED */ | | PhenSpinTaylorRDF, /**< UNDOCUMENTED */ | |
| SpinQuadTaylor, /**< Spinning case PN models with quadrupole-monopol
e and self-spin interaction. */ | | SpinQuadTaylor, /**< Spinning case PN models with quadrupole-monopol
e and self-spin interaction. */ | |
| 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, | |
| EOBNRv2HM, | | EOBNRv2HM, | |
|
| | | 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
l-merger-ringdown templates of Ajith et al [\ref Ajith:2007kx] with phenome
nological coefficients defined in the Table I of [\ref Ajith:2007xh]*/ | | IMRPhenomFA, /**< Frequency domain (non-spinning) inspira
l-merger-ringdown templates of Ajith et al [\ref Ajith:2007kx] with phenome
nological coefficients defined in the Table I of [\ref Ajith:2007xh]*/ | |
| IMRPhenomFB, /**< Frequency domain (non-precessing spins)
inspiral-merger-ringdown templates of Ajith et al [\ref Ajith:2009bn] */ | | IMRPhenomFB, /**< Frequency domain (non-precessing spins)
inspiral-merger-ringdown templates of Ajith et al [\ref 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 { | |
| LAL_SIM_INSPIRAL_INTERACTION_NONE = 0, /**< No spin, tidal or other
interactions */ | | LAL_SIM_INSPIRAL_INTERACTION_NONE = 0, /**< No spin, tidal or other
interactions */ | |
| LAL_SIM_INSPIRAL_INTERACTION_SPIN_ORBIT_15PN = 1, /**< Leading order
spin-orbit interaction */ | | LAL_SIM_INSPIRAL_INTERACTION_SPIN_ORBIT_15PN = 1, /**< Leading order
spin-orbit interaction */ | |
| LAL_SIM_INSPIRAL_INTERACTION_SPIN_SPIN_2PN = 1 << 1, /**< Spin-spin
interaction */ | | LAL_SIM_INSPIRAL_INTERACTION_SPIN_SPIN_2PN = 1 << 1, /**< Spin-spin
interaction */ | |
| LAL_SIM_INSPIRAL_INTERACTION_SPIN_SPIN_SELF_2PN = 1 << 2, /**<
Spin-spin-self interaction */ | | LAL_SIM_INSPIRAL_INTERACTION_SPIN_SPIN_SELF_2PN = 1 << 2, /**<
Spin-spin-self interaction */ | |
| LAL_SIM_INSPIRAL_INTERACTION_QUAD_MONO_2PN = 1 << 3, /**< Quadru
pole-monopole interaction */ | | LAL_SIM_INSPIRAL_INTERACTION_QUAD_MONO_2PN = 1 << 3, /**< Quadru
pole-monopole interaction */ | |
| LAL_SIM_INSPIRAL_INTERACTION_SPIN_ORBIT_25PN = 1 << 4, /**< Nex
t-to-leading-order spin-orbit interaction */ | | LAL_SIM_INSPIRAL_INTERACTION_SPIN_ORBIT_25PN = 1 << 4, /**< Nex
t-to-leading-order spin-orbit interaction */ | |
|
| LAL_SIM_INSPIRAL_INTERACTION_TIDAL_5PN = 1 << 5, /**< Leading-order | | LAL_SIM_INSPIRAL_INTERACTION_SPIN_ORBIT_3PN = 1 << 5, /**< Spin-spi | |
| tidal interaction */ | | n interaction */ | |
| LAL_SIM_INSPIRAL_INTERACTION_TIDAL_6PN = 1 << 6, /**< Next-to-leadin | | LAL_SIM_INSPIRAL_INTERACTION_TIDAL_5PN = 1 << 6, /**< Leading-order | |
| g-order tidal interaction */ | | tidal interaction */ | |
| | | LAL_SIM_INSPIRAL_INTERACTION_TIDAL_6PN = 1 << 7, /**< Next-to-leadin | |
| LAL_SIM_INSPIRAL_INTERACTION_ALL_SPIN = (1 << 5) - 1, /**< all spin | | g-order tidal interaction */ | |
| interactions, no tidal interactions */ | | LAL_SIM_INSPIRAL_INTERACTION_ALL_SPIN = (1 << 6) - 1, /**< all spin | |
| LAL_SIM_INSPIRAL_INTERACTION_ALL = (1 << 7) - 1 /**< all spin and ti | | interactions, no tidal interactions */ | |
| dal interactions */ | | LAL_SIM_INSPIRAL_INTERACTION_ALL = (1 << 8) - 1 /**< all spin and ti | |
| | | dal interactions */ | |
| } LALSimInspiralInteraction; | | } LALSimInspiralInteraction; | |
| | | | |
|
| | | /** Enumeration to specify the tapering method to apply to the waveform */ | |
| | | typedef enum | |
| | | { | |
| | | LAL_SIM_INSPIRAL_TAPER_NONE, /**< No tapering */ | |
| | | LAL_SIM_INSPIRAL_TAPER_START, /**< Taper the start of the | |
| | | waveform */ | |
| | | LAL_SIM_INSPIRAL_TAPER_END, /**< Taper the end of the waveform * | |
| | | / | |
| | | LAL_SIM_INSPIRAL_TAPER_STARTEND, /**< Taper the start and the end of | |
| | | the waveform */ | |
| | | LAL_SIM_INSPIRAL_TAPER_NUM_OPTS /**< UNDOCUMENTED */ | |
| | | } LALSimInspiralApplyTaper; | |
| | | | |
| | | /** | |
| | | * Tapers a REAL4 inspiral waveform in the time domain. | |
| | | */ | |
| | | int XLALSimInspiralREAL4WaveTaper( | |
| | | REAL4Vector *signalvec, /**< pointer to wave | |
| | | form vector */ | |
| | | LALSimInspiralApplyTaper bookends /**< taper type enum | |
| | | erator */ | |
| | | ); | |
| | | | |
| | | /** | |
| | | * Tapers a REAL8 inspiral waveform in the time domain. | |
| | | */ | |
| | | int XLALSimInspiralREAL8WaveTaper( | |
| | | REAL8Vector *signalvec, /**< pointer to wave | |
| | | form vector */ | |
| | | 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( | |
| | | | |
| skipping to change at line 241 | | skipping to change at line 267 | |
| * 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 (if you do
n't know, just set it to one) */ | | 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, | |
| | | | |
| skipping to change at line 268 | | skipping to change at line 294 | |
| * 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 x to v = \sqrt{x} | |
| */ | | */ | |
| 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 (if yo
u don't know, just set it to one) */ | | 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 */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| 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. | |
| | | | |
| skipping to change at line 296 | | skipping to change at line 322 | |
| * 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 x0, /**< 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) */ | |
| REAL8 r, /**< distance of source (m) */ | | REAL8 r, /**< distance of source (m) */ | |
| 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. | |
| | | | |
| skipping to change at line 343 | | skipping to change at line 369 | |
| REAL8TimeSeries *S2z, /**< Spin2 vector z component */ | | REAL8TimeSeries *S2z, /**< Spin2 vector z component */ | |
| REAL8TimeSeries *LNhatx, /**< unit orbital ang. mom. x comp. */ | | REAL8TimeSeries *LNhatx, /**< unit orbital ang. mom. x comp. */ | |
| REAL8TimeSeries *LNhaty, /**< unit orbital ang. mom. y comp. */ | | REAL8TimeSeries *LNhaty, /**< unit orbital ang. mom. y comp. */ | |
| REAL8TimeSeries *LNhatz, /**< unit orbital ang. mom. z comp. */ | | REAL8TimeSeries *LNhatz, /**< unit orbital ang. mom. z comp. */ | |
| REAL8TimeSeries *E1x, /**< orbital plane basis vector x comp. */ | | REAL8TimeSeries *E1x, /**< orbital plane basis vector x comp. */ | |
| REAL8TimeSeries *E1y, /**< orbital plane basis vector y comp. */ | | REAL8TimeSeries *E1y, /**< orbital plane basis vector y comp. */ | |
| REAL8TimeSeries *E1z, /**< orbital plane basis vector z comp. */ | | REAL8TimeSeries *E1z, /**< orbital plane basis vector z comp. */ | |
| 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 r, /**< distance of source (m) */ | | REAL8 r, /**< distance of source (m) */ | |
|
| REAL8 v0, /**< tail-term gauge choice (default = 0)
*/ | | REAL8 v0, /**< tail-term gauge choice (default = 1)
*/ | |
| INT4 ampO /**< twice amp. post-Newtonian order */ | | INT4 ampO /**< twice amp. post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Compute the length of an inspiral waveform assuming the Taylor dEnergy a
nd Flux equations | | * Compute the length of an inspiral waveform assuming the Taylor dEnergy a
nd Flux equations | |
| */ | | */ | |
| REAL8 | | REAL8 | |
| XLALSimInspiralTaylorLength( | | XLALSimInspiralTaylorLength( | |
| 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 */ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /* Waveform switching functions */ | | /* Waveform switching functions */ | |
| | | | |
| /** | | /** | |
|
| * Chooses between different approximants when requesting a waveform to be | | * Checks whether the given approximant is implemented in lalsimulation's X | |
| generated. | | LALSimInspiralChooseTDWaveform(). | |
| | | * | |
| | | * returns 1 if the approximant is implemented, 0 otherwise. | |
| | | */ | |
| | | int XLALSimInspiralImplementedTDApproximants( | |
| | | Approximant approximant /**< post-Newtonian approximant for use in wave | |
| | | form production */ | |
| | | ); | |
| | | | |
| | | /** | |
| | | * Checks whether the given approximant is implemented in lalsimulation's X | |
| | | LALSimInspiralChooseFDWaveform(). | |
| | | * | |
| | | * returns 1 if the approximant is implemented, 0 otherwise. | |
| | | */ | |
| | | int XLALSimInspiralImplementedFDApproximants( | |
| | | Approximant approximant /**< post-Newtonian approximant for use in wave | |
| | | form production */ | |
| | | ); | |
| | | | |
| | | /** | |
| | | * DEPRECATED: USE XLALSimInspiralChooseTDWaveform() INSTEAD | |
| | | * | |
| | | * Chooses between different approximants when requesting a waveform to be | |
| | | generated | |
| | | * For spinning waveforms, all known spin effects up to given PN order are | |
| | | included | |
| * | | * | |
| * The parameters passed must be in SI units. | | * The parameters passed must be in SI units. | |
|
| * The phi0 is the phase at a reference time. FIXME: this should be made co
nsistent across waveforms. | | | |
| */ | | */ | |
| int XLALSimInspiralChooseWaveform( | | int XLALSimInspiralChooseWaveform( | |
|
| | | REAL8TimeSeries **hplus, /**< +-polarization wavefor | |
| | | m */ | |
| | | REAL8TimeSeries **hcross, /**< x-polarization wavefor | |
| | | m */ | |
| | | REAL8 phi0, /**< peak phase */ | |
| | | REAL8 deltaT, /**< sampling interval */ | |
| | | REAL8 m1, /**< mass of companion 1 */ | |
| | | REAL8 m2, /**< mass of companion 2 */ | |
| | | REAL8 S1x, /**< x-component of the dim | |
| | | ensionless spin of object 1 */ | |
| | | REAL8 S1y, /**< y-component of the dim | |
| | | ensionless spin of object 1 */ | |
| | | REAL8 S1z, /**< z-component of the dim | |
| | | ensionless spin of object 1 */ | |
| | | REAL8 S2x, /**< x-component of the dim | |
| | | ensionless spin of object 2 */ | |
| | | REAL8 S2y, /**< y-component of the dim | |
| | | ensionless spin of object 2 */ | |
| | | REAL8 S2z, /**< z-component of the dim | |
| | | ensionless spin of object 2 */ | |
| | | REAL8 f_min, /**< start frequency */ | |
| | | REAL8 r, /**< distance of source */ | |
| | | REAL8 i, /**< inclination of source | |
| | | (rad) */ | |
| | | REAL8 lambda1, /**< (tidal deformability o | |
| | | f mass 1) / (total mass)^5 (dimensionless) */ | |
| | | REAL8 lambda2, /**< (tidal deformability o | |
| | | f mass 2) / (total mass)^5 (dimensionless) */ | |
| | | LALSimInspiralInteraction interactionFlags, /**< flag to control spin a | |
| | | nd tidal effects */ | |
| | | int amplitudeO, /**< twice post-Newtonian a | |
| | | mplitude order */ | |
| | | int phaseO, /**< twice post-Newtonian o | |
| | | rder */ | |
| | | Approximant approximant /**< post-Newtonian approxi | |
| | | mant to use for waveform production */ | |
| | | ); | |
| | | | |
| | | /** | |
| | | * Chooses between different approximants when requesting a waveform to be | |
| | | generated | |
| | | * For spinning waveforms, all known spin effects up to given PN order are | |
| | | included | |
| | | * Returns the waveform in the time domain. | |
| | | * | |
| | | * The parameters passed must be in SI units. | |
| | | */ | |
| | | int XLALSimInspiralChooseTDWaveform( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| REAL8 phi0, /**< reference phase */ | | REAL8 phi0, /**< reference 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 s1x, /**< x-component of the dimensionless spin
of object 1 */ | | REAL8 s1x, /**< x-component of the dimensionless spin
of object 1 */ | |
| REAL8 s1y, /**< y-component of the dimensionless spin
of object 1 */ | | REAL8 s1y, /**< y-component of the dimensionless spin
of object 1 */ | |
| REAL8 s1z, /**< z-component of the dimensionless spin
of object 1 */ | | REAL8 s1z, /**< z-component of the dimensionless spin
of object 1 */ | |
| REAL8 s2x, /**< x-component of the dimensionless spin
of object 2 */ | | REAL8 s2x, /**< x-component of the dimensionless spin
of object 2 */ | |
| REAL8 s2y, /**< y-component of the dimensionless spin
of object 2 */ | | REAL8 s2y, /**< y-component of the dimensionless spin
of object 2 */ | |
| REAL8 s2z, /**< z-component of the dimensionless spin
of object 2 */ | | REAL8 s2z, /**< z-component of the dimensionless spin
of object 2 */ | |
| REAL8 f_min, /**< start frequency */ | | REAL8 f_min, /**< start frequency */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) */ | | REAL8 i, /**< inclination of source (rad) */ | |
|
| | | REAL8 lambda1, /**< (tidal deformability of mass 1) / (tot | |
| | | al mass)^5 (dimensionless) */ | |
| | | REAL8 lambda2, /**< (tidal deformability of mass 2) / (tot | |
| | | al mass)^5 (dimensionless) */ | |
| | | LALSimInspiralInteraction interactionFlags, /**< flag to control spin a | |
| | | nd tidal effects */ | |
| int amplitudeO, /**< twice post-Newtonian amplitude order *
/ | | int amplitudeO, /**< twice post-Newtonian amplitude order *
/ | |
| int phaseO, /**< twice post-Newtonian phase order */ | | int phaseO, /**< twice post-Newtonian phase order */ | |
| Approximant approximant /**< post-Newtonian approximant to use for
waveform production */ | | Approximant approximant /**< post-Newtonian approximant to use for
waveform production */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Chooses between different approximants when requesting a waveform to be
generated | | * Chooses between different approximants when requesting a waveform to be
generated | |
|
| * with Newtonian-only amplitude | | * For spinning waveforms, all known spin effects up to given PN order are | |
| | | included | |
| | | * Returns the waveform in the frequency domain. | |
| | | * | |
| | | * The parameters passed must be in SI units. | |
| */ | | */ | |
|
| int XLALSimInspiralChooseRestrictedWaveform( | | int XLALSimInspiralChooseFDWaveform( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | COMPLEX16FrequencySeries **htilde, /**< FD waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8 phi0, /**< peak phase */ | |
| REAL8 phi0, /**< reference phase */ | | REAL8 deltaF, /**< 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 S1x, /**< x-component of the dim | |
| REAL8 s1x, /**< x-component of the dimensionless spin | | ensionless spin of object 1 */ | |
| of object 1 */ | | REAL8 S1y, /**< y-component of the dim | |
| REAL8 s1y, /**< y-component of the dimensionless spin | | ensionless spin of object 1 */ | |
| of object 1 */ | | REAL8 S1z, /**< z-component of the dim | |
| REAL8 s1z, /**< z-component of the dimensionless spin | | ensionless spin of object 1 */ | |
| of object 1 */ | | REAL8 S2x, /**< x-component of the dim | |
| REAL8 s2x, /**< x-component of the dimensionless spin | | ensionless spin of object 2 */ | |
| of object 2 */ | | REAL8 S2y, /**< y-component of the dim | |
| REAL8 s2y, /**< y-component of the dimensionless spin | | ensionless spin of object 2 */ | |
| of object 2 */ | | REAL8 S2z, /**< z-component of the dim | |
| REAL8 s2z, /**< z-component of the dimensionless spin | | ensionless spin of object 2 */ | |
| of object 2 */ | | REAL8 f_min, /**< start frequency */ | |
| REAL8 f_min, /**< start frequency */ | | REAL8 f_max, /**< end frequency */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) */ | | REAL8 i, /**< inclination of source | |
| int O, /**< twice post-Newtonian order */ | | (rad) */ | |
| Approximant approximant /**< post-Newtonian approximant to use for | | REAL8 lambda1, /**< (tidal deformability o | |
| waveform production */ | | f mass 1) / (total mass)^5 (dimensionless) */ | |
| | | REAL8 lambda2, /**< (tidal deformability o | |
| | | f mass 2) / (total mass)^5 (dimensionless) */ | |
| | | LALSimInspiralInteraction interactionFlags, /**< flag to control spin a | |
| | | nd tidal effects */ | |
| | | int amplitudeO, /**< twice post-Newtonian a | |
| | | mplitude order */ | |
| | | int phaseO, /**< twice post-Newtonian o | |
| | | rder */ | |
| | | Approximant approximant /**< post-Newtonian approxi | |
| | | mant to use for waveform production */ | |
| ); | | ); | |
| | | | |
| /* 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 | |
| | | | |
| skipping to change at line 445 | | skipping to change at line 532 | |
| /** | | /** | |
| * Driver routine to compute the post-Newtonian inspiral waveform. | | * Driver routine to compute the post-Newtonian inspiral waveform. | |
| * | | * | |
| * 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 XLALSimInspiralTaylorT4PNGenerator( | | int XLALSimInspiralTaylorT4PNGenerator( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| REAL8 phic, /**< coalescence phase */ | | REAL8 phic, /**< coalescence phase */ | |
|
| REAL8 x0, /**< tail-term gauge choice thing
(if you don't know, just set it to zero) */ | | REAL8 v0, /**< tail-term gauge choice (defau
lt = 1) */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| int amplitudeO, /**< twice post-Newtonian amplitud
e order */ | | int amplitudeO, /**< twice post-Newtonian amplitud
e order */ | |
| int phaseO /**< twice post-Newtonian phase or
der */ | | int phaseO /**< twice post-Newtonian phase or
der */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute the post-Newtonian inspiral waveform. | | * Driver routine to compute the post-Newtonian inspiral waveform. | |
| * | | * | |
| * This routine uses the same pN order for phasing and amplitude | | * This routine uses the same pN order for phasing and amplitude | |
| * (unless the order is -1 in which case the highest available | | * (unless the order is -1 in which case the highest available | |
| * order is used for both of these -- which might not be the same). | | * order is used for both of these -- which might not be the same). | |
| * | | * | |
|
| * Log terms in amplitudes are ignored. This is a gauge choice. | | * Constant log term in amplitude set to 1. This is a gauge choice. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT4PN( | | int XLALSimInspiralTaylorT4PN( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute the restricted post-Newtonian inspiral wavefor
m. | | * Driver routine to compute the restricted post-Newtonian inspiral wavefor
m. | |
| * | | * | |
| * This routine computes the phasing to the specified order, but | | * This routine computes the phasing to the specified order, but | |
| * only computes the amplitudes to the Newtonian (quadrupole) order. | | * only computes the amplitudes to the Newtonian (quadrupole) order. | |
| * | | * | |
|
| * Log terms in amplitudes are ignored. This is a gauge choice. | | * Constant log term in amplitude set to 1. This is a gauge choice. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT4PNRestricted( | | int XLALSimInspiralTaylorT4PNRestricted( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| | | | |
| skipping to change at line 525 | | skipping to change at line 612 | |
| /** | | /** | |
| * Driver routine to compute the post-Newtonian inspiral waveform. | | * Driver routine to compute the post-Newtonian inspiral waveform. | |
| * | | * | |
| * 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 XLALSimInspiralTaylorT3PNGenerator( | | int XLALSimInspiralTaylorT3PNGenerator( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| REAL8 phic, /**< coalescence phase */ | | REAL8 phic, /**< coalescence phase */ | |
|
| REAL8 x0, /**< tail-term gauge choice thing
(if you don't know, just set it to zero) */ | | REAL8 v0, /**< tail-term gauge choice (defau
lt = 1) */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| int amplitudeO, /**< twice post-Newtonian amplitud
e order */ | | int amplitudeO, /**< twice post-Newtonian amplitud
e order */ | |
| int phaseO /**< twice post-Newtonian phase or
der */ | | int phaseO /**< twice post-Newtonian phase or
der */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute the post-Newtonian inspiral waveform. | | * Driver routine to compute the post-Newtonian inspiral waveform. | |
| * | | * | |
| * This routine uses the same pN order for phasing and amplitude | | * This routine uses the same pN order for phasing and amplitude | |
| * (unless the order is -1 in which case the highest available | | * (unless the order is -1 in which case the highest available | |
| * order is used for both of these -- which might not be the same). | | * order is used for both of these -- which might not be the same). | |
| * | | * | |
|
| * Log terms in amplitudes are ignored. This is a gauge choice. | | * Constant log term in amplitude set to 1. This is a gauge choice. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT3PN( | | int XLALSimInspiralTaylorT3PN( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute the restricted post-Newtonian inspiral wavefor
m. | | * Driver routine to compute the restricted post-Newtonian inspiral wavefor
m. | |
| * | | * | |
| * This routine computes the phasing to the specified order, but | | * This routine computes the phasing to the specified order, but | |
| * only computes the amplitudes to the Newtonian (quadrupole) order. | | * only computes the amplitudes to the Newtonian (quadrupole) order. | |
| * | | * | |
|
| * Log terms in amplitudes are ignored. This is a gauge choice. | | * Constant log term in amplitude set to 1. This is a gauge choice. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT3PNRestricted( | | int XLALSimInspiralTaylorT3PNRestricted( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| | | | |
| skipping to change at line 605 | | skipping to change at line 692 | |
| /** | | /** | |
| * Driver routine to compute the post-Newtonian inspiral waveform. | | * Driver routine to compute the post-Newtonian inspiral waveform. | |
| * | | * | |
| * 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 XLALSimInspiralTaylorT2PNGenerator( | | int XLALSimInspiralTaylorT2PNGenerator( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| REAL8 phic, /**< coalescence phase */ | | REAL8 phic, /**< coalescence phase */ | |
|
| REAL8 x0, /**< tail-term gauge choice thing
(if you don't know, just set it to zero) */ | | REAL8 v0, /**< tail-term gauge choice (defau
lt = 1) */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| int amplitudeO, /**< twice post-Newtonian amplitud
e order */ | | int amplitudeO, /**< twice post-Newtonian amplitud
e order */ | |
| int phaseO /**< twice post-Newtonian phase or
der */ | | int phaseO /**< twice post-Newtonian phase or
der */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute the post-Newtonian inspiral waveform. | | * Driver routine to compute the post-Newtonian inspiral waveform. | |
| * | | * | |
| * This routine uses the same pN order for phasing and amplitude | | * This routine uses the same pN order for phasing and amplitude | |
| * (unless the order is -1 in which case the highest available | | * (unless the order is -1 in which case the highest available | |
| * order is used for both of these -- which might not be the same). | | * order is used for both of these -- which might not be the same). | |
| * | | * | |
|
| * Log terms in amplitudes are ignored. This is a gauge choice. | | * Constant log term in amplitude set to 1. This is a gauge choice. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT2PN( | | int XLALSimInspiralTaylorT2PN( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute the restricted post-Newtonian inspiral wavefor
m. | | * Driver routine to compute the restricted post-Newtonian inspiral wavefor
m. | |
| * | | * | |
| * This routine computes the phasing to the specified order, but | | * This routine computes the phasing to the specified order, but | |
| * only computes the amplitudes to the Newtonian (quadrupole) order. | | * only computes the amplitudes to the Newtonian (quadrupole) order. | |
| * | | * | |
|
| * Log terms in amplitudes are ignored. This is a gauge choice. | | * Constant log term in amplitude set to 1. This is a gauge choice. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT2PNRestricted( | | int XLALSimInspiralTaylorT2PNRestricted( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| | | | |
| skipping to change at line 685 | | skipping to change at line 772 | |
| /** | | /** | |
| * Driver routine to compute the post-Newtonian inspiral waveform. | | * Driver routine to compute the post-Newtonian inspiral waveform. | |
| * | | * | |
| * 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 XLALSimInspiralTaylorT1PNGenerator( | | int XLALSimInspiralTaylorT1PNGenerator( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| REAL8 phic, /**< coalescence phase */ | | REAL8 phic, /**< coalescence phase */ | |
|
| REAL8 x0, /**< tail-term gauge choice thing
(if you don't know, just set it to zero) */ | | REAL8 v0, /**< tail-term gauge choice (defau
lt = 1) */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| int amplitudeO, /**< twice post-Newtonian amplitud
e order */ | | int amplitudeO, /**< twice post-Newtonian amplitud
e order */ | |
| int phaseO /**< twice post-Newtonian phase or
der */ | | int phaseO /**< twice post-Newtonian phase or
der */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute the post-Newtonian inspiral waveform. | | * Driver routine to compute the post-Newtonian inspiral waveform. | |
| * | | * | |
| * This routine uses the same pN order for phasing and amplitude | | * This routine uses the same pN order for phasing and amplitude | |
| * (unless the order is -1 in which case the highest available | | * (unless the order is -1 in which case the highest available | |
| * order is used for both of these -- which might not be the same). | | * order is used for both of these -- which might not be the same). | |
| * | | * | |
|
| * Log terms in amplitudes are ignored. This is a gauge choice. | | * Constant log term in amplitude set to 1. This is a gauge choice. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT1PN( | | int XLALSimInspiralTaylorT1PN( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| REAL8 i, /**< inclination of source (rad) *
/ | | REAL8 i, /**< inclination of source (rad) *
/ | |
| int O /**< twice post-Newtonian order */ | | int O /**< twice post-Newtonian order */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute the restricted post-Newtonian inspiral wavefor
m. | | * Driver routine to compute the restricted post-Newtonian inspiral wavefor
m. | |
| * | | * | |
| * This routine computes the phasing to the specified order, but | | * This routine computes the phasing to the specified order, but | |
| * only computes the amplitudes to the Newtonian (quadrupole) order. | | * only computes the amplitudes to the Newtonian (quadrupole) order. | |
| * | | * | |
|
| * Log terms in amplitudes are ignored. This is a gauge choice. | | * Constant log term in amplitude set to 1. This is a gauge choice. | |
| */ | | */ | |
| int XLALSimInspiralTaylorT1PNRestricted( | | int XLALSimInspiralTaylorT1PNRestricted( | |
| REAL8TimeSeries **hplus, /**< +-polarization waveform */ | | REAL8TimeSeries **hplus, /**< +-polarization waveform */ | |
| REAL8TimeSeries **hcross, /**< x-polarization waveform */ | | REAL8TimeSeries **hcross, /**< x-polarization waveform */ | |
| 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 */ | |
| REAL8 r, /**< distance of source */ | | REAL8 r, /**< distance of source */ | |
| | | | |
| skipping to change at line 862 | | skipping to change at line 949 | |
| 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 phi0, /**< orbital phase at initial time */ | | 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 */ | |
| REAL8 s2z, /**< initial value of S2z */ | | REAL8 s2z, /**< initial value of S2z */ | |
| | | | |
| skipping to change at line 895 | | skipping to change at line 982 | |
| /** | | /** | |
| * 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" metho
d. | |
| * | | * | |
| * 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 phi0, /**< initial GW phase (rad) */ | | REAL8 phi_end, /**< GW phase of final sample (rad | |
| REAL8 v0, /**< tail gauge term (default = 0) | | ) */ | |
| */ | | REAL8 v0, /**< tail gauge term (default = 1) | |
| | | */ | |
| 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 GW frequency (Hz) */ | | REAL8 fStart, /**< start GW frequency (Hz) */ | |
| REAL8 r, /**< distance of source (m) */ | | REAL8 r, /**< distance of source (m) */ | |
| 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 */ | |
| REAL8 s2z, /**< initial value of S2z */ | | REAL8 s2z, /**< initial value of S2z */ | |
| REAL8 lnhatx, /**< initial value of LNhatx */ | | REAL8 lnhatx, /**< initial value of LNhatx */ | |
| REAL8 lnhaty, /**< initial value of LNhaty */ | | REAL8 lnhaty, /**< initial value of LNhaty */ | |
| REAL8 lnhatz, /**< initial value of LNhatz */ | | REAL8 lnhatz, /**< initial value of LNhatz */ | |
| REAL8 e1x, /**< initial value of E1x */ | | REAL8 e1x, /**< initial value of E1x */ | |
| 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 m | | REAL8 lambda1, /**< (tidal deformability of mass | |
| ass 1) / (total mass)^5 (dimensionless) */ | | 1) / (total mass)^5 (dimensionless) */ | |
| REAL8 lambda2, /**< (tidal deformability of m | | REAL8 lambda2, /**< (tidal deformability of mass | |
| ass 2) / (total mass)^5 (dimensionless) */ | | 2) / (total mass)^5 (dimensionless) */ | |
| LALSimInspiralInteraction interactionFlags, /**< flag to | | LALSimInspiralInteraction interactionFlags, /**< flag to con | |
| control spin and tidal effects */ | | 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" metho
d. | |
| * | | * | |
| * 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 phi0, /**< initial GW phase (rad) */ | | REAL8 phi_end, /**< GW phase of final sample (rad | |
| REAL8 v0, /**< tail gauge term (default = 0 | | ) */ | |
| ) */ | | REAL8 v0, /**< tail gauge term (default = 1) | |
| REAL8 deltaT, /**< sampling interval (s) */ | | */ | |
| REAL8 m1, /**< mass of companion 1 (kg) */ | | REAL8 deltaT, /**< sampling interval (s) */ | |
| REAL8 m2, /**< mass of companion 2 (kg) */ | | REAL8 m1, /**< mass of companion 1 (kg) */ | |
| REAL8 fStart, /**< start GW frequency (Hz) */ | | REAL8 m2, /**< mass of companion 2 (kg) */ | |
| REAL8 r, /**< distance of source (m) */ | | REAL8 fStart, /**< start GW frequency (Hz) */ | |
| REAL8 s1x, /**< initial value of S1x */ | | REAL8 r, /**< distance of source (m) */ | |
| REAL8 s1y, /**< initial value of S1y */ | | REAL8 s1x, /**< initial value of S1x */ | |
| REAL8 s1z, /**< initial value of S1z */ | | REAL8 s1y, /**< initial value of S1y */ | |
| REAL8 s2x, /**< initial value of S2x */ | | REAL8 s1z, /**< initial value of S1z */ | |
| REAL8 s2y, /**< initial value of S2y */ | | REAL8 s2x, /**< initial value of S2x */ | |
| REAL8 s2z, /**< initial value of S2z */ | | REAL8 s2y, /**< initial value of S2y */ | |
| REAL8 lnhatx, /**< initial value of LNhatx */ | | REAL8 s2z, /**< initial value of S2z */ | |
| REAL8 lnhaty, /**< initial value of LNhaty */ | | REAL8 lnhatx, /**< initial value of LNhatx */ | |
| REAL8 lnhatz, /**< initial value of LNhatz */ | | REAL8 lnhaty, /**< initial value of LNhaty */ | |
| REAL8 e1x, /**< initial value of E1x */ | | REAL8 lnhatz, /**< initial value of LNhatz */ | |
| REAL8 e1y, /**< initial value of E1y */ | | REAL8 e1x, /**< initial value of E1x */ | |
| REAL8 e1z, /**< initial value of E1z */ | | REAL8 e1y, /**< initial value of E1y */ | |
| REAL8 lambda1, /**< (tidal deformability of m | | REAL8 e1z, /**< initial value of E1z */ | |
| ass 1) / (total mass)^5 (dimensionless) */ | | REAL8 lambda1, /**< (tidal deformability of mass | |
| REAL8 lambda2, /**< (tidal deformability of m | | 1) / (total mass)^5 (dimensionless) */ | |
| ass 2) / (total mass)^5 (dimensionless) */ | | REAL8 lambda2, /**< (tidal deformability of mass | |
| LALSimInspiralInteraction interactionFlags, /**< flag to cont | | 2) / (total mass)^5 (dimensionless) */ | |
| rol spin and tidal effects */ | | LALSimInspiralInteraction interactionFlags, /**< flag to control | |
| int phaseO /**< twice PN phase order */ | | spin and tidal effects */ | |
| | | 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) a
s | |
| * 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 | |
| | | | |
| skipping to change at line 1017 | | skipping to change at line 1104 | |
| REAL8 m1, /**< mass of body 1 (kg) */ | | REAL8 m1, /**< mass of body 1 (kg) */ | |
| REAL8 m2, /**< mass of body 2 (kg) */ | | REAL8 m2, /**< mass of body 2 (kg) */ | |
| REAL8 f0, /**< initial GW frequency (Hz) */ | | REAL8 f0, /**< initial GW frequency (Hz) */ | |
| REAL8 chi1, /**< dimensionless spin of body 1 */ | | REAL8 chi1, /**< dimensionless spin of body 1 */ | |
| REAL8 chi2 /**< dimensionless spin of body 2 */ | | REAL8 chi2 /**< dimensionless spin of body 2 */ | |
| ); | | ); | |
| | | | |
| /** | | /** | |
| * Driver routine to compute a non-precessing post-Newtonian inspiral wavef
orm | | * Driver routine to compute a non-precessing post-Newtonian inspiral wavef
orm | |
| * in the frequency domain, described in http://arxiv.org/abs/1107.1267. | | * in the frequency domain, described in http://arxiv.org/abs/1107.1267. | |
|
| * The chi parameter should be determined from XLALSimInspiralTaylorF2Reduc | | * | |
| edSpinComputeChi. | | * The chi parameter should be determined from | |
| | | * XLALSimInspiralTaylorF2ReducedSpinComputeChi. | |
| | | * | |
| | | * A note from Evan Ochsner on differences with respect to TaylorF2: | |
| | | * | |
| | | * 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) | |
| | | * 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 | |
| | | * 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 | |
| | | * of the second paper) but expands out the 1/\sqrt{\dot{F}} ( Eq. 5.3 OR E | |
| | | q. | |
| | | * 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 | |
| | | * TD amplitude and the factor 1/\sqrt{\dot{F}}, take their product, and ke | |
| | | ep | |
| | | * all terms up to the desired amplitude order, as in Eq. 6.13-6.14 of the | |
| | | * second paper. | |
| | | * | |
| | | * 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 | |
| | | * 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 | |
| | | * (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 | |
| | | * case. | |
| */ | | */ | |
| int XLALSimInspiralTaylorF2ReducedSpin( | | int XLALSimInspiralTaylorF2ReducedSpin( | |
| 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 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)
*/ | |
| | | | |
End of changes. 32 change blocks. |
| 97 lines changed or deleted | | 264 lines changed or added | |
|