Prototypes | |
static REAL8 | PlanckTaper (const REAL8 t, const REAL8 t1, const REAL8 t2) |
Planck taper window. More... | |
static int | EnforcePrimaryMassIsm1 (REAL8 *m1, REAL8 *m2, REAL8 *lambda1, REAL8 *lambda2) |
function to swap masses and lambda to enforce m1 >= m2 More... | |
double | XLALSimNRTunedTidesComputeKappa2T (REAL8 m1_SI, REAL8 m2_SI, REAL8 lambda1, REAL8 lambda2) |
convenient function to compute tidal coupling constant. More... | |
double | XLALSimNRTunedTidesMergerFrequency (const REAL8 mtot_MSUN, const REAL8 kappa2T, const REAL8 q) |
compute the merger frequency of a BNS system. More... | |
static double | SimNRTunedTidesFDTidalPhase (const REAL8 fHz, const REAL8 Xa, const REAL8 Xb, const REAL8 mtot, const REAL8 kappa2T) |
Internal function only. More... | |
static REAL8 | SimNRTunedTidesFDTidalAmplitude (const REAL8 fHz, const REAL8 mtot, const REAL8 kappa2T) |
Tidal amplitude corrections; only available for NRTidalv2; Eq 24 of arxiv:1905.06011. More... | |
int | XLALSimNRTunedTidesSetFDTidalPhase_v2_Coeffs (REAL8 *NRTidalv2_coeffs) |
Set the NRTidalv2 phase coefficients in an array for use here and in the IMRPhenomX*_NRTidalv2 implementation. More... | |
static double | SimNRTunedTidesFDTidalPhase_v2 (const REAL8 fHz, const REAL8 Xa, const REAL8 Xb, const REAL8 mtot, const REAL8 kappa2T) |
NRTunedTidesFDTidalPhase is Eq 22 of https://arxiv.org/abs/1905.06011 and is a function of x = angular_orb_freq^(2/3) More... | |
int | XLALSimNRTunedTidesFDTidalAmplitudeFrequencySeries (const REAL8Sequence *amp_tidal, const REAL8Sequence *fHz, REAL8 m1, REAL8 m2, REAL8 lambda1, REAL8 lambda2) |
Function to call amplitude tidal series only; done for convenience to use for PhenomD_NRTidalv2 and SEOBNRv4_ROM_NRTidalv2. More... | |
int | XLALSimNRTunedTidesFDTidalPhaseFrequencySeries (const REAL8Sequence *phi_tidal, const REAL8Sequence *amp_tidal, const REAL8Sequence *planck_taper, const REAL8Sequence *fHz, REAL8 m1_SI, REAL8 m2_SI, REAL8 lambda1, REAL8 lambda2, NRTidal_version_type NRTidal_version) |
Function to call the frequency domain tidal correction over an array of input frequencies. More... | |
void | XLALSimInspiralGetHOSpinTerms (REAL8 *SS_3p5PN, REAL8 *SSS_3p5PN, REAL8 X_A, REAL8 X_B, REAL8 chi1, REAL8 chi2, REAL8 quadparam1, REAL8 quadparam2) |
Function to add 3.5PN spin-squared and 3.5PN spin-cubed terms. More... | |
Go to the source code of this file.
Planck taper window.
Definition at line 44 of file LALSimNRTunedTides.c.
|
static |
function to swap masses and lambda to enforce m1 >= m2
Definition at line 59 of file LALSimNRTunedTides.c.
convenient function to compute tidal coupling constant.
Eq. 2 in arXiv:1706.02969 given masses and lambda numbers
m1_SI | Mass of companion 1 (kg) |
m2_SI | Mass of companion 2 (kg) |
lambda1 | (tidal deformability of mass 1) / m1^5 (dimensionless) |
lambda2 | (tidal deformability of mass 2) / m2^5 (dimensionless) |
Definition at line 93 of file LALSimNRTunedTides.c.
double XLALSimNRTunedTidesMergerFrequency | ( | const REAL8 | mtot_MSUN, |
const REAL8 | kappa2T, | ||
const REAL8 | q | ||
) |
compute the merger frequency of a BNS system.
Tim's new fit that incorporates mass-ratio and asymptotes to zero for large kappa2T.
mtot_MSUN | total mass of system (solar masses) |
kappa2T | tidal coupling constant. Eq. 2 in arXiv:1706.02969 |
q | mass-ratio q >= 1 |
Definition at line 128 of file LALSimNRTunedTides.c.
|
static |
Internal function only.
Function to call the frequency domain tidal correction. Equation (7) in arXiv:1706.02969
fHz | Gravitational wave frequency (Hz) |
Xa | Mass of companion 1 divided by total mass |
Xb | Mass of companion 2 divided by total mass |
mtot | total mass (Msun) |
kappa2T | tidal coupling constant. Eq. 2 in arXiv:1706.02969 |
Definition at line 169 of file LALSimNRTunedTides.c.
|
static |
Tidal amplitude corrections; only available for NRTidalv2; Eq 24 of arxiv:1905.06011.
fHz | Gravitational wave frequency (Hz) |
mtot | Total mass in solar masses |
kappa2T | tidal coupling constant. Eq. 2 in arXiv:1706.02969 |
Definition at line 214 of file LALSimNRTunedTides.c.
int XLALSimNRTunedTidesSetFDTidalPhase_v2_Coeffs | ( | REAL8 * | NRTidalv2_coeffs | ) |
Set the NRTidalv2 phase coefficients in an array for use here and in the IMRPhenomX*_NRTidalv2 implementation.
Definition at line 241 of file LALSimNRTunedTides.c.
|
static |
NRTunedTidesFDTidalPhase is Eq 22 of https://arxiv.org/abs/1905.06011 and is a function of x = angular_orb_freq^(2/3)
fHz | Gravitational wave frequency (Hz) |
Xa | Mass of companion 1 divided by total mass |
Xb | Mass of companion 2 divided by total mass |
mtot | total mass (Msun) |
kappa2T | tidal coupling constant. Eq. 2 in arXiv:1706.02969 |
Definition at line 260 of file LALSimNRTunedTides.c.
int XLALSimNRTunedTidesFDTidalAmplitudeFrequencySeries | ( | const REAL8Sequence * | amp_tidal, |
const REAL8Sequence * | fHz, | ||
REAL8 | m1, | ||
REAL8 | m2, | ||
REAL8 | lambda1, | ||
REAL8 | lambda2 | ||
) |
Function to call amplitude tidal series only; done for convenience to use for PhenomD_NRTidalv2 and SEOBNRv4_ROM_NRTidalv2.
[out] | amp_tidal | tidal amplitude frequency series |
fHz | list of input Gravitational wave Frequency [Hz or dimensionless] | |
m1 | Mass of companion 1 in solar masses | |
m2 | Mass of companion 2 in solar masses | |
lambda1 | (tidal deformability of mass 1) / m1^5 (dimensionless) | |
lambda2 | (tidal deformability of mass 2) / m2^5 (dimensionless) |
Definition at line 304 of file LALSimNRTunedTides.c.
int XLALSimNRTunedTidesFDTidalPhaseFrequencySeries | ( | const REAL8Sequence * | phi_tidal, |
const REAL8Sequence * | amp_tidal, | ||
const REAL8Sequence * | planck_taper, | ||
const REAL8Sequence * | fHz, | ||
REAL8 | m1_SI, | ||
REAL8 | m2_SI, | ||
REAL8 | lambda1, | ||
REAL8 | lambda2, | ||
NRTidal_version_type | NRTidal_version | ||
) |
Function to call the frequency domain tidal correction over an array of input frequencies.
This is Equation (7) in arXiv:1706.02969 when NRTidal_version is NRTidal_V, or Equations (17)-(21) (for phasing) and Equation (24) (for amplitude) in arXiv:1905.06011 when NRTidal_version is NRTidalv2_V, or Equations (17)-(21) in arXiv:1905.06011 when NRTidal_version is NRTidalv2NoAmpCorr_V. NoNRT_V specifies NO tidal phasing or amplitude is being added. Note internally we use m1>=m2 - this is enforced in the code. So any can be supplied
The model for the tidal phase correction in NRTidal_V/NRTidalv2_V was calibrated up to mass-ratio q=1.5 and kappa2T in [40, 5000]. The upper kappa2T limit is reached roughly for a 1.4+1.4 BNS with lambda = 2700 on both NSs. In the high mass-ratio limit, the BNS merger frequency defined in XLALSimNRTunedTidesMergerFrequency() asymptotes to zero. The waveform amplitude should be tapered away starting at this frequency. Therefore, no explicit limits are enforced.
[out] | phi_tidal | tidal phase frequency series |
[out] | amp_tidal | tidal amplitude frequency series |
[out] | planck_taper | planck tapering to be applied on overall signal |
fHz | list of input Gravitational wave Frequency in Hz to evaluate | |
m1_SI | Mass of companion 1 (kg) | |
m2_SI | Mass of companion 2 (kg) | |
lambda1 | (tidal deformability of mass 1) / m1^5 (dimensionless) | |
lambda2 | (tidal deformability of mass 2) / m2^5 (dimensionless) | |
NRTidal_version | < one of NRTidal_V, NRTidalv2_V or NRTidalv2NoAmpCorr_V or NoNRT_V |
Definition at line 364 of file LALSimNRTunedTides.c.
void XLALSimInspiralGetHOSpinTerms | ( | REAL8 * | SS_3p5PN, |
REAL8 * | SSS_3p5PN, | ||
REAL8 | X_A, | ||
REAL8 | X_B, | ||
REAL8 | chi1, | ||
REAL8 | chi2, | ||
REAL8 | quadparam1, | ||
REAL8 | quadparam2 | ||
) |
Function to add 3.5PN spin-squared and 3.5PN spin-cubed terms.
The spin-squared terms occur with the spin-induced quadrupole moment terms while the spin-cubed terms occur with both spin-induced quadrupole as well as octupole moments. The terms are computed in arXiv:1806.01772 and are explicitly written out in Eq 27 of arXiv:1905.06011. The following terms are specifically meant for BNS systems, and are added to the NRTidalv2 extensions of the approximants IMRPhenomPv2, IMRPhenomD and SEOBNRv4_ROM.
SS_3p5PN | 3.5PN spin-spin tail term containing spin-induced quadrupole moment |
SSS_3p5PN | 3.5 PN spin cubed term containing spin-induced octupole moment |
X_A | Mass fraction m_1/M for first component of binary |
X_B | Mass fraction m_2/M for second component of binary |
chi1 | Aligned component of spin vector of first component of binary |
chi2 | Aligned component of spin vector of second component of binary |
quadparam1 | Spin-induced quadrupole moment parameter for component 1 |
quadparam2 | Spin-induced quadrupole moment parameter for component 2 |
Definition at line 445 of file LALSimNRTunedTides.c.