Skip to content

Add pSEOBNRv4HM_PA model

Description

Adds 2 SEOBNR post-adiabatic models to lalsimulation: SEOBNRv4HM_PA and pSEOBNRv4HM_PA; and makes additional changes to lalinference to allow the sampling of TGR parameters (needed for the use of the latter model). The models will be used in O4 for tests of GR together with the inspiral test (separate merge request). The changes to lalinference have been used in past observing runs with the non-PA base waveform SEOBNRv4HM (onto which SEOBNRv4HM_PA is built).

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

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.

Summary of backwards-incompatible changes:

  • Function XLALSimIMRSpinAlignedEOBWaveformAll has changed signature
  • Function XLALSimIMRSpinAlignedEOBModes has changed signature
  • Function XLALSimIMREOBAttachFitRingdown has changed signature

The changes are necessary in order to be able to pass a LALdict containing the TGR parameters to the waveform model, where they would be used for computing the ringdown waveform modes. These changes will not require changes of code outside of lalsuite, i.e. the changes are not to public APIs.

Review Status

This MR has been the subject of 2 separate reviews:

  • waveform review (status complete), chaired by Marta Colleoni, wiki
  • TGR + lalinference review (status complete), chaired by Gregorio Carullo, wiki
Edited by Deyan Mihaylov

Merge request reports