extended.py

Base module for performing ray tracing of Hamilton’s equations.

Requires Python packages/modules:
class gme.ode.extended.ExtendedSolution(gmeq: Union[gme.core.equations.Equations, gme.core.equations_extended.EquationsGeodesic, gme.core.equations_extended.EquationsIdtx, gme.core.equations_extended.EquationsIbc], parameters: Dict, **kwargs)

Integrate Hamilton’s equations (ODEs) to propagate a single ray.

__init__(gmeq: Union[gme.core.equations.Equations, gme.core.equations_extended.EquationsGeodesic, gme.core.equations_extended.EquationsIdtx, gme.core.equations_extended.EquationsIbc], parameters: Dict, **kwargs) → None

Initialize class instance.

Parameters

  • gmeq – GME model equations class instance defined in gme.core.equations

  • parameters – dictionary of model parameter values to be used for equation substitutions

  • **kwargs – remaining keyword arguments (see base class for details)

Code

"""
Base module for performing ray tracing of Hamilton's equations.

---------------------------------------------------------------------

Requires Python packages/modules:
  -  :mod:`NumPy <numpy>`
  -  `GME`_

.. _GMPLib: https://github.com/geomorphysics/GMPLib
.. _GME: https://github.com/geomorphysics/GME
.. _Matrix:
    https://docs.sympy.org/latest/modules/matrices/immutablematrices.html

---------------------------------------------------------------------
"""
# Library
import warnings

# import logging
# from functools import lru_cache
# from enum import Enum, auto
from typing import Dict, Callable, Union, Any, List

# NumPy
import numpy as np

# GME
from gme.core.equations import Equations
from gme.core.equations_extended import (
    EquationsGeodesic,
    EquationsIdtx,
    EquationsIbc,
)
from gme.ode.base import BaseSolution

warnings.filterwarnings("ignore")

__all__ = ["ExtendedSolution"]


class ExtendedSolution(BaseSolution):
    """Integrate Hamilton's equations (ODEs) to propagate a single ray."""

    pz0: float
    rays: List

    t_array: np.ndarray
    rx_array: np.ndarray
    rz_array: np.ndarray
    p_array: np.ndarray
    px_array: np.ndarray
    pz_array: np.ndarray
    rdot_array: np.ndarray
    rdotx_array: np.ndarray
    rdotz_array: np.ndarray
    pdot_array: np.ndarray
    pdotx_array: np.ndarray
    pdotz_array: np.ndarray
    tanalpha_array: np.ndarray
    tanbeta_array: np.ndarray
    alpha_array: np.ndarray
    beta_array: np.ndarray
    xiv_p_array: np.ndarray
    xiv_v_array: np.ndarray
    uhorizontal_p_array: np.ndarray
    uhorizontal_v_array: np.ndarray
    cosbeta_array: np.ndarray
    sinbeta_array: np.ndarray
    u_array: np.ndarray
    x_array: np.ndarray
    h_array: np.ndarray
    h_x_array: np.ndarray
    h_z_array: np.ndarray
    dhdx_array: np.ndarray
    beta_vt_array: np.ndarray
    beta_ts_array: np.ndarray

    t_interp_x: Callable
    rz_interp: Callable
    rx_interp_t: Callable
    rz_interp_t: Callable
    x_interp_t: Callable
    p_interp: Callable
    px_interp: Callable
    pz_interp: Callable
    rdot_interp: Callable
    rdotx_interp: Callable
    rdotz_interp: Callable
    pdot_interp: Callable
    pdot_interp_t: Callable
    rdotx_interp_t: Any  # HACK
    rdotz_interp_t: Any  # HACK
    rddotx_interp_t: Callable
    rddotz_interp_t: Callable
    beta_p_interp: Callable
    beta_ts_interp: Callable
    beta_ts_error_interp: Callable
    beta_vt_interp: Callable
    beta_vt_error_interp: Callable
    u_interp: Callable
    uhorizontal_p_interp: Callable
    uhorizontal_v_interp: Callable
    u_from_rdot_interp: Callable
    xiv_v_interp: Callable
    xiv_p_interp: Callable
    alpha_interp: Callable
    h_interp: Callable

    def __init__(
        self,
        gmeq: Union[Equations, EquationsGeodesic, EquationsIdtx, EquationsIbc],
        parameters: Dict,
        **kwargs
    ) -> None:
        """
        Initialize class instance.

        Args:
            gmeq:
                GME model equations class instance defined in
                :mod:`gme.core.equations`
            parameters:
                dictionary of model parameter values to be used for
                equation substitutions
            **kwargs: remaining keyword arguments (see base class for details)
        """
        super().__init__(gmeq, parameters, **kwargs)


#