NRTidalv3 utils
ripplegw.waveforms.NRTidalv3_utils
¤
by Robin Chan
_get_merger_frequency(theta: Array)
¤
Computes the merger frequency in Hz of the given system. This is defined in equation (41) in 2311.07456 and the lal source code. Pretty much literally copied from LAL at the moment (XLALSimNRTunedTidesMergerFrequency_v3)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
theta
|
Array
|
Intrinsic parameters with order (m1, m2, chi1, chi2, lambda1, lambda2) |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
The merger frequency in Hz. |
fullTidalPhaseCorrection(Mf: Array, theta_intrinsic: Array, P_P: Float[Array, ' n_freq'])
¤
Returns the NRTidalv3 phase corrections due to tidal and spin effects.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
f
|
Array
|
Frequency array |
required |
theta_intrinsic
|
Array
|
Intrinsic parameters of the system [m1, m2, chi1, chi2, lambda1, lambda2] |
required |
P_P
|
Array
|
Taper function. If no_taper was set to True in the master function, then this is just an array of ones. Otherwise this is the Planck taper |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Array |
The NRTidalv3 phase corrections due to tidal and spin effects |
changePhase_if_min(f, NRTidalv3_phase, valid)
¤
general_planck_taper(x, y1, y2)
¤
get_tidal_phase(M_omega: Array, NRTidalv3_coeffs: Array, PN_coeffs: Array)
¤
Tidal phase correction for NRTidalv3, Eq. (27,30), from Abac, et. al. (2023) (https://arxiv.org/pdf/2311.07456.pdf) Jaxified version of SimNRTunedTidesFDTidalPhase_v3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
M_omega
|
Array
|
Dimensionless angular GW frequency |
required |
NRTidalv3_coeffs
|
Array
|
NRTidalv3 coefficients |
required |
PN_coeffs
|
Array
|
7.5 PN coefficients to be used as constraints |
required |
Returns:
| Name | Type | Description |
|---|---|---|
tidal_phase |
Array
|
Corrections to the phase due to (dynamical) tides |
get_tidal_phase_PN(M_omega, Xa, lambda1, lambda2, PN_coeffs)
¤
PN tidal phase correction, at 7.5PN, to connect with NRTidalv3 Phase post-merger, see Eq. (22) and (45) of https://arxiv.org/pdf/2311.07456.pdf Jaxified version of SimNRTunedTidesFDTidalPhase_PN
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
M_omega
|
Array
|
Dimensionless angular GW frequency |
required |
Xa
|
float
|
Mass of companion 1 divided by total mass |
required |
lambda1
|
float
|
Dimensionless tidal deformability of companion 1 |
required |
lambda2
|
float
|
Dimensionless tidal deformability of companion 2 |
required |
PN_coeffs
|
Array
|
7.5 PN coefficients |
required |
Returns:
| Name | Type | Description |
|---|---|---|
tidal_phasePN |
Array
|
PN tidal phase correction, at 7.5PN, to connect with NRTidalv3 Phase post-merger |
get_tidalphasePN_coeffs(theta_intrinsic: Array)
¤
Coefficients or the PN tidal phase correction, at 7.5PN, to connect with NRTidalv3 Phase post-merger, see Eq. (45) of https://arxiv.org/pdf/2311.07456.pdf XLALSimNRTunedTidesSetFDTidalPhase_PN_Coeffs
get_NRTidalv3_coefficients(theta_intrinsic: Array, PN_coeffs)
¤
Set the NRTidalv3 effective love number and phase coefficients in an array for use here and in the IMRPhenomX*_NRTidalv3 implementation XLALSimNRTunedTidesSetFDTidalPhase_v3_Coeffs