Skip to main content

composite:nearest_neighbor_operator

Version: 0.0.0

Description

Go through all elements of the source mesh and find the n nearest neighbors in the target mesh. The distance is computed from element center to element center.

Inputs

InputNameExpected type(s)Description
Pin 0
Required
source_meshabstract_meshed_regionMeshed region with the elements for which the nearest neighbors should be found.
Pin 1
Required
target_meshabstract_meshed_regionMesh with the target elements.
Pin 2
Required
number_of_neighborsint32Number of neighbors to be found.

Outputs

OutputNameExpected type(s)Description
Pin 0neighbors_source_to_targetproperty_fieldProperty field with an entry for each element ID of the source mesh with the element ID(s) of the neighbors of the target mesh. See output neighbors_target_to_source for the inverse result (Pin 1).
Pin 1neighbors_target_to_sourceproperty_fieldProperty field with an entry for each element ID of the target mesh with the element ID(s) of the neighbors of the source mesh. The field contains only the elements which have neighbors. See output neighbors_source_to_target for the inverse result (Pin 0)

Configurations

NameExpected type(s)Default valueDescription
mutexboolfalseIf this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

Category: composite

Plugin: composite

Scripting name: nearest_neighbor_operator

Full name: composite.nearest_neighbor_operator

Internal name: composite::nearest_neighbor_operator

License: None

Changelog

  • Version 0.0.0: Initial release.