map_throats¶

StokesFlow.map_throats(throats, origin, filtered=True)¶

Given a list of throats on a target object, finds indices of those throats on the calling object

Parameters

throats (array_like) – The indices of the throats on the object specified in origin
origin (Base) – The object corresponding to the indices given in throats
filtered (bool, default is True) – If True then a ndarray of indices is returned with missing indices removed, otherwise a named-tuple containing both the indices and a boolean mask with False indicating which locations were not found.

Returns

Throat indices on the calling object corresponding to the same throats on the origin object. Can be an array or a tuple containing an array and a mask, depending on the value of filtered.

Return type

ndarray