Skip to content

NRTidalv3 waveform models in lalsimulation

Jan Steinhoff requested to merge waveforms/reviews/lalsuite:nrtidalv3-review into master

Description

Adds the new NRTidalv3 waveform models to lalsimulation, namely IMRPhenomXP_NRTidalv3, IMRPhenomXAS_NRTidalv3, and SEOBNRv5_ROM_NRTidalv3.

These waveform models add neutron-star tidal corrections in frequency domain to the respective binary black-hole baseline waveforms. Compared to previous NRTidal models, this model was calibrated to a larger range of numerical simulations of binary neutron stars and includes dynamical tidal effects. The NRTidalv3 model was developed in arXiv:2311.07456.

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

The following public functions in lalsimulation/lib/LALSimIMR.h are modified, in order to allow for passing the tidal parameters in

  • XLALSimIMRSEOBNRv5HMROM: added parameter NRTidal_version_type NRTidal_version
  • XLALSimIMRSEOBNRv5HMROMFrequencySequence: added parameter NRTidal_version_type NRTidal_version
  • XLALSimIMRSEOBNRv5HMROM_Modes: added parameters LALDict *LALParams and NRTidal_version_type NRTidal_version
  • XLALSimIMRSEOBNRv5HMROMFrequencySequence_Modes: added parameter NRTidal_version_type NRTidal_version

and in order to pass the spins in

  • XLALSimNRTunedTidesFDTidalAmplitudeFrequencySeries: added parameters REAL8 chi1 and REAL8 chi2

All these functions provide low-level interfaces to the respective waveform models. As far as we know, they are not used directly by any subsequent analysis pipeline yet, or by any package in the IGWN conda environment.

Review Status

The model has been reviewed, the review statement can be found here, signing off on commit 5e66dcf6 . The review completeness presentation happened at the Waveforms Telecon on 6 June 2024 @ 3pm UTC.

The reviewers are:

The reviewees are:

Edited by Jan Steinhoff

Merge request reports