SEOBNRv4HMROM: automatic hybridization of ROM with TaylorF2
Description
Extension of the SEOBNRv4HM_ROM model to lower frequencies by automatically hybridizing against multi-modal TaylorF2 waveforms. The hybridized model supports can be used as a non-tidal base waveform for low mass binaries such as binary neutron stars and neutron-star black holes.
Review wiki: https://git.ligo.org/waveforms/reviews/SEOBNRv4HM_ROM/-/wikis/home#tests-for-hybridization-of-the-rom-with-pn
API Changes and Justification
Backwards Compatible Changes
-
This change introduces no API changes -
This change adds new API calls
The new functions XLALSimIMRSEOBNRv4HMROMFrequencySequence
and XLALSimIMRSEOBNRv4HMROMFrequencySequence_Modes
provide access to waveform polarizations or modes at user specified frequencies as needed to support ROQs.
Backwards Incompatible Changes
-
This change modifies an existing API
XLALSimIMRSEOBNRv4HMROM
and XLALSimIMRSEOBNRv4HMROM_Modes
: add bool use_hybridization
to switch hybridization of the ROM with TaylorF2 on or off.
These functions are not intended to be called by users, although they can be. Users should call XLALSimChooseFDWaveform
instead which has an unchanged API.
-
This change removes an existing API
Review Status
The review for this extension was closed and presented on March 11, 2021.
Review wiki: https://git.ligo.org/waveforms/reviews/SEOBNRv4HM_ROM/-/wikis/home#tests-for-hybridization-of-the-rom-with-pn
Reviewers: Jonathan Gair (chair), Stas Babak, Bhooshan Gadre, Cecilio Garcia-Quiros Reviewees: Sylvain Marsat, Michael Pürrer, Roberto Cotesta