# MeepMeep: fast orbit calculations for exoplanet modelling
# Copyright (C) 2022-2026 Hannu Parviainen
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
"""Multi-expansion-point planet z-velocity (line-of-sight) evaluators with parameter derivatives."""
from numba import njit, prange, types
from numba.extending import overload
from numpy import zeros, floor, ndarray
from ..point3dd.zvelocity import _zvel_cd_w
from ._common import _is_1d_array
@njit(fastmath=True, inline='always')
def _zvel_ow(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs, dvz):
"""Write-into orbit kernel: epoch fold, expansion point lookup, and evaluation.
Writes the seven-parameter gradient into the caller-provided ``(7,)``
buffer ``dvz`` and returns the z velocity; see
:func:`~meepmeep.backends.numba.orbit3dd.position._pos_ow`.
"""
epoch = floor((t - tpa) / p)
tc = t - tpa - epoch * p
ix = ep_table[int(floor(tc / (dt * p)))]
return _zvel_cd_w(tc - ep_times[ix] * p, coeffs[ix], dcoeffs[ix], dvz)
@njit(fastmath=True)
def _zvel_osd(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs):
"""Scalar kernel for :func:`zvel_od`. See that function for documentation."""
dvz = zeros(7)
vz = _zvel_ow(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs, dvz)
return vz, dvz
@njit(fastmath=True)
def zvel_ovd(times, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs):
"""Vector kernel for :func:`zvel_od`. See that function for documentation."""
n = times.size
vzs = zeros(n)
dvzs = zeros((n, 7))
for j in range(n):
vzs[j] = _zvel_ow(times[j], tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs, dvzs[j])
return vzs, dvzs
@njit(fastmath=True, parallel=True)
def zvel_ovdp(times, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs):
"""Parallel (prange) twin of :func:`zvel_ovd`."""
n = times.size
vzs = zeros(n)
dvzs = zeros((n, 7))
for j in prange(n):
vzs[j] = _zvel_ow(times[j], tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs, dvzs[j])
return vzs, dvzs
[docs]
def zvel_od(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs):
"""Planet z-velocity and orbital-parameter derivatives for any orbital phase.
Accepts a scalar time ``t`` or a 1-D array of times and dispatches to the
scalar (:func:`_zvel_osd`) or vector (:func:`zvel_ovd`) kernel at compile time
(inside ``@njit``) or at call time (pure Python).
Cheaper than :func:`~meepmeep.backends.numba.orbit3dd.velocity.vel_od` when
only the line-of-sight component is needed (e.g. for radial-velocity
gradients).
Parameters
----------
t : float or ndarray
Time at which to evaluate the z-velocity and gradient.
tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs :
See :func:`~meepmeep.backends.numba.orbit3dd.position.pos_od`.
Returns
-------
vz : float or ndarray
Line-of-sight velocity [:math:`R_\\star/\\mathrm{day}`]. Arrays of
shape (N,) for an array ``t``.
dvz : ndarray
Gradient w.r.t. ``(tc, p, a, i, e, w, lan)``. Shape (7,) for a
scalar ``t``, (N, 7) for an array ``t``.
"""
if isinstance(t, ndarray):
return zvel_ovd(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs)
return _zvel_osd(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs)
@overload(zvel_od, jit_options={'fastmath': True})
def _zvel_od_overload(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs):
if _is_1d_array(t):
def impl(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs):
return zvel_ovd(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs)
return impl
if isinstance(t, types.Float):
def impl(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs):
return _zvel_osd(t, tpa, p, dt, ep_table, ep_times, coeffs, dcoeffs)
return impl
return None