LALSimulation  5.4.0.1-fe68b98
LALSimIMRSpinAlignedEOB.c File Reference

Prototypes

static INT4 IntrpolateDynamics (REAL8Vector *tVec, REAL8Vector *rVec, REAL8Vector *phiVec, REAL8Vector *prVec, REAL8Vector *pphiVec, REAL8Vector *values, REAL8 closestTime)
 
static INT4 XLALSetup_EOB__std_mode_array_structure (LALValue *ModeArray, UINT4 SpinAlignedEOBversion)
 ModeArray is a structure which allows to select the modes to include in the waveform. More...
 
static INT4 XLALCheck_EOB_mode_array_structure (LALValue *ModeArray, UINT4 SpinAlignedEOBversion)
 ModeArray is a structure which allows to select the modes to include in the waveform. More...
 
UNUSED REAL8 XLALSimNSNSMergerFreq (TidalEOBParams *tidal1, TidalEOBParams *tidal2)
 NR fit to the geometric GW frequency M_{total}omega_{22} of a BNS merger, defined by the time when the (2,2) amplitude peaks See Eq. More...
 
static int UNUSED XLALEOBSpinStopCondition (double UNUSED t, const double values[], double dvalues[], void *funcParams)
 
static int XLALEOBSpinAlignedStopCondition (double UNUSED t, const double values[], double dvalues[], void *funcParams)
 Stopping condition for the regular resolution EOB orbital evolution – stop when reaching max orbital frequency in strong field. More...
 
static int XLALSpinAlignedHiSRStopCondition (double UNUSED t, const double UNUSED values[], double dvalues[], void UNUSED *funcParams)
 
static int XLALSpinAlignedNSNSStopCondition (double UNUSED t, const double UNUSED values[], double dvalues[], void UNUSED *funcParams)
 This function defines the stopping criteria for the tidal EOB model Note that here values[0] = r values[1] = phi values[2] = pr values[3] = pphi dvalues[0] = dr/dt dvalues[1] = dphi/dt dvalues[2] = dpr/dt dvalues[3] = dpphi/dt = omega. More...
 
static int XLALSpinAlignedHiSRStopConditionV4 (double UNUSED t, const double UNUSED values[], double dvalues[], void UNUSED *funcParams)
 
double XLALSimIMRSpinAlignedEOBPeakFrequency (REAL8 m1SI, REAL8 m2SI, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion)
 This function returns the frequency at which the peak amplitude occurs in SEOBNRv(x) More...
 
int XLALSimIMRSpinAlignedEOBWaveform (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, LALDict *LALParams)
 
int XLALSimIMRSpinAlignedEOBModes (SphHarmTimeSeries **hlmmode, REAL8Vector **dynamics_out, REAL8Vector **dynamicsHi_out, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, const REAL8 lambda2Tidal1, const REAL8 lambda2Tidal2, const REAL8 omega02Tidal1, const REAL8 omega02Tidal2, const REAL8 lambda3Tidal1, const REAL8 lambda3Tidal2, const REAL8 omega03Tidal1, const REAL8 omega03Tidal2, const REAL8 quadparam1, const REAL8 quadparam2, REAL8Vector *nqcCoeffsInput, const INT4 nqcFlag, LALDict *PAParams, LALDict *TGRParams)
 This function generates spin-aligned SEOBNRv1,2,2opt,4,4opt,2T,4T,4HM complex modes hlm. More...
 
int XLALSimIMRSpinAlignedEOBWaveformAll (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const REAL8 phiC, REAL8 deltaT, const REAL8 m1SI, const REAL8 m2SI, const REAL8 fMin, const REAL8 r, const REAL8 inc, const REAL8 spin1z, const REAL8 spin2z, UINT4 SpinAlignedEOBversion, const REAL8 lambda2Tidal1, const REAL8 lambda2Tidal2, const REAL8 omega02Tidal1, const REAL8 omega02Tidal2, const REAL8 lambda3Tidal1, const REAL8 lambda3Tidal2, const REAL8 omega03Tidal1, const REAL8 omega03Tidal2, const REAL8 quadparam1, const REAL8 quadparam2, REAL8Vector *nqcCoeffsInput, const INT4 nqcFlag, LALValue *ModeArray, LALDict *TGRParams)
 This function takes the modes from the function XLALSimIMRSpinAlignedEOBModes and combine them into h+ and hx. More...
 

Go to the source code of this file.

Macros

#define debugOutput   0
 
#define SEOBNRv4HM   41
 
#define SEOBNRv4HM_PA   4111
 
#define pSEOBNRv4HM_PA   4112
 

Macro Definition Documentation

◆ debugOutput

#define debugOutput   0

Definition at line 65 of file LALSimIMRSpinAlignedEOB.c.

◆ SEOBNRv4HM

#define SEOBNRv4HM   41

Definition at line 66 of file LALSimIMRSpinAlignedEOB.c.

◆ SEOBNRv4HM_PA

#define SEOBNRv4HM_PA   4111

Definition at line 67 of file LALSimIMRSpinAlignedEOB.c.

◆ pSEOBNRv4HM_PA

#define pSEOBNRv4HM_PA   4112

Definition at line 68 of file LALSimIMRSpinAlignedEOB.c.

Function Documentation

◆ IntrpolateDynamics()

static INT4 IntrpolateDynamics ( REAL8Vector tVec,
REAL8Vector rVec,
REAL8Vector phiVec,
REAL8Vector prVec,
REAL8Vector pphiVec,
REAL8Vector values,
REAL8  closestTime 
)
static

Definition at line 80 of file LALSimIMRSpinAlignedEOB.c.

◆ XLALSetup_EOB__std_mode_array_structure()

static INT4 XLALSetup_EOB__std_mode_array_structure ( LALValue *  ModeArray,
UINT4  SpinAlignedEOBversion 
)
static

ModeArray is a structure which allows to select the modes to include in the waveform.

This function will create a structure with the default modes for every model

Definition at line 122 of file LALSimIMRSpinAlignedEOB.c.

◆ XLALCheck_EOB_mode_array_structure()

static INT4 XLALCheck_EOB_mode_array_structure ( LALValue *  ModeArray,
UINT4  SpinAlignedEOBversion 
)
static

ModeArray is a structure which allows to select the modes to include in the waveform.

This function check if the selected modes are available for a given model

Definition at line 163 of file LALSimIMRSpinAlignedEOB.c.

◆ XLALSimNSNSMergerFreq()

UNUSED REAL8 XLALSimNSNSMergerFreq ( TidalEOBParams tidal1,
TidalEOBParams tidal2 
)

NR fit to the geometric GW frequency M_{total}omega_{22} of a BNS merger, defined by the time when the (2,2) amplitude peaks See Eq.

(2) in https://arxiv.org/pdf/1504.01764.pdf with coefficients given by the 3rd row of Table II therein. Compared to NR for 0 <= kappa2T <= 500

Parameters
tidal1Tidal parameters of body 1
tidal2Tidal parameters of body 2

Definition at line 225 of file LALSimIMRSpinAlignedEOB.c.

◆ XLALEOBSpinStopCondition()

static int UNUSED XLALEOBSpinStopCondition ( double UNUSED  t,
const double  values[],
double  dvalues[],
void *  funcParams 
)
static
Parameters
t< UNUSED
values< Dynamical variables
dvalues<1st time-derivatives of dynamical variables
funcParams< physical parameters

Definition at line 261 of file LALSimIMRSpinAlignedEOB.c.

◆ XLALEOBSpinAlignedStopCondition()

static int XLALEOBSpinAlignedStopCondition ( double UNUSED  t,
const double  values[],
double  dvalues[],
void *  funcParams 
)
static

Stopping condition for the regular resolution EOB orbital evolution – stop when reaching max orbital frequency in strong field.

At each test, if omega starts to decrease, return 1 to stop evolution; if not, update omega with current value and return GSL_SUCCESS to continue evolution.

Parameters
tUNUSED
valuesdynamical variable values
dvaluesdynamical variable time derivative values
funcParamsphysical parameters

Definition at line 300 of file LALSimIMRSpinAlignedEOB.c.

◆ XLALSpinAlignedHiSRStopCondition()

static int XLALSpinAlignedHiSRStopCondition ( double UNUSED  t,
const double UNUSED  values[],
double  dvalues[],
void UNUSED *  funcParams 
)
static
Parameters
tUNUSED
valuesdynamical variable values
dvaluesdynamical variable time derivative values
funcParamsphysical parameters

Definition at line 335 of file LALSimIMRSpinAlignedEOB.c.

◆ XLALSpinAlignedNSNSStopCondition()

static int XLALSpinAlignedNSNSStopCondition ( double UNUSED  t,
const double UNUSED  values[],
double  dvalues[],
void UNUSED *  funcParams 
)
static

This function defines the stopping criteria for the tidal EOB model Note that here values[0] = r values[1] = phi values[2] = pr values[3] = pphi dvalues[0] = dr/dt dvalues[1] = dphi/dt dvalues[2] = dpr/dt dvalues[3] = dpphi/dt = omega.

Parameters
tUNUSED
valuesdynamical variable values
dvaluesdynamical variable time derivative values
funcParamsphysical parameters

Definition at line 362 of file LALSimIMRSpinAlignedEOB.c.

◆ XLALSpinAlignedHiSRStopConditionV4()

static int XLALSpinAlignedHiSRStopConditionV4 ( double UNUSED  t,
const double UNUSED  values[],
double  dvalues[],
void UNUSED *  funcParams 
)
static
Parameters
tUNUSED
valuesdynamical variable values
dvaluesdynamical variable time derivative values
funcParamsphysical parameters

Definition at line 429 of file LALSimIMRSpinAlignedEOB.c.