Mondaic
This API reference is not for the latest stable Salvus version.

salvus.mesh

The Salvus meshing module.

Functions

nearest_vertical()

def nearest_vertical(
    ref_current: npt.NDArray,
    ref_new: npt.NDArray,
    idx_new: npt.NDArray,
    ref_out: npt.NDArray,
    idx_out: npt.NDArray,
) -> tuple[npt.NDArray, npt.NDArray]: ...

NOTE: This function is deprecated and will be removed in a future release.

Function meant for the “notfound_reduction” in an enclosing element search.

Will choose the point with the smallest value of the third reference coordinate.

Parameters
  • ref_current npt.NDArray — The current reference coordinates.
  • ref_new npt.NDArray — The proposed new reference coordinates.
  • idx_new npt.NDArray — The proposed new element index.
  • ref_out npt.NDArray — Output array for the chosen reference coordinate (required because this function can be compiled as a numba generalized ufunc).
  • idx_out npt.NDArray — Output array for the chosen element ID (required because this function can be compiled as a numba generalized ufunc).
Returns tuple[npt.NDArray, npt.NDArray]

Exceptions

SalvusMeshDeprecationWarning

Warns about deprecated features.

SalvusMeshWarning

Base class for all SalvusMesh warnings.

Submodules