Reference documentation for deal.II version 9.4.0
\(\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\}}\)
Public Member Functions | Private Attributes | List of all members
ArborXWrappers::SphereNearestPredicate Class Reference

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

Inheritance diagram for ArborXWrappers::SphereNearestPredicate:
[legend]

Public Member Functions

template<int dim, typename Number >
 SphereNearestPredicate (const std::vector< std::pair<::Point< dim, Number >, Number > > &spheres, const unsigned int n_nearest_neighbors)
 
unsigned int get_n_nearest_neighbors () const
 
const std::pair<::Point< 3, float >, float > & get (unsigned int) const
 
std::size_t size () const
 

Private Attributes

unsigned int n_nearest_neighbors
 
std::vector< std::pair<::Point< 3, float >, float > > spheres
 

Detailed Description

This class defines a predicate used by ArborXWrappers::BVH to determine, for the given spheres, which are the nearest bounding boxes/points among the ones used to build the ArborXWrappers::BVH.

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

Definition at line 278 of file access_traits.h.

Constructor & Destructor Documentation

◆ SphereNearestPredicate()

template<int dim, typename Number >
ArborXWrappers::SphereNearestPredicate::SphereNearestPredicate ( const std::vector< std::pair<::Point< dim, Number >, Number > > &  spheres,
const unsigned int  n_nearest_neighbors 
)

Constructor. spheres is a list of spheres for which we are interested in the n_nearest_neighbors in the ArborXWrappers::BVH bounding boxes/points.

Definition at line 200 of file access_traits.cc.

Member Function Documentation

◆ get_n_nearest_neighbors()

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

Return the number of nearest neighbors we are looking for.

Definition at line 210 of file access_traits.cc.

◆ get()

const std::pair<::Point< 3, float >, float > & ArborXWrappers::SpherePredicate::get ( unsigned int  i) const

Return the ith sphere stored in the object.

Definition at line 239 of file access_traits.cc.

◆ size()

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

The number of spheres stored in the structure.

Definition at line 233 of file access_traits.cc.

Member Data Documentation

◆ n_nearest_neighbors

unsigned int ArborXWrappers::SphereNearestPredicate::n_nearest_neighbors
private

Definition at line 302 of file access_traits.h.

◆ spheres

std::vector<std::pair<::Point<3, float>, float> > ArborXWrappers::SpherePredicate::spheres
privateinherited

Definition at line 242 of file access_traits.h.


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