#include <deal.II/arborx/distributed_tree.h>

Detailed Description

This class implements a wrapper around ArborX::DistributedTree, the distributed version of ArborX::BVH.

Definition at line 37 of file distributed_tree.h.

Public Member Functions
template<int dim, typename Number>
	DistributedTree (const MPI_Comm comm, const std::vector< BoundingBox< dim, Number > > &bounding_boxes)
template<int dim, typename Number>
	DistributedTree (const MPI_Comm comm, const std::vector< Point< dim, Number > > &points)
template<typename QueryType>
std::pair< std::vector< std::pair< int, int > >, std::vector< int > >	query (const QueryType &queries)

Private Attributes
ArborX::DistributedTree< Kokkos::HostSpace >	distributed_tree

Constructor & Destructor Documentation

◆ DistributedTree() [1/2]

template<int dim, typename Number>

ArborXWrappers::DistributedTree::DistributedTree	(	const MPI_Comm	comm,
		const std::vector< BoundingBox< dim, Number > > &	bounding_boxes )

Constructor. Use a vector of BoundingBox bounding_boxes as primitives. The BoundingBox objects in bounding_boxes are local to the MPI process.

Definition at line 85 of file distributed_tree.h.

◆ DistributedTree() [2/2]

template<int dim, typename Number>

ArborXWrappers::DistributedTree::DistributedTree	(	const MPI_Comm	comm,
		const std::vector< Point< dim, Number > > &	points )

Constructor. Use a vector of points as primitives. The Point objects in points are local to the MPI process.

Definition at line 96 of file distributed_tree.h.

Member Function Documentation

◆ query()

template<typename QueryType>

std::pair< std::vector< std::pair< int, int > >, std::vector< int > > ArborXWrappers::DistributedTree::query ( const QueryType & queries )

Return the indices and the MPI ranks of those BoundingBox objects that satisfy the queries. Because queries can contain multiple queries, the function returns a pair of indices and ranks and the associated offsets.

Valid QueryType classes are ArborXWrappers::BoundingBoxIntersectPredicate, ArborXWrappers::BoundingBoxNearestPredicate, ArborXWrappers::PointIntersectPredicate, ArborXWrappers::PointNearestPredicate, ArborXWrappers::SphereIntersectPredicate, and ArborXWrappers::SphereNearestPredicate.

Definition at line 106 of file distributed_tree.h.

Member Data Documentation

◆ distributed_tree

ArborX::DistributedTree<Kokkos::HostSpace> ArborXWrappers::DistributedTree::distributed_tree

private

Underlying ArborX object.

Definition at line 79 of file distributed_tree.h.

The documentation for this class was generated from the following file:

include/deal.II/arborx/distributed_tree.h