pybhpt 0.9.4__cp312-cp312-macosx_14_0_arm64.whl

pybhpt/flux.py

@@ -0,0 +1,124 @@
+from cybhpt_full import FluxList as FluxListCython
+from cybhpt_full import flux as FluxCython
+
+class FluxList:
+    """A class for storing fluxes of energy, angular momentum, and Carter constant.
+
+    Parameters
+    ----------
+    fluxes : list of dicts, optional
+        A list containing three dictionaries, each with keys "I" and "H" representing the fluxes at infinity and on the horizon, respectively.
+        If not provided, initializes with zero fluxes for all three components.
+
+    Attributes
+    ----------
+    fluxes : list of dicts
+        A list containing three dictionaries, each with keys "I" and "H" representing the fluxes at infinity and on the horizon, respectively.
+        The first dictionary corresponds to energy flux,
+        the second to angular momentum flux, and the third to Carter constant flux.
+
+    Methods
+    -------
+    __call__():
+        Returns the list of fluxes.
+    """
+    def __init__(self, fluxes=None):
+        if fluxes is None:
+            self.fluxes = [{"I": 0., "H": 0.}, {"I": 0., "H": 0.}, {"I": 0., "H": 0.}]
+        elif len(fluxes) != 3:
+            self.fluxes = [{"I": 0., "H": 0.}, {"I": 0., "H": 0.}, {"I": 0., "H": 0.}]
+        else:
+            self.fluxes = fluxes
+
+    # def __add__(self, fluxlist2):
+    #     for i in range(3):
+    #         for bc in ["H", "I"]:
+    #             self.fluxes[i][bc] += fluxlist2.fluxes[i][bc]
+    
+    @property
+    def energy(self):
+        return self.fluxes[0]
+
+    @property
+    def angularmomentum(self):
+        return self.fluxes[1]
+
+    @property
+    def carterconstant(self):
+        return self.fluxes[2]
+    
+    def __call__(self):
+        return self.fluxes
+
+    
+class FluxMode:
+    """A class for computing fluxes of energy, angular momentum, and Carter constant for a given Teukolsky mode.
+
+    Parameters
+    ----------
+    geo : KerrGeodesic class instance
+        KerrGeodesic object containing the background motion of the point-particle source.
+
+    teuk : TeukolskyMode object
+        TeukolskyMode object containing mode solutions to the point-particle-sourced Teukolsky equation.
+
+    Attributes
+    ----------
+    energy : dict
+        A dictionary containing the energy flux at infinity and on the horizon.
+        The keys are "I" for infinity and "H" for the horizon.
+    angularmomentum : dict
+        A dictionary containing the angular momentum flux at infinity and on the horizon.
+        The keys are "I" for infinity and "H" for the horizon.
+    carterconstant : dict
+        A dictionary containing the Carter constant flux at infinity and on the horizon.
+        The keys are "I" for infinity and "H" for the horizon.
+    fluxes : FluxList
+        A FluxList object containing the energy, angular momentum, and Carter constant fluxes.
+    horizonfluxes : list
+        A list containing the energy, angular momentum, and Carter constant fluxes on the horizon.
+    infinityfluxes : list
+        A list containing the energy, angular momentum, and Carter constant fluxes at infinity.
+    totalfluxes : list
+        A list containing the total fluxes, which are the sum of the horizon and infinity fluxes.
+        """
+    def __init__(self, geo, teuk):
+        self.base = FluxCython(teuk.spinweight, geo.base, teuk.base)
+
+    @property
+    def energy(self):
+        return self.base.energy
+
+    @property
+    def angularmomentum(self):
+        return self.base.angularmomentum
+
+    @property
+    def carterconstant(self):
+        return self.base.carterconstant
+    
+    @property
+    def Edot(self):
+        return self.energy
+    @property
+    def Ldot(self):
+        return self.angularmomentum
+    @property
+    def Qdot(self):
+        return self.carterconstant
+    
+    @property
+    def fluxes(self):
+        return FluxList([self.energy, self.angularmomentum, self.carterconstant])
+
+    @property
+    def horizonfluxes(self):
+        return [self.energy["H"], self.angularmomentum["H"], self.carterconstant["H"]]
+    
+    @property
+    def infinityfluxes(self):
+        return [self.energy["I"], self.angularmomentum["I"], self.carterconstant["I"]]
+    
+    @property
+    def totalfluxes(self):
+        return [self.energy["I"] + self.energy["H"], self.angularmomentum["I"] + self.angularmomentum["H"], self.carterconstant["I"] + self.carterconstant["H"]]

pybhpt/geo.py

@@ -0,0 +1,407 @@
+from cybhpt_full import KerrGeodesic as KerrGeodesicCython
+from cybhpt_full import kerr_geo_V01, kerr_geo_V02, kerr_geo_V11, kerr_geo_V22, kerr_geo_V31, kerr_geo_V32
+from cybhpt_full import kerr_mino_frequencies_wrapper, kerr_orbital_constants_wrapper
+import numpy as np
+
+def kerrgeo_Vt_radial(a, En, Lz, Q, r):
+    return kerr_geo_V01(a, En, Lz, Q, r)
+
+def kerrgeo_Vt_polar(a, En, Lz, Q, theta):
+    return kerr_geo_V02(a, En, Lz, Q, theta)
+
+def kerrgeo_Vr(a, En, Lz, Q, r):
+    return kerr_geo_V11(a, En, Lz, Q, r)
+
+def kerrgeo_Vtheta(a, En, Lz, Q, theta):
+    return kerr_geo_V22(a, En, Lz, Q, theta)
+
+def kerrgeo_Vphi_radial(a, En, Lz, Q, r):
+    return kerr_geo_V31(a, En, Lz, Q, r)
+
+def kerrgeo_Vphi_polar(a, En, Lz, Q, theta):
+    return kerr_geo_V32(a, En, Lz, Q, theta)
+
+def kerr_mino_frequencies(a, p, e, x):
+    """
+    Returns the Mino frequencies of a Kerr geodesic.
+
+    Parameters
+    ----------
+    a : float
+        The black hole spin parameter.
+    p : float
+        The semilatus rectum of the orbit.
+    e : float
+        The eccentricity of the orbit.
+    x : float
+        The inclination of the orbit.
+    
+    Returns
+    -------
+    numpy.ndarray
+        The Mino time frequencies of the orbit.
+    """
+    return kerr_mino_frequencies_wrapper(a, p, e, x)
+
+def kerr_fundamental_frequencies(a, p, e, x):
+    """
+    Returns the fundamental (time) frequencies of a Kerr geodesic.
+    
+    Parameters
+    ----------
+    a : float
+        The black hole spin parameter.
+    p : float
+        The semilatus rectum of the orbit.
+    e : float
+        The eccentricity of the orbit.
+    x : float
+        The inclination of the orbit.
+    
+    Returns
+    -------
+    numpy.ndarray
+        The fundamental frequencies of the orbit.
+    """
+    Ups = kerr_mino_frequencies(a, p, e, x)
+    return Ups[1:]/Ups[0]
+
+def kerr_orbital_constants(a, p, e, x):
+    """
+    Returns the orbital constants of a Kerr geodesic (En, Lz, Qc).
+
+    Parameters
+    ----------
+    a : float
+        The black hole spin parameter.
+    p : float
+        The semilatus rectum of the orbit.
+    e : float
+        The eccentricity of the orbit.
+    x : float
+        The inclination of the orbit. 
+
+    Returns
+    -------
+    numpy.ndarray
+        The orbital constants (En, Lz, Qc) of the orbit.
+    """
+    return kerr_orbital_constants_wrapper(a, p, e, x)
+
+def is_power_of_two(n: int) -> bool:
+    return n > 0 and (n & (n - 1)) == 0
+
+class KerrGeodesic:
+    """
+    Class that produces a Kerr geodesic given the parameters of the orbit.
+    This class is a wrapper around the Cython implementation of the Kerr geodesic
+    and provides a Python interface to the underlying C++ code.
+    Parameters
+    ----------
+    a : float
+        The black hole spin parameter.
+    p : float
+        The semilatus rectum of the orbit.
+    e : float
+        The eccentricity of the orbit.
+    x : float
+        The inclination of the orbit.
+    nsamples : int
+        The number of samples to use for the geodesic. Must be a power of two. Default is 256.
+
+    Attributes
+    ----------
+    blackholespin : float
+        The black hole spin parameter.
+    semilatusrectum : float
+        The semilatus rectum of the orbit.
+    eccentricity : float
+        The eccentricity of the orbit.
+    inclination : float
+        The inclination of the orbit.
+    orbitalenergy : float
+        The orbital energy En of the orbit.
+    orbitalangularmomentum : float
+        Th z-component of the orbital angular momentum Lz of the orbit.
+    carterconstant : float
+        The Carter constant Qc of the orbit.
+    orbitalconstants : numpy.ndarray
+        The orbital constants (En, Lz, Qc) of the orbit.
+    radialroots : numpy.ndarray
+        The roots of the radial equation.
+    polarroots : numpy.ndarray
+        The roots of the polar equation.
+    minofrequencies : numpy.ndarray
+        The orbital frequencies with respect to Mino time.
+    timefrequencies : numpy.ndarray
+        The orbital frequencies with respect to the time coordinate.
+    frequencies : numpy.ndarray
+        The (coordinate time) frequencies of the orbit.
+    carterfrequencies : numpy.ndarray
+        The frequencies for computing Carter constant fluxes.
+    timeradialfourier : numpy.ndarray
+        The Fourier coefficients of coordinate time with respect to the radial Mino phase.
+    timepolarfourier : numpy.ndarray
+        The Fourier coefficients of coordinate time with respect to the polar Mino phase.
+    radialfourier : numpy.ndarray
+        The Fourier coefficients of radial position with respect to the radial Mino phase.
+    polarfourier : numpy.ndarray
+        The Fourier coefficients of polar position with respect to the polar Mino phase.
+    azimuthalradialfourier : numpy.ndarray
+        The Fourier coefficients of azimuthal position with respect to the radial Mino phase.
+    azimuthalpolarfourier : numpy.ndarray
+        The Fourier coefficients of azimuthal position with respect to the polar Mino phase.  
+    """
+    def __init__(self, a, p, e, x, nsamples = 2**8):
+        if a < 0 or a > 1:
+            raise ValueError(f"Black hole spin parameter {a} must be in the range [0, 1].")
+        if not is_power_of_two(nsamples):
+            raise ValueError(f"Number of samples {nsamples} must be a power of 2.")
+
+        self.base = KerrGeodesicCython(a, p, e, x, nsamples)
+        """The base class that contains the Cython implementation of the Kerr geodesic."""
+        self.timeradial = self.base.get_time_accumulation(1)
+        self.timepolar = self.base.get_time_accumulation(2)
+        self.radialpoints = self.base.get_radial_points()
+        self.polarpoints = self.base.get_polar_points()
+        self.azimuthalradial = self.base.get_azimuthal_accumulation(1)
+        self.azimuthalpolar = self.base.get_azimuthal_accumulation(2)
+        self.nsamples = self.base.nsamples
+
+        if np.isnan(self.frequencies).any():
+            raise ValueError(f"Orbital parameters (a, p, e, x) = {self.apex} do not represent a valid bound non-plunging orbit.")
+
+    @property
+    def blackholespin(self):
+        """
+        The black hole spin parameter.
+        """
+        return self.base.blackholespin
+    
+    @property
+    def semilatusrectum(self):
+        """
+        The semilatus rectum of the orbit.
+        """
+        return self.base.semilatusrectum
+    
+    @property
+    def eccentricity(self):
+        """
+        The eccentricity of the orbit.
+        """
+        return self.base.eccentricity
+
+    @property
+    def inclination(self):
+        """
+        The cosine of the inclination angle of the orbit with respect to the equatorial plane.
+        """
+        return self.base.inclination
+    
+    @property
+    def a(self):
+        """
+        The black hole spin parameter.
+        """
+        return self.blackholespin
+    
+    @property
+    def p(self):
+        """
+        The semilatus rectum of the orbit.
+        """
+        return self.semilatusrectum
+    
+    @property
+    def e(self):
+        """
+        The eccentricity of the orbit.
+        """
+        return self.eccentricity
+    
+    @property
+    def x(self):
+        """
+        The inclination of the orbit.
+        """
+        return self.inclination
+    
+    @property
+    def apex(self):
+        """
+        The parameters of the orbit (a, p, e, x).
+        """
+        return np.array([self.blackholespin, self.semilatusrectum, self.eccentricity, self.inclination])
+    
+    @property
+    def orbitalparameters(self):
+        """
+        The parameters of the orbit (a, p, e, x).
+        """
+        return self.apex
+
+    @property
+    def orbitalenergy(self):
+        """
+        The orbital energy En of the orbit.
+        """
+        return self.base.orbitalenergy
+
+    @property
+    def orbitalangularmomentum(self):
+        """
+        The z-component of the orbital angular momentum Lz of the orbit.
+        """
+        return self.base.orbitalangularmomentum
+
+    @property
+    def carterconstant(self):
+        """
+        The Carter constant Qc of the orbit.
+        """
+        return self.base.carterconstant
+
+    @property
+    def orbitalconstants(self):
+        """
+        The orbital constants (En, Lz, Qc) of the orbit.
+        """
+        return np.array([self.orbitalenergy, self.orbitalangularmomentum, self.carterconstant])
+
+    @property
+    def radialroots(self):
+        """
+        The roots of the radial equation.
+        """
+        return self.base.radialroots
+
+    @property
+    def polarroots(self):
+        """
+        The roots of the polar equation.
+        """
+        return self.base.polarroots
+
+    @property
+    def minofrequencies(self):
+        """
+        The orbital frequencies with respect to Mino time.
+        """
+        return self.base.minofrequencies
+
+    @property
+    def timefrequencies(self):
+        """
+        The orbital frequencies with respect to the time coordinate.
+        """
+        return self.base.timefrequencies
+
+    @property
+    def frequencies(self):
+        """
+        The (coordinate time) frequencies of the orbit.
+        """
+        return self.timefrequencies
+
+    @property
+    def carterfrequencies(self):
+        """
+        The frequencies for computing Carter constant fluxes.
+        """
+        return self.base.carterfrequencies
+    
+    @property
+    def timeradialfourier(self):
+        """
+        The Fourier coefficients of coordinate time with respect to the radial Mino phase.
+        """
+        return self.base.get_time_coefficients(1)
+    
+    @property
+    def timepolarfourier(self):
+        """
+        The Fourier coefficients of coordinate time with respect to the polar Mino phase.
+        """
+        return self.base.get_time_coefficients(2)
+    
+    @property
+    def radialfourier(self):
+        """
+        The Fourier coefficients of radial position with respect to the radial Mino phase.
+        """
+        return self.base.get_radial_coefficients()
+    
+    @property
+    def polarfourier(self):
+        """
+        The Fourier coefficients of polar position with respect to the polar Mino phase.
+        """
+        return self.base.get_polar_coefficients()
+    
+    @property
+    def azimuthalradialfourier(self):
+        """
+        The Fourier coefficients of azimuthal position with respect to the radial Mino phase.
+        """
+        return self.base.get_azimuthal_coefficients(1)
+    
+    @property
+    def azimuthalpolarfourier(self):
+        """
+        The Fourier coefficients of azimuthal position with respect to the polar Mino phase.
+        """
+        return self.base.get_azimuthal_coefficients(2)
+    
+    def mode_frequency(self, m, k, n):
+        """
+        Returns the frequency of the mode with azimuthal number m, polar number k, and radial number n.
+        
+        Parameters
+        ----------
+        m : int
+            The azimuthal number of the mode.
+        k : int
+            The polar number of the mode.
+        n : int
+            The radial number of the mode.
+        
+        Returns
+        -------
+        float
+            The frequency of the mode with azimuthal number m, polar number k, and radial number n.
+        """
+        return np.dot(np.array([n, k, m]), (self.frequencies))
+    
+    def minotime(self, t):
+        """
+        Function that returns the Mino time for a given Boyer-Lindquist time.
+
+        Parameters
+        ----------
+        t : float
+            The Boyer-Lindquist time.
+        
+        Returns
+        -------
+        float
+            The Mino time for the given Boyer-Lindquist time.
+        """
+        return self.base.mino_time(t)
+    
+    def __call__(self, la):
+        """
+        Function that returns the position vector for a given Mino time value.
+        Parameters
+        ----------
+        la : float or numpy.ndarray
+            The Mino time value(s). If a numpy array is provided, the function will return a numpy array of the same shape.
+        Returns 
+        -------
+        numpy.ndarray
+            The position vector for the given Mino time value(s).
+        """
+        if isinstance(la, np.ndarray) or isinstance(la, list):
+            return self.base.position_vec(np.array(la))
+        else:
+            return self.base.position(la)