LALSimIMREOBNRv2.h

Go to the documentation of this file.

/*
*  Copyright (C) 2010 Craig Robinson
*
*  This program is free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  This program is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with with program; see the file COPYING. If not, write to the
*  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
*  MA  02110-1301  USA
*/
 
 
/**
 * \author Craig Robinson, Andrea Taracchini
 *
 * \brief File containing most of the structures and prototypes which are
 * used in the generation of the EOBNRv2 waveform. These structures and
 * prototypes are used internally within the waveform generation code,
 * and shouldn't be needed to generate the waveforms from outside the
 * library. Therefore, people generating EOBNRv2 waveforms should only
 * need to include LALSimIMR.h.
 */
 
#include <lal/LALConstants.h>
#include <lal/LALSimIMR.h>
#include <lal/LALSimInspiral.h>
 
#ifndef _LALSIMIMREOBNRv2_H
#define _LALSIMIMREOBNRv2_H
 
#if defined(__cplusplus)
extern "C"
{
#elif 0
}                               /* so that editors will match preceding brace */
#endif
 
/**
 * The maximum possible l we have
 */
#define LALEOB_MAX_MULTIPOLE 8
 
/**
 * Tidal parameters for EOB model of NS:
 * mByM - dimensionless ratio m_{NS}/M
 * lambda2Tidal - dimensionless adiabatic quadrupole tidal deformability normalized by total mass (2/3 k_2 (R_{NS}/M)^5)
 * omega02Tidal - quadrupole f-mode angular freq m_{NS}*omega_{02}
 * lambda3Tidal - dimensionless adiabatic octupole tidal deformability normalized by total mass (2/15 k_3 (R_{NS}/M)^7)
 * omega03Tidal - octupole f-mode angular freq m_{NS}*omega_{03}
 */
typedef struct tagTidalEOBParams
{
    REAL8 mByM;
    REAL8 lambda2Tidal;
    REAL8 lambda3Tidal;
    REAL8 omega02Tidal;
    REAL8 omega03Tidal;
    REAL8 quadparam;
}
TidalEOBParams;
 
/**
 * Structure containing the coefficients for EOBNRv2 A potential function.
 * The elements in the structure are labelled as follows:
 * aN, where a is denotes whether the parameter is in the numerator (n)
 * or denominator (d); and N is the power of r which will multiply this
 * coefficient. For example, the coefficient of r^5 in the numerator
 * will be called n5.
 */
typedef struct tagEOBACoefficients
{
  REAL8 n4;
  REAL8 n5;
  REAL8 d0;
  REAL8 d1;
  REAL8 d2;
  REAL8 d3;
  REAL8 d4;
  REAL8 d5;
}
EOBACoefficients;
 
/**
 * Structure containing the coefficients for calculating the factorized
 * waveform. The coefficients are precomputed in the function
 * XLALCalcFacWaveformCoefficients()
 */
typedef struct tagFacWaveformCoeffs
{
  REAL8 delta22vh3;
  REAL8 delta22vh6;
  REAL8 delta22vh6S;
  REAL8 delta22v8;
  REAL8 delta22v8S;
  REAL8 delta22vh9;
  REAL8 delta22v5;
  REAL8 delta22v6;
  REAL8 delta22v6S;
 
  REAL8 rho22v2;
  REAL8 rho22v3;
  REAL8 rho22v3S;
  REAL8 rho22v4;
  REAL8 rho22v4S;
  REAL8 rho22v5;
  REAL8 rho22v5S;
  REAL8 rho22v6;
  REAL8 rho22v6S;
  REAL8 rho22v6l;
  REAL8 rho22v7;
  REAL8 rho22v7S;
  REAL8 rho22v8;
  REAL8 rho22v8S;
  REAL8 rho22v8l;
  REAL8 rho22v10;
  REAL8 rho22v10l;
 
  REAL8 delta21vh3;
  REAL8 delta21vh6;
  REAL8 delta21vh6S;
  REAL8 delta21vh7;
  REAL8 delta21vh7S;
  REAL8 delta21vh9;
  REAL8 delta21v5;
  REAL8 delta21v7;
 
  REAL8 rho21v1;
  REAL8 rho21v2;
  REAL8 rho21v2S;
  REAL8 rho21v3;
  REAL8 rho21v3S;
  REAL8 rho21v4;
  REAL8 rho21v4S;
  REAL8 rho21v5;
  REAL8 rho21v5S;
  REAL8 rho21v6;
  REAL8 rho21v6S;
  REAL8 rho21v6l;
  REAL8 rho21v7;
  REAL8 rho21v7S;
  REAL8 rho21v7l;
  REAL8 rho21v7lS;
  REAL8 rho21v8;
  REAL8 rho21v8l;
  REAL8 rho21v10;
  REAL8 rho21v10l;
 
  REAL8 f21v1;
  REAL8 f21v1S;
  REAL8 f21v3;
  REAL8 f21v3S;
  REAL8 f21v4;
  REAL8 f21v5;
  REAL8 f21v6;
  REAL8 f21v7c;
 
  REAL8 delta33vh3;
  REAL8 delta33vh6;
  REAL8 delta33vh6S;
  REAL8 delta33vh9;
  REAL8 delta33v5;
  REAL8 delta33v7;
 
  REAL8 rho33v2;
  REAL8 rho33v3;
  REAL8 rho33v4;
  REAL8 rho33v4S;
  REAL8 rho33v5;
  REAL8 rho33v5S;
  REAL8 rho33v6;
  REAL8 rho33v6S;
  REAL8 rho33v6l;
  REAL8 rho33v7;
  REAL8 rho33v7S;
  REAL8 rho33v8;
  REAL8 rho33v8l;
  REAL8 rho33v10;
  REAL8 rho33v10l;
 
  REAL8 f33v3;
  REAL8 f33v4;
  REAL8 f33v5;
  REAL8 f33v6;
  REAL8 f33v3S;
  REAL8 f33vh6;
 
  REAL8 delta32vh3;
  REAL8 delta32vh4;
  REAL8 delta32vh4S;
  REAL8 delta32vh6;
  REAL8 delta32vh6S;
  REAL8 delta32vh9;
 
  REAL8 rho32v;
  REAL8 rho32vS;
  REAL8 rho32v2;
  REAL8 rho32v2S;
  REAL8 rho32v3;
  REAL8 rho32v3S;
  REAL8 rho32v4;
  REAL8 rho32v4S;
  REAL8 rho32v5;
  REAL8 rho32v5S;
  REAL8 rho32v6;
  REAL8 rho32v6S;
  REAL8 rho32v6l;
  REAL8 rho32v8;
  REAL8 rho32v8l;
 
  REAL8 delta31vh3;
  REAL8 delta31vh6;
  REAL8 delta31vh6S;
  REAL8 delta31vh7;
  REAL8 delta31vh7S;
  REAL8 delta31vh9;
  REAL8 delta31v5;
 
  REAL8 rho31v2;
  REAL8 rho31v3;
  REAL8 rho31v4;
  REAL8 rho31v4S;
  REAL8 rho31v5;
  REAL8 rho31v5S;
  REAL8 rho31v6;
  REAL8 rho31v6S;
  REAL8 rho31v6l;
  REAL8 rho31v7;
  REAL8 rho31v7S;
  REAL8 rho31v8;
  REAL8 rho31v8l;
 
  REAL8 f31v3;
  REAL8 f31v3S;
 
  REAL8 delta44vh3;
  REAL8 delta44vh6;
  REAL8 delta44vh6S;
  REAL8 delta44v5;
  REAL8 delta44vh9;
 
  REAL8 rho44v2;
  REAL8 rho44v3;
  REAL8 rho44v3S;
  REAL8 rho44v4;
  REAL8 rho44v4S;
  REAL8 rho44v5;
  REAL8 rho44v5S;
  REAL8 rho44v6;
  REAL8 rho44v6S;
  REAL8 rho44v6l;
  REAL8 rho44v8;
  REAL8 rho44v8l;
  REAL8 rho44v10;
  REAL8 rho44v10l;
 
  REAL8 delta43vh3;
  REAL8 delta43vh4;
  REAL8 delta43vh4S;
  REAL8 delta43vh6;
 
  REAL8 rho43v;
  REAL8 rho43v2;
  REAL8 rho43v4;
  REAL8 rho43v4S;
  REAL8 rho43v5;
  REAL8 rho43v5S;
  REAL8 rho43v6;
  REAL8 rho43v6l;
 
  REAL8 f43v;
  REAL8 f43vS;
 
  REAL8 delta42vh3;
  REAL8 delta42vh6;
  REAL8 delta42vh6S;
 
  REAL8 rho42v2;
  REAL8 rho42v3;
  REAL8 rho42v3S;
  REAL8 rho42v4;
  REAL8 rho42v4S;
  REAL8 rho42v5;
  REAL8 rho42v5S;
  REAL8 rho42v6;
  REAL8 rho42v6S;
  REAL8 rho42v6l;
 
  REAL8 delta41vh3;
  REAL8 delta41vh4;
  REAL8 delta41vh4S;
  REAL8 delta41vh6;
 
  REAL8 rho41v;
  REAL8 rho41v2;
  REAL8 rho41v4;
  REAL8 rho41v4S;
  REAL8 rho41v5;
  REAL8 rho41v5S;
  REAL8 rho41v6;
  REAL8 rho41v6l;
 
  REAL8 f41v;
  REAL8 f41vS;
 
  REAL8 delta55vh3;
  REAL8 delta55vh6;
  REAL8 delta55vh9;
 
  REAL8 delta55v5;
  REAL8 rho55v2;
  REAL8 rho55v3;
  REAL8 rho55v3S;
  REAL8 rho55v4;
  REAL8 rho55v4S;
  REAL8 rho55v5;
  REAL8 rho55v5S;
  REAL8 rho55v6;
  REAL8 rho55v6l;
  REAL8 rho55v8;
  REAL8 rho55v8l;
  REAL8 rho55v10;
  REAL8 rho55v10l;
  REAL8 f55v3;
  REAL8 f55v4;
  REAL8 f55v5c;
 
 
  REAL8 delta54vh3;
  REAL8 delta54vh4;
  REAL8 delta54vh4S;
  REAL8 rho54v2;
  REAL8 rho54v3;
  REAL8 rho54v3S;
  REAL8 rho54v4;
  REAL8 rho54v4S;
 
  REAL8 delta53vh3;
  REAL8 rho53v2;
  REAL8 rho53v3;
  REAL8 rho53v3S;
  REAL8 rho53v4;
  REAL8 rho53v4S;
  REAL8 rho53v5;
  REAL8 rho53v5S;
 
  REAL8 delta52vh3;
  REAL8 delta52vh4;
  REAL8 delta52vh4S;
  REAL8 rho52v2;
  REAL8 rho52v3;
  REAL8 rho52v3S;
  REAL8 rho52v4;
  REAL8 rho52v4S;
 
  REAL8 delta51vh3;
  REAL8 rho51v2;
  REAL8 rho51v3;
  REAL8 rho51v3S;
  REAL8 rho51v4;
  REAL8 rho51v4S;
  REAL8 rho51v5;
  REAL8 rho51v5S;
 
  REAL8 delta66vh3;
  REAL8 rho66v2;
  REAL8 rho66v3;
  REAL8 rho66v3S;
  REAL8 rho66v4;
  REAL8 rho66v4S;
 
  REAL8 delta65vh3;
  REAL8 rho65v2;
  REAL8 rho65v3;
  REAL8 rho65v3S;
 
  REAL8 delta64vh3;
  REAL8 rho64v2;
  REAL8 rho64v3;
  REAL8 rho64v3S;
  REAL8 rho64v4;
  REAL8 rho64v4S;
 
  REAL8 delta63vh3;
  REAL8 rho63v2;
  REAL8 rho63v3;
  REAL8 rho63v3S;
 
  REAL8 delta62vh3;
  REAL8 rho62v2;
  REAL8 rho62v3;
  REAL8 rho62v3S;
  REAL8 rho62v4;
  REAL8 rho62v4S;
 
  REAL8 delta61vh3;
  REAL8 rho61v2;
  REAL8 rho61v3;
  REAL8 rho61v3S;
 
  REAL8 delta77vh3;
  REAL8 rho77v2;
  REAL8 rho77v3;
  REAL8 rho77v3S;
 
  REAL8 rho76v2;
 
  REAL8 delta75vh3;
  REAL8 rho75v2;
  REAL8 rho75v3;
  REAL8 rho75v3S;
 
  REAL8 rho74v2;
 
  REAL8 delta73vh3;
  REAL8 rho73v2;
  REAL8 rho73v3;
  REAL8 rho73v3S;
 
  REAL8 rho72v2;
 
  REAL8 delta71vh3;
  REAL8 rho71v2;
  REAL8 rho71v3;
  REAL8 rho71v3S;
 
  REAL8 rho88v2;
  REAL8 rho87v2;
  REAL8 rho86v2;
  REAL8 rho85v2;
  REAL8 rho84v2;
  REAL8 rho83v2;
  REAL8 rho82v2;
  REAL8 rho81v2;
 
  TidalEOBParams *tidal1;
  TidalEOBParams *tidal2;
}
FacWaveformCoeffs;
 
/**
 * Structure containing all the terms of the Newtonian multipole which
 * are constant over the course of the evolution, and can therefore be
 * pre-computed. They are stored in a two-dimensional array, which is
 * indexed as values[l][m]. Since m has to be <= l, this structure
 * is larger than it needs to be; but it makes the coding a bit neater...
 */
typedef struct tagNewtonMultipolePrefixes
{
  COMPLEX16 values[LALEOB_MAX_MULTIPOLE + 1][LALEOB_MAX_MULTIPOLE + 1];
}
NewtonMultipolePrefixes;
 
/**
 * The coefficients which are used in calculating the non-quasicircular
 * correction to the EOBNRv2 model. The precise definitions of these
 * coefficients and their use can be found in DCC document T1100433.
 */
typedef struct tagEOBNonQCCoeffs
{
  REAL8 a1;
  REAL8 a2;
  REAL8 a3;
  REAL8 a3S;
  REAL8 a4;
  REAL8 a5;
  REAL8 b1;
  REAL8 b2;
  REAL8 b3;
  REAL8 b4;
} EOBNonQCCoeffs;
 
/**
 * Structure containing all the parameters needed for the EOB waveform.
 * It contains eta, the pre-computed parameters for the A potential function,
 * and the pre-computed parameters for the factorized waveform
 */
 
typedef struct tagEOBParams
{
  REAL8 eta;
  REAL8 omega;
  UINT4 omegaPeaked;
  REAL8 omegaMerger;
  REAL8 m1;
  REAL8 m2;
  REAL8 rad;
  INT4 NyquistStop;
  EOBACoefficients *aCoeffs;
  FacWaveformCoeffs *hCoeffs;
  EOBNonQCCoeffs *nqcCoeffs;
  NewtonMultipolePrefixes *prefixes;
}
EOBParams;
 
/**
 * Structure containing parameters used to determine
 * r as a function of omega. Since this is determined within
 * a root finding function, it is necessary to place all parameters
 * with the exception of the current guess of the radius within
 * a structure.
 */
typedef struct tagrOfOmegaIn
{
  REAL8 eta;    /**<< Symmetric mass ratio */
  REAL8 omega;  /**<< Angular frequency (dimensionless combination M omega) */
} rOfOmegaIn;
 
 
/**
 * Structure containing parameters used to determine the initial radial
 * momentum. Since this is determined within a root finding function,
 * it is necessary to place all parameters with the exception of the
 * current guess of the radial momentum within a structure.
 */
typedef struct tagPr3In
{
  REAL8 eta;                 /**<< Symmetric mass ratio */
  REAL8 omega;               /**<< Angular frequency (dimensionless combination M omega) */
  REAL8 vr;                  /**<< Radial velocity (dimensionless) */
  REAL8 r;                   /**<< Orbital separation (units of total mass) */
  REAL8 q;                   /**<< Momentum pphi */
  EOBACoefficients *aCoeffs; /**<< Pre-computed coefficients of EOB A function */
 
} pr3In;
 
 
#ifdef __GNUC__
#define UNUSED __attribute__ ((unused))
#else
#define UNUSED
#endif
 
