Skip to content

Update XLALSimInspiralGetSpinFreqFromApproximant with NSBH and IMRPhenomX waveforms

Nathan Johnson-McDaniel requested to merge nathan-johnson-mcdaniel/lalsuite:XLALSimInspiralGetSpinFreqFromApproximant_updates into master

Description

Add IMRPhenomNSBH, SEOBNRv4_ROM_NRTidalv2_NSBH, IMRPhenomXAS, and IMRPhenomXHM waveform models to XLALSimInspiralGetSpinFreqFromApproximant() (all as nonprecessing systems). Also add IMRPhenomNSBH to XLALSimInspiralApproximantAcceptTestGRParams() as not taking testing GR parameters, as directed by Ed Fauchon-Jones. The latter is by analogy with IMRPhenomHM, which also uses the IMRPhenomD phasing, and thus takes testing GR parameters this way, but then adds additional terms that are not affected by the testing GR parameters. Since the same could also be said of the IMRPhenomD_NRTidalv2 model on which IMRPhenomNSBH is based (and whose phasing it shares exactly), I think that there's an argument for saying that IMRPhenomNSBH should be listed as taking testing GR parameters, but I am currently deferring to the waveform developers on this.

I have checked that my test script (/home/nathan.johnson-mcdaniel/lalsim_spin_freq_coding/check_approx_enums_spinfreq_etc.py on LLO) passes with these changes.

API Changes and Justification

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

This is not reviewed, but @maria.haney has looked at a similar update in the past [!1084 (merged)] and can perhaps sign off on this one, as well.

Merge request reports