Skip to content

Commit

Permalink
Add note about how the subdomain boundaries are defined
Browse files Browse the repository at this point in the history
  • Loading branch information
sfield17 committed Aug 25, 2024
1 parent 9b6716f commit 45187bc
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion gwsurrogate/surrogate.py
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,7 @@ class SEOBNRv4PHMSur(SurrogateEvaluator):
IMPORTANT NOTES:
===============
================
The original SEOBNRv4PHM model (arXiv:2004.09442) parameterizes the
direction of the BH spins relative to the Newtonian orbital angular momentum
Expand Down Expand Up @@ -2642,6 +2642,18 @@ def get_subdomain_ID(q, chiA0, chiB0):
q : Mass ratio, mA/mB >= 1.
chiA0: Dimensionless spin vector of the heavier black hole.
chiB0: Dimensionless spin vector of the lighter black hole.
IMPORTANT NOTES:
================
Subdomains are defined based on the effective spin parameter
as computed in the early inspiral. While the effective spin
parameter is nearly constant throughout the inspiral it can change
by small amounts. Surrogates built in each subdomain are valid over
a larger region of the parameter space than the subdomain itself,
which helps in ensuring the model is accurate when evaluated
on a subdomain boundary and with spins specified at different
times/frequencies throughout the inspiral.
"""
chi1z = chiA0[2]
chi2z = chiB0[2]
Expand Down

0 comments on commit 45187bc

Please sign in to comment.