UNUSED REAL8 XLALSimNSNSMergerFreq(
 TidalEOBParams *tidal1, /**< Tidal parameters of body 1 */
 TidalEOBParams *tidal2  /**< Tidal parameters of body 2 */
);
 
/**
 * Structure to represent a data piece (e.g. a mode hlm), either in frequency or time
 * with complex amplitude (enveloppe) and phase.
 * The mode values are camp * exp(I*phase)
 */
typedef struct tagCAmpPhaseSequence {
    REAL8Vector*                        xdata; /**< Sequence of times or frequencies on which data is given. */
    REAL8Vector*                        camp_real; /**< Sequence for the real part of the complex amplitude (enveloppe). */
    REAL8Vector*                        camp_imag; /**< Sequence for the imag part of the complex amplitude (enveloppe). */
    REAL8Vector*                        phase; /**< Sequence for the phase. */
} CAmpPhaseSequence;
 
/**
 * Structure to represent linked list of modes
 * with complex amplitude (enveloppe) and phase.
 */
typedef struct tagSphHarmListCAmpPhaseSequence {
    CAmpPhaseSequence*                        campphase; /**< Data for this mode. */
    UINT4                                     l; /**< Mode number l. */
    INT4                                      m; /**< Mode number m. */
    struct tagSphHarmListCAmpPhaseSequence*   next; /**< Pointer to next element in the list. */
} SphHarmListCAmpPhaseSequence;
 
/**
 * Structure to represent linked list of modes
 * with complex amplitude (enveloppe) and phase.
 */
typedef struct tagSphHarmListEOBNonQCCoeffs {
    EOBNonQCCoeffs*                        nqcCoeffs; /**< NQC coefficients for this mode. */
    UINT4                                  l; /**< Mode number l. */
    INT4                                   m; /**< Mode number m. */
    struct tagSphHarmListEOBNonQCCoeffs*   next; /**< Pointer to next element in the list. */
} SphHarmListEOBNonQCCoeffs;
 
/**
 * Structure the EOB dynamics for precessing waveforms.
 */
typedef struct tagSEOBdynamics {
  UINT4 length;
  REAL8Array *array;
 
  REAL8 *tVec;
 
  REAL8 *posVecx;
  REAL8 *posVecy;
  REAL8 *posVecz;
 
  REAL8 *momVecx;
  REAL8 *momVecy;
  REAL8 *momVecz;
 
  REAL8 *s1Vecx;
  REAL8 *s1Vecy;
  REAL8 *s1Vecz;
 
  REAL8 *s2Vecx;
  REAL8 *s2Vecy;
  REAL8 *s2Vecz;
 
  REAL8 *phiDMod;
  REAL8 *phiMod;
 
  REAL8 *velVecx;
  REAL8 *velVecy;
  REAL8 *velVecz;
 
  REAL8 *polarrVec;
  REAL8 *polarphiVec;
  REAL8 *polarprVec;
  REAL8 *polarpphiVec;
 
  REAL8 *omegaVec;
 
  REAL8 *s1dotZVec;
  REAL8 *s2dotZVec;
 
  REAL8 *hamVec;
 
} SEOBdynamics;
 
#if 0
{                               /* so that editors will match succeeding brace */
#elif defined(__cplusplus)
}
#endif
 
#endif /* _LALSIMIMREOBNRv2_H */