Reference documentation for deal.II version GIT relicensing-693-g4fb6c325db 2024-05-21 16:20:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Public Member Functions | Private Attributes | List of all members
ArborXWrappers::BoundingBoxNearestPredicate Class Reference

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

Inheritance diagram for ArborXWrappers::BoundingBoxNearestPredicate:
Inheritance graph

Public Member Functions

template<int dim, typename Number >
 BoundingBoxNearestPredicate (const std::vector<::BoundingBox< dim, Number > > &bounding_boxes, const unsigned int n_nearest_neighbors)
unsigned int get_n_nearest_neighbors () const
const ::BoundingBox< 3, float > & get (unsigned int i) const
std::size_t size () const

Private Attributes

unsigned int n_nearest_neighbors
std::vector<::BoundingBox< 3, float > > bounding_boxes

Detailed Description

This class is used by ArborXWrappers::BVH to determine for given bounding boxes which are the nearest bounding boxes/points among the ones used to build the ArborXWrappers::BVH.

The class is not supposed to be used in a polymorphic context.

Definition at line 183 of file access_traits.h.

Constructor & Destructor Documentation

◆ BoundingBoxNearestPredicate()

template<int dim, typename Number >
ArborXWrappers::BoundingBoxNearestPredicate::BoundingBoxNearestPredicate ( const std::vector<::BoundingBox< dim, Number > > &  bounding_boxes,
const unsigned int  n_nearest_neighbors 

Constructor. bounding_boxes is a list of bounding boxes for which are interested in knowing the n_nearest_neighbors nearest bounding boxes used to build the ArborXWrappers::BVH.

Definition at line 143 of file

Member Function Documentation

◆ get_n_nearest_neighbors()

unsigned int ArborXWrappers::BoundingBoxNearestPredicate::get_n_nearest_neighbors ( ) const

Return the number of nearest neighbors we are looking for.

Definition at line 153 of file

◆ get()

const ::BoundingBox< 3, float > & ArborXWrappers::BoundingBoxPredicate::get ( unsigned int  i) const

Return the ith BoundingBox stored in the object.

Definition at line 146 of file

◆ size()

std::size_t ArborXWrappers::BoundingBoxPredicate::size ( ) const

The number of bounding boxes stored in the structure.

Definition at line 140 of file

Member Data Documentation

◆ n_nearest_neighbors

unsigned int ArborXWrappers::BoundingBoxNearestPredicate::n_nearest_neighbors

Definition at line 207 of file access_traits.h.

◆ bounding_boxes

std::vector<::BoundingBox<3, float> > ArborXWrappers::BoundingBoxPredicate::bounding_boxes

Definition at line 149 of file access_traits.h.

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