simpeg.electromagnetics.static.utils.drapeTopotoLoc

simpeg.electromagnetics.static.utils.drapeTopotoLoc(mesh, pts, active_cells=None, option='top', topo=None, **kwargs)

Drape locations right below discretized surface topography.

This function projects the set of locations provided to the discrete surface topography.

Deprecated since version 0.25.0: drapeTopotoLoc will be removed in SimPEG v0.27.0. Please, use the simpeg.utils.shift_to_discrete_topography() function instead.

Parameters:

meshdiscretize.TensorMesh or discretize.TreeMesh

A 2D tensor or tree mesh.

pts(n, dim) numpy.ndarray

The set of points being projected to the discretize surface topography

active_cellsnumpy.ndarray of int or bool, optional

Index array for all cells lying below the surface topography. Surface topography can be specified using the ‘active_cells’ or ‘topo’ input parameters.

option{“top”, “center”}

Define whether the cell center or entire cell of actice cells must be below the topography. The topography is defined using the ‘topo’ input parameter.

topo(n, dim) numpy.ndarray

Surface topography. Can be used if an active indices array cannot be provided for the input parameter ‘active_cells’.

Returns:

(n, dim) numpy.ndarray

The discrete topography locations.