|
|
|
# Module `LALSimSEOBNRv4HMROM_NRTidal.c`
|
|
|
|
* Externally accessible functions
|
|
|
|
* `XLALSimIMRSEOBNRv4HMROMNSBH`: get h+ and hx on Nyquist grid
|
|
|
|
* `XLALSimIMRSEOBNRv4HMROMNSBHFrequencySequence`: get h+ and hx on arbitrary grid for ROQ
|
|
|
|
* `XLALSimIMRSEOBNRv4HMROMNSBH_Modes`: get hlm on Nyquist grid
|
|
|
|
* `XLALSimIMRSEOBNRv4HMROMNSBHFrequencySequence_Modes`: get hlm on arbitrary grid (AFAIK this is not directly useful for anything, but I added it for completeness)
|
|
|
|
* Internal functions
|
|
|
|
* `SEOBNRv4HMROMNSBH_Modes_Core`: Main function that does the work.
|
|
|
|
* `SEOBNRv4HMROM_NRTidal_Core`: Computes h+ and hx by calling `SEOBNRv4HMROMNSBH_Modes_Core` and combining the results.
|
|
|
|
* `SEOBROMComputehplushcrossFromhlm`: Copy of an internal function in `SEOBNRv4HMROM.c`. Computes h+ and hx from modes.
|
|
|
|
* `Self_spin_phase_contributions`: Copy of an internal function in `SEOBNRv4ROM_NRTidal.c`. Computes spin corrections for NRTidal model.
|
|
|
|
|
|
|
|
# Call signatures
|
|
|
|
|
|
|
|
## External interface functions
|
|
|
|
```
|
|
|
|
int XLALSimIMRSEOBNRv4HMROMNRTidal(
|
|
|
|
struct tagCOMPLEX16FrequencySeries **hptilde, /**< Output: Frequency-domain waveform h+ */
|
|
|
|
struct tagCOMPLEX16FrequencySeries **hctilde, /**< Output: Frequency-domain waveform hx */
|
|
|
|
REAL8 phiRef, /**< Phase at reference time */
|
|
|
|
REAL8 deltaF, /**< Sampling frequency (Hz) */
|
|
|
|
REAL8 fLow, /**< Starting GW frequency (Hz) */
|
|
|
|
REAL8 fHigh, /**< End frequency; 0 defaults to Mf=0.14 */
|
|
|
|
REAL8 fRef, /**< Reference frequency (Hz); 0 defaults to fLow */
|
|
|
|
REAL8 distance, /**< Distance of source (m) */
|
|
|
|
REAL8 inclination, /**< Inclination of source (rad) */
|
|
|
|
REAL8 m1_SI, /**< Mass of neutron star 1 (kg) */
|
|
|
|
REAL8 m2_SI, /**< Mass of neutron star 2 (kg) */
|
|
|
|
REAL8 chi1, /**< Dimensionless aligned component spin of NS 1 */
|
|
|
|
REAL8 chi2, /**< Dimensionless aligned component spin of NS 2 */
|
|
|
|
REAL8 lambda1, /**< Dimensionless tidal deformability of NS 1 */
|
|
|
|
REAL8 lambda2, /**< Dimensionless tidal deformability of NS 2 */
|
|
|
|
LALDict *LALparams, /**< linked list containing the extra testing GR parameters */
|
|
|
|
NRTidal_version_type NRTidal_version /**< Version of NRTides; can be one of NRTidal or NRTidalv2NoAmpCorr */
|
|
|
|
)
|
|
|
|
|
|
|
|
int XLALSimIMRSEOBNRv4HMROMNRTidalFrequencySequence(
|
|
|
|
struct tagCOMPLEX16FrequencySeries **hptilde, /**< Output: Frequency-domain waveform h+ */
|
|
|
|
struct tagCOMPLEX16FrequencySeries **hctilde, /**< Output: Frequency-domain waveform hx */
|
|
|
|
const REAL8Sequence *freqs, /**< Frequency points at which to evaluate the waveform (Hz) */
|
|
|
|
REAL8 phiRef, /**< Phase at reference time */
|
|
|
|
REAL8 fRef, /**< Reference frequency (Hz); 0 defaults to fLow */
|
|
|
|
REAL8 distance, /**< Distance of source (m) */
|
|
|
|
REAL8 inclination, /**< Inclination of source (rad) */
|
|
|
|
REAL8 m1_SI, /**< Mass of neutron star 1 (kg) */
|
|
|
|
REAL8 m2_SI, /**< Mass of neutron star 2 (kg) */
|
|
|
|
REAL8 chi1, /**< Dimensionless aligned component spin of NS 1 */
|
|
|
|
REAL8 chi2, /**< Dimensionless aligned component spin of NS 2 */
|
|
|
|
REAL8 lambda1, /**< Dimensionless tidal deformability of NS 1 */
|
|
|
|
REAL8 lambda2, /**< Dimensionless tidal deformability of NS 2 */
|
|
|
|
LALDict *LALparams, /**< linked list containing the extra testing GR parameters */
|
|
|
|
NRTidal_version_type NRTidal_version /**< Version of NRTides; can be one of NRTidal or NRTidalv2NoAmpCorr */
|
|
|
|
)
|
|
|
|
|
|
|
|
int XLALSimIMRSEOBNRv4HMROMNSBH_Modes(
|
|
|
|
SphHarmFrequencySeries **H_lm, /**< Output: Frequency-domain hlm */
|
|
|
|
UNUSED REAL8 phiRef, /**< Phase at reference time */
|
|
|
|
UNUSED REAL8 deltaF, /**< Sampling frequency (Hz) */
|
|
|
|
REAL8 f_Low, /**< Starting GW frequency (Hz) */
|
|
|
|
UNUSED REAL8 f_High, /**< End frequency; 0 defaults to Mf=0.14 */
|
|
|
|
REAL8 fRef, /**< Reference frequency unused here */
|
|
|
|
REAL8 distance, /**< Reference frequency (Hz); 0 defaults to fLow */
|
|
|
|
REAL8 m1_SI, /**< Mass of companion 1 (kg) */
|
|
|
|
REAL8 m2_SI, /**< Mass of companion 2 (kg) */
|
|
|
|
REAL8 chi1, /**< Dimensionless aligned component spin 1 */
|
|
|
|
REAL8 chi2, /**< Dimensionless aligned component spin 2 */
|
|
|
|
REAL8 lambda1, /**< Dimensionless tidal parameter */
|
|
|
|
REAL8 lambda2, /**< Dimensionless tidal parameter */
|
|
|
|
NRTidal_version_type NRTidal_version, /**< NRTidal version */
|
|
|
|
UNUSED LALDict *LALparams, /**< LAL dictionary containing accessory parameters */
|
|
|
|
UNUSED INT4 nk_max, /**< Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 */
|
|
|
|
UNUSED UINT4 nModes, /**< Number of modes to use. This should be 1 for SEOBNRv4_ROM and 5 for SEOBNRv4HM_ROM */
|
|
|
|
UNUSED bool use_hybridization /**< Whether the ROM should be hybridized */
|
|
|
|
)
|
|
|
|
|
|
|
|
int XLALSimIMRSEOBNRv4HMROMNSBHFrequencySequence_Modes(
|
|
|
|
SphHarmFrequencySeries **hlm, /**< Output: Frequency-domain hlm */
|
|
|
|
const REAL8Sequence *freqs, /**< Frequency points at which to evaluate the waveform (Hz) */
|
|
|
|
UNUSED REAL8 phiRef, /**< Phase at reference time */
|
|
|
|
REAL8 fRef, /**< Reference frequency unused here */
|
|
|
|
REAL8 distance, /**< Reference frequency (Hz); 0 defaults to fLow */
|
|
|
|
REAL8 m1_SI, /**< Mass of companion 1 (kg) */
|
|
|
|
REAL8 m2_SI, /**< Mass of companion 2 (kg) */
|
|
|
|
REAL8 chi1, /**< Dimensionless aligned component spin 1 */
|
|
|
|
REAL8 chi2, /**< Dimensionless aligned component spin 2 */
|
|
|
|
REAL8 lambda1, /**< Dimensionless tidal parameter */
|
|
|
|
REAL8 lambda2, /**< Dimensionless tidal parameter */
|
|
|
|
NRTidal_version_type NRTidal_version, /**< NRTidal version */
|
|
|
|
UNUSED LALDict *LALparams, /**< LAL dictionary containing accessory parameters */
|
|
|
|
UNUSED INT4 nk_max, /**< Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 */
|
|
|
|
UNUSED UINT4 nModes, /**< Number of modes to use. This should be 1 for SEOBNRv4_ROM and 5 for SEOBNRv4HM_ROM */
|
|
|
|
UNUSED bool use_hybridization /**< Whether the ROM should be hybridized */
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Core functions
|
|
|
|
```
|
|
|
|
|
|
|
|
int SEOBNRv4HMROMNSBH_Modes_Core(
|
|
|
|
SphHarmFrequencySeries **H_lm, /**< Output: Frequency-domain hlm */
|
|
|
|
UNUSED REAL8 phiRef, /**< Phase at reference time */
|
|
|
|
const REAL8Sequence *freqs_in, /**< Frequency points at which to evaluate the waveform (Hz) */
|
|
|
|
UNUSED REAL8 deltaF, /**< Sampling frequency (Hz) */
|
|
|
|
REAL8 f_Low, /**< Starting GW frequency (Hz) */
|
|
|
|
UNUSED REAL8 f_High, /**< End frequency; 0 defaults to Mf=0.14 */
|
|
|
|
REAL8 fRef, /**< Reference frequency unused here */
|
|
|
|
REAL8 distance, /**< Reference frequency (Hz); 0 defaults to fLow */
|
|
|
|
REAL8 m1_SI, /**< Mass of companion 1 (kg) */
|
|
|
|
REAL8 m2_SI, /**< Mass of companion 2 (kg) */
|
|
|
|
REAL8 chi1, /**< Dimensionless aligned component spin 1 */
|
|
|
|
REAL8 chi2, /**< Dimensionless aligned component spin 2 */
|
|
|
|
REAL8 lambda1, /**< Dimensionless tidal parameter */
|
|
|
|
REAL8 lambda2, /**< Dimensionless tidal parameter */
|
|
|
|
NRTidal_version_type NRTidal_version, /**< NRTidal version */
|
|
|
|
UNUSED LALDict *LALparams, /**< LAL dictionary containing accessory parameters */
|
|
|
|
UNUSED INT4 nk_max, /**< Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 */
|
|
|
|
UNUSED UINT4 nModes, /**< Number of modes to use. This should be 1 for SEOBNRv4_ROM and 5 for SEOBNRv4HM_ROM */
|
|
|
|
UNUSED bool use_hybridization /**< Whether the ROM should be hybridized */
|
|
|
|
)
|
|
|
|
``` |
|
|
\ No newline at end of file |
