Version:

salvus.mesh

salvus.mesh salvus mesh
The Salvus meshing module.

Functions

nearest_vertical()

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.
SIGNATURE
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]: ...
ARGUMENTS
Required
ref_current
Type:npt.NDArray
Description:
The current reference coordinates.
Required
ref_new
Type:npt.NDArray
Description:
The proposed new reference coordinates.
Required
idx_new
Type:npt.NDArray
Description:
The proposed new element index.
Required
ref_out
Type:npt.NDArray
Description:
Output array for the chosen reference coordinate (required because this function can be compiled as a numba generalized ufunc).
Required
idx_out
Type:npt.NDArray
Description:
Output array for the chosen element ID (required because this function can be compiled as a numba generalized ufunc).
RETURNS
Return type: tuple[npt.NDArray, npt.NDArray]

Exceptions

SalvusMeshDeprecationWarning

Parent classes: salvus.mesh.SalvusMeshWarningbuiltins.DeprecationWarning
Warns about deprecated features.

SalvusMeshWarning

Parent class: builtins.UserWarning
Base class for all SalvusMesh warnings.

Submodules

Used in tutorials

Functionality from this module is used in the following tutorials.
PAGE CONTENTS