LALSimulation  5.4.0.1-fe68b98
Prototypes | Macros | Variables
LALSimIMRPhenomXHM.c File Reference

Prototypes

static LALDict * IMRPhenomXHM_setup_mode_array (LALDict *lalParams)
 
static int IMRPhenomXHMFDAddMode (COMPLEX16FrequencySeries *hptilde, COMPLEX16FrequencySeries *hctilde, COMPLEX16FrequencySeries *hlmtilde, REAL8 theta, REAL8 phi, INT4 l, INT4 m, INT4 sym)
 
static int IMRPhenomXHM_MultiMode (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1z, REAL8 chi2z, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 
static int IMRPhenomXHM_MultiMode2 (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs_In, IMRPhenomXWaveformStruct *pWF, LALDict *lalParams)
 
int SetupWFArrays (REAL8Sequence **freqs, COMPLEX16FrequencySeries **htildelm, const REAL8Sequence *freqs_In, IMRPhenomXWaveformStruct *pWF, LIGOTimeGPS ligotimegps_zero)
 
int IMRPhenomXHMGenerateFDOneMode (COMPLEX16FrequencySeries **htildelm, const REAL8Sequence *freqs_In, IMRPhenomXWaveformStruct *pWF, UINT4 ell, UINT4 emm, LALDict *lalParams)
 
Routines for IMRPhenomXHM

C code for IMRPhenomXHM phenomenological waveform model.

Author
Cecilio García Quirós, Marta Colleoni, Sascha Husa

This is an aligned-spin frequency domain model with subdomimant modes: 2|2|, 2|1|, 3|3|, 3|2|, 4|4| . See C.García-Quirós et al arXiv:2001.10914 for details. Any studies that use this waveform model should include a reference to this paper.

Note
The model was calibrated to mass-ratios from 1 to 1000. The calibration points will be given in forthcoming papers.
Attention
The model is usable outside this parameter range, and in tests to date gives sensible physical results, but conclusive statements on the physical fidelity of the model for these parameters await comparisons against further numerical-relativity simulations. For more information, see the review wiki under https://git.ligo.org/waveforms/reviews/imrphenomx/wikis/home. DCC link to the paper and supplementary material: https://dcc.ligo.org/P2000011-v2

Waveform flags:

PhenomXHMReleaseVersion: this flag was introduced after the recalibration of the higher modes amplitudes in 122022. The default value is 122022, pointing to the new release. The old release can be recovered setting this option to 122019. For future releases this flag will be updated.

NOTE: The following flags are only intended for further model development and not of general interest to the user. Changes from the implemented default values (https://git.ligo.org/waveforms/reviews/imrphenomxhm-amplitude-recalibration/-/wikis/home) are generally not advised. IMRPhenomXHMInspiral(Intermediate)(Ringdown)Amp(Phase)FreqsVersion: controls the cutting frequencies between regions and the collocation points frequencies IMRPhenomXHMInspiral(Intermediate)(Ringdown)Amp(Phase)FitsVersion: controls the version of the parameter space fits for collocation points values and coefficients IMRPhenomXHMInspiral(Intermediate)(Ringdown)Amp(Phase)Version: controls the version of the ansatz. In the 122022 release the new format allows for more flexibility to choose the collocation points to be used The 122022 release does not modify the phases, so all the Phase flags point to the old value of PhaseVersion. Notice that the PhaseFreqs(Fits)Version flags cannot be modified through LALDict options.

int XLALSimIMRPhenomXHMGenerateFDOneMode (COMPLEX16FrequencySeries **htildelm, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, UINT4 ell, INT4 emm, REAL8 distance, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 Returns the Fourier domain strain of just one mode: h_lm. More...
 
int XLALSimIMRPhenomXHMFrequencySequenceOneMode (COMPLEX16FrequencySeries **htildelm, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, UINT4 ell, INT4 emm, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 Get the model evaluated in a prebuilt frequency array. More...
 
int XLALSimIMRPhenomXHMModes (SphHarmFrequencySeries **hlms, REAL8 m1_SI, REAL8 m2_SI, REAL8 S1z, REAL8 S2z, REAL8 deltaF, REAL8 f_min, REAL8 f_max, REAL8 f_ref, REAL8 phiRef, REAL8 distance, LALDict *LALparams)
 Function to obtain a SphHarmFrequencySeries with the individual modes h_lm. More...
 
int XLALSimIMRPhenomXHM_SpheroidalPhase (REAL8Sequence **phase, const REAL8Sequence *freqs, UINT4 ell, INT4 emm, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 
int XLALSimIMRPhenomXHM_SpheroidalAmplitude (REAL8Sequence **amplitude, const REAL8Sequence *freqs, UINT4 ell, INT4 emm, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 
int XLALSimIMRPhenomXHM (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 Returns the hptilde and hctilde of the multimode waveform for positive frequencies. More...
 
int XLALSimIMRPhenomXHM2 (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1L, REAL8 chi2L, REAL8 f_min, REAL8 f_max, REAL8 deltaF, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 Returns the hptilde and hctilde of the multimode waveform for positive frequencies. More...
 
int XLALSimIMRPhenomXHMFrequencySequence (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, const REAL8Sequence *freqs, REAL8 m1_SI, REAL8 m2_SI, REAL8 chi1z, REAL8 chi2z, REAL8 distance, REAL8 inclination, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 Returns hptilde and hctilde as a complex frequency series with entries exactly at the frequencies specified in the REAL8Sequence *freqs (which can be unequally spaced). More...
 
int XLALSimIMRPhenomXHMAmplitude (REAL8Sequence **amplitude, const REAL8Sequence *freqs, UINT4 ell, INT4 emm, REAL8 m1_SI, REAL8 m2_SI, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 Returns amplitude of one single mode in a custom frequency array. More...
 
int XLALSimIMRPhenomXHMPhase (REAL8Sequence **phase, const REAL8Sequence *freqs, UINT4 ell, INT4 emm, REAL8 m1_SI, REAL8 m2_SI, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 distance, REAL8 phiRef, REAL8 fRef_In, LALDict *lalParams)
 Returns phase of one single mode in a custom frequency array. More...
 
INT4 IMRPhenomXHM_Phase_for_Initialization (double *phase, double *dphase, double Mf, INT4 ell, INT4 emm, IMRPhenomXWaveformStruct *pWF, LALDict *lalParams)
 

Go to the source code of this file.

Macros

#define omp   ignore
 
#define L_MAX   4
 
#define DEBUG   0
 
#define MBAND   0
 

Variables

IMRPhenomX_UsefulPowers powers_of_lalpiHM
 

Macro Definition Documentation

◆ omp

#define omp   ignore

Definition at line 39 of file LALSimIMRPhenomXHM.c.

◆ L_MAX

#define L_MAX   4

Definition at line 42 of file LALSimIMRPhenomXHM.c.

◆ DEBUG

#define DEBUG   0

Definition at line 45 of file LALSimIMRPhenomXHM.c.

◆ MBAND

#define MBAND   0

Definition at line 51 of file LALSimIMRPhenomXHM.c.

Function Documentation

◆ IMRPhenomXHM_setup_mode_array()

static LALDict * IMRPhenomXHM_setup_mode_array ( LALDict *  lalParams)
static

Definition at line 122 of file LALSimIMRPhenomXHM.c.

◆ IMRPhenomXHMFDAddMode()

static int IMRPhenomXHMFDAddMode ( COMPLEX16FrequencySeries *  hptilde,
COMPLEX16FrequencySeries *  hctilde,
COMPLEX16FrequencySeries *  hlmtilde,
REAL8  theta,
REAL8  phi,
INT4  l,
INT4  m,
INT4  sym 
)
static
Parameters
[out]hptildehp series
[out]hctildehc series
hlmtildehlm mode to add
thetaInclination [rad]
phiAzimuthal angle [rad]
ll index of the lm mode
mm index of the lm mode
symEquatorial symmetry

Definition at line 2282 of file LALSimIMRPhenomXHM.c.

◆ IMRPhenomXHM_MultiMode()

static int IMRPhenomXHM_MultiMode ( COMPLEX16FrequencySeries **  hptilde,
COMPLEX16FrequencySeries **  hctilde,
REAL8  m1_SI,
REAL8  m2_SI,
REAL8  chi1z,
REAL8  chi2z,
REAL8  f_min,
REAL8  f_max,
REAL8  deltaF,
REAL8  distance,
REAL8  inclination,
REAL8  phiRef,
REAL8  fRef_In,
LALDict *  lalParams 
)
static
Parameters
[out]hptildeFrequency domain h+ GW strain
[out]hctildeFrequency domain hx GW strain
m1_SIprimary mass [kg]
m2_SIsecondary mass [kg]
chi1zaligned spin of primary
chi2zaligned spin of secondary
f_minStarting GW frequency (Hz)
f_maxEnd frequency; 0 defaults to Mf = 0.3
deltaFSampling frequency (Hz)
distancedistance of source (m)
inclinationinclination of source (rad)
phiRefreference orbital phase (rad)
fRef_InReference frequency
lalParamsLALDict struct

Definition at line 1737 of file LALSimIMRPhenomXHM.c.

◆ IMRPhenomXHM_MultiMode2()

static int IMRPhenomXHM_MultiMode2 ( COMPLEX16FrequencySeries **  hptilde,
COMPLEX16FrequencySeries **  hctilde,
const REAL8Sequence *  freqs_In,
IMRPhenomXWaveformStruct *  pWF,
LALDict *  lalParams 
)
static
Parameters
[out]hptildeFrequency domain h+ GW strain
[out]hctildeFrequency domain hx GW strain
freqs_Inmin and max frequency [Hz]
pWFwaveform parameters
lalParamsLALDict struct

Definition at line 1931 of file LALSimIMRPhenomXHM.c.

◆ SetupWFArrays()

int SetupWFArrays ( REAL8Sequence **  freqs,
COMPLEX16FrequencySeries **  htildelm,
const REAL8Sequence *  freqs_In,
IMRPhenomXWaveformStruct *  pWF,
LIGOTimeGPS  ligotimegps_zero 
)
Parameters
[out]freqsfrequency grid [Hz
[out]htildelmFrequency domain hlm GW strain
freqs_Infmin, fmax [Hz]
pWFWaveform structure with parameters
ligotimegps_zero= {0,0}

Definition at line 168 of file LALSimIMRPhenomXHM.c.

◆ IMRPhenomXHMGenerateFDOneMode()

int IMRPhenomXHMGenerateFDOneMode ( COMPLEX16FrequencySeries **  htildelm,
const REAL8Sequence *  freqs_In,
IMRPhenomXWaveformStruct *  pWF,
UINT4  ell,
UINT4  emm,
LALDict *  lalParams 
)
Parameters
[out]htildelmhlm for one mode *
freqs_Infmin, fmax [Hz] *
pWFstructure of the 22 mode *
ellfirst index of the mode *
emmsecond index of the mode *
lalParamsextra params *

Definition at line 511 of file LALSimIMRPhenomXHM.c.

Variable Documentation

◆ powers_of_lalpiHM

IMRPhenomX_UsefulPowers powers_of_lalpiHM

Definition at line 68 of file LALSimIMRPhenomXHM.c.