Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
mesh
/
layered_meshing
/
interface
/
surface

salvus.mesh.layered_meshing.interface.surface

salvus.mesh.layered_meshing.interface.surface salvus mesh layered_meshing interface surface
2-D variable interface.

Classes

Surface

A potentially deformed interface described by two coordinates.
A surface's independent coordinates must be either "x" and "y", or "latitude" and "longitude". Surfaces can be used in 3-D domains only.
A surfaces's digital elevation model (DEM) should always be specified relative to the "reference_elevation" attribute in its xarray representation. As an example if one wanted to apply a simple sinusoidal topography to a domain's top surface by they could do so by using Depth(0.0) as the reference coordinate. If no scaling was present, the resultant topography would then have a peak-to-peak range of 2 m, with the highest peak at 1 m above the domain's top surface and the lowest valley at 1 m below it.
SIGNATURE
class Surface(salvus.mesh.layered_meshing.interface.Interface):
    def __init__(
        self,
        da: xr.DataArray,
        extender: typing.Callable[
            [xr.DataArray, xr.DataArray], xr.DataArray
        ] = salvus.utils.xarray_tools.extrude_like_and_pad,
        interpolation_method: typing.Literal["nearest", "linear"] = "linear",
    ) -> None: ...
ARGUMENTS
Required
da
Type:xr.DataArray
Description:
The interface represented as a DataArray.
Optional
extender
Type:typing.Callable[[xr.DataArray, xr.DataArray], xr.DataArray]
Default value:salvus.utils.xarray_tools.extrude_like_and_pad
Description:
A function that can be used extend the boundaries of the interface past its defined extents.
Optional
interpolation_method
Type:typing.Literal['nearest', 'linear']
Default value:'linear'
Description:
The interpolation method used to evaluate the interface between grid points.

Properties

  • attrs(dict[str, typing.Any])-The object's parameters minus its xarray representation.
  • da_absolute(xr.DataArray)-Get the DEM in absolute coordinates.
  • is_flat(bool)-Query whether the interface is flat.
  • max_elevation(float)-Get the interface's maximum elevation.
  • min_elevation(float)-Get the interface's minimum elevation.
  • reference_elevation(float)-Get the interface's reference elevation.

Class Methods

Surface.from_dataarray()
Construct a generic interface from an xarray DataArray.
Will dispatch to the appropriate interface type based on the DataArray's dimension and heterogeneity (of lack thereof).
SIGNATURE
def from_dataarray(
    da: xr.DataArray,
    extender: typing.Callable[
        [xr.DataArray, xr.DataArray], xr.DataArray
    ] = salvus.utils.xarray_tools.extrude_like_and_pad,
    interpolation_method: typing.Literal["nearest", "linear"] = "linear",
) -> Interface: ...
ARGUMENTS
Required
da
Type:xr.DataArray
Description:
The data array.
Optional
extender
Type:typing.Callable[[xr.DataArray, xr.DataArray], xr.DataArray]
Default value:salvus.utils.xarray_tools.extrude_like_and_pad
Description:
A function that can be used extend the boundaries of the interface past its defined extents.
Optional
interpolation_method
Type:typing.Literal['nearest', 'linear']
Default value:'linear'
Description:
The interpolation method used to evaluate the interface between grid points.
Surface.from_points()
Specify a Surface from its independent Cartesian components.
SIGNATURE
def from_points(
    x: npt.ArrayLike,
    y: npt.ArrayLike,
    dem: npt.ArrayLike,
    reference_elevation: float | Depth | Height,
    interpolation_method: typing.Literal["nearest", "linear"] = "linear",
    extender: typing.Callable[
        [xr.DataArray, xr.DataArray], xr.DataArray
    ] = salvus.utils.xarray_tools.extrude_like_and_pad,
) -> Surface: ...
ARGUMENTS
Required
x
Type:npt.ArrayLike
Description:
The surface's x coordinates.
Required
y
Type:npt.ArrayLike
Description:
The surface's y coordinates.
Required
dem
Type:npt.ArrayLike
Description:
The value of the relative digital elevation model. Must be on the same grid as c.
Required
reference_elevation
Type:float | Depth | Height
Description:
The elevation to which the 0.0 value in the dem parameter refers to. A plain float specifies an absolute reference coordinate, while either a Depth or Height value specifies depth below or height above a domain's top and bottom bounds respectively.
Optional
interpolation_method
Type:typing.Literal['nearest', 'linear']
Default value:'linear'
Description:
Method to use for interpolating this curve between its defined points.
Optional
extender
Type:typing.Callable[[xr.DataArray, xr.DataArray], xr.DataArray]
Default value:salvus.utils.xarray_tools.extrude_like_and_pad
Description:
Callable to use to extend the curve past its defined domain. Useful, for instance, when absorbing boundaries are used to extend the domain.

Methods

Surface.extrude_like_and_pad()
Extrude like another data array and pad if necessary.
SIGNATURE
def extrude_like_and_pad(
    data: XrType,
    like: xr.Dataset | xr.DataArray,
    rel_tol: float = 0.0001,
    update_bounds: bool = False,
) -> XrType: ...
ARGUMENTS
Required
data
Type:XrType
Description:
The input data array or set.
Required
like
Type:xr.Dataset | xr.DataArray
Description:
The data array to extrude and pad like.
Optional
rel_tol
Type:float
Default value:0.0001
Description:
This tolerance is used to determine whether extrusion needs to occur. It will be multiplied by the smallest difference between coordinate value in data. If data does not fully enclose like, but the difference in extents is less than this tolerance, then no extrusion will occur.
Optional
update_bounds
Type:bool
Default value:False
Description:
If True, adjust the coordinate bounds of data so that, for each coordinate, the minimum and maximum values are set to the most extreme values found in either data or like. This is useful for ensuring that small numerical differences (less than the threshold set by rel_tol) do not prevent the coordinates from being treated as matching, effectively "snapping" the bounds to a common range.
Surface.interp_like()
Interpolate this interface onto another DataArray's coordinates.
Will call the interface's extend method to ensure that it spans the coordinates spanned by other with the desired expansion behavior.
SIGNATURE
def interp_like(self, like: xr.DataArray) -> typing.Self: ...
ARGUMENTS
Required
like
Type:xr.DataArray
Description:
The DataArray on which to interpolate this interface.
Surface.map()
Apply a function that modifies the DataArray representation.
All attributes of the DataArray will be kept as is.
SIGNATURE
def map(
    self,
    f: typing.Callable[[xr.DataArray], xr.DataArray],
    as_type: type | None = None,
) -> Interface: ...
ARGUMENTS
Required
f
Type:typing.Callable[[xr.DataArray], xr.DataArray]
Description:
The function used to modify the DataArray. Must take and return a DataArray.
Optional
as_type
Type:type | None
Default value:None
Description:
Modify the type of the mapped DataArray. Useful for upcasting from a Hyperplane to a heterogeneous container, or vice versa.
Surface.map_representation()
Transform this interface's DataArray representation.
SIGNATURE
def map_representation(
    self, f: typing.Callable[[xr.DataArray], xr.DataArray]
) -> typing.Self: ...
ARGUMENTS
Required
f
Type:typing.Callable[[xr.DataArray], xr.DataArray]
Description:
Function transform with.

Used in tutorials

Functionality from this module is used in the following tutorials.
Meshing / Layered Meshing / Layered Meshing 03: Meshing complex geophysical domains
Previous
hyperplane
Next
curve
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS