XP* option for hard error depending on the beta angle behaviour
Description
This implements a feature-request by @soichiro.morisaki to throw a hard error in XPHM for cases with the discontinuities discussed in #737.
There are three options:
- 0: standard behaviour (default)
- 1: throw error if initially
L+S_{||}<0
and then flips the sign during the evolution due to unphysical growth of the PN L. - 2: throw error if the initial opening angle > pi/2
This option is activated with
lalsimulation.SimInspiralWaveformParamsInsertPhenomXPOpeningAngleError(lalparams, 1)
In Bilby, it can be activated with
waveform-arguments={'PhenomXPOpeningAngleError':1}
The default value is zero.
Tagging @antoni.ramos-buades, @geraint.pratten.
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.
Review Status
Please provide details on any reviews related to this change and and the associated reviewers.
Edited by Cecilio Garcia-Quiros