Skip to content

Added NSBH approximants, IMRPhenomNSBH and SEOBNRv4_ROM_NRTidalv2_NSBH

Description

This merge requests adds the waveform approximants IMRPhenomNSBH and SEOBNRv4_ROM_NRTidalv2_NSBH. The review wiki contains information about the models and tests performed: https://git.ligo.org/waveforms/reviews/nsbh-models

The commit for passes the git CI checks, as documented here: https://git.ligo.org/waveforms/reviews/lalsuite/pipelines/100863

API Changes and Justification

This merge request adds two new waveform approximants that can be called from ChooseFDWaveform, ChooseTDWaveform, and ChooseFDWaveformSequence. The approximants and appropriate parameter space regions are documented in the doxygen documentation.

Additionally there is a new module LALSimNSBHProperties.c which contains several functions describing properties of NSBH systems

  • XLALSimNSBH_fGWinKerr
  • XLALSimNSBH_rKerrISCO
  • XLALSimNSBH_xi_tide
  • XLALSimNSBH_compactness_from_lambda
  • XLALSimNSBH_torus_mass_fit

Backwards Compatible Changes

  • This change introduces no API changes
  • This change adds new API calls

Backwards Incompatible Changes

  • This change modifies an existing API
  • This change removes an existing API

If any of the Backwards Incompatible check boxes are ticked please provide a justification why this change is necessary and why it needs to be done in a backwards incompatible way.

Review Status

The IMRPhenomNSBH and SEOBNRv4_ROM_NRTidalv2_NSBH review was chaired by Frank Ohme. The other reviewers and reviewees were Tim Dietrich, Shrobana Ghosh, Andrew Matas, Jonathan Thompson, Edward Fauchon-Jones. The review concluded on 3 February 2020. The review documentation, resources, and final git hash can be found at https://git.ligo.org/waveforms/reviews/nsbh-models/wikis/home.

Edited by Frank Ohme

Merge request reports