Portage::SearchPointsByCells< dim, SourceSwarm, TargetSwarm > Class Template Reference

A simple, crude search algorithm that does a linear-time search over a swarm of points. More...

#include <search_points_by_cells.h>

Public Member Functions

 SearchPointsByCells ()=delete
 Default constructor (disabled) More...
 
 SearchPointsByCells (SourceSwarm const &source_swarm, TargetSwarm const &target_swarm, Portage::vector< Point< dim >> const &source_extents, Portage::vector< Point< dim >> const &target_extents, Meshfree::WeightCenter center=Meshfree::Scatter)
 Builds the search structure for finding neighboring points. More...
 
 SearchPointsByCells (SearchPointsByCells const &)=default
 Copy constructor - use default - std::transform needs this. More...
 
SearchPointsByCellsoperator= (SearchPointsByCells const &)=delete
 Assignment operator (disabled) More...
 
 ~SearchPointsByCells ()=default
 Destructor. More...
 
std::vector< int > operator() (int pointId) const
 Find the source swarm points within an appropriate distance of a target point. More...
 

Detailed Description

template<int dim, class SourceSwarm, class TargetSwarm>
class Portage::SearchPointsByCells< dim, SourceSwarm, TargetSwarm >

A simple, crude search algorithm that does a linear-time search over a swarm of points.

Template Parameters
SourceSwarmThe swarm type of the input swarm.
TargetSwarmThe swarm type of the output swarm.

Constructor & Destructor Documentation

◆ SearchPointsByCells() [1/3]

template<int dim, class SourceSwarm , class TargetSwarm >
Portage::SearchPointsByCells< dim, SourceSwarm, TargetSwarm >::SearchPointsByCells ( )
delete

Default constructor (disabled)

◆ SearchPointsByCells() [2/3]

template<int dim, class SourceSwarm , class TargetSwarm >
Portage::SearchPointsByCells< dim, SourceSwarm, TargetSwarm >::SearchPointsByCells ( SourceSwarm const &  source_swarm,
TargetSwarm const &  target_swarm,
Portage::vector< Point< dim >> const &  source_extents,
Portage::vector< Point< dim >> const &  target_extents,
Meshfree::WeightCenter  center = Meshfree::Scatter 
)
inline

Builds the search structure for finding neighboring points.

Parameters
[in]source_swarmPointer to source swarm info.
[in]target_swarmPointer to target swarm info.
[in]source_extentsArray of extents for source particles.
[in]target_extentsArray of extents for target particles.

Constructor for search structure for finding points from a source swarm that are near points in the target swarm.

◆ SearchPointsByCells() [3/3]

template<int dim, class SourceSwarm , class TargetSwarm >
Portage::SearchPointsByCells< dim, SourceSwarm, TargetSwarm >::SearchPointsByCells ( SearchPointsByCells< dim, SourceSwarm, TargetSwarm > const &  )
default

Copy constructor - use default - std::transform needs this.

◆ ~SearchPointsByCells()

template<int dim, class SourceSwarm , class TargetSwarm >
Portage::SearchPointsByCells< dim, SourceSwarm, TargetSwarm >::~SearchPointsByCells ( )
default

Destructor.

Member Function Documentation

◆ operator()()

template<int dim, class SourceSwarm , class TargetSwarm >
std::vector<int> Portage::SearchPointsByCells< dim, SourceSwarm, TargetSwarm >::operator() ( int  pointId) const
inline

Find the source swarm points within an appropriate distance of a target point.

Parameters
[in]pointIdThe index of the point in the target swarm for which we wish to find the candidate neighbor points in the source swarm.
[in,out]candidatesPointer to a vector of potential candidate points in the source swarm.

◆ operator=()

template<int dim, class SourceSwarm , class TargetSwarm >
SearchPointsByCells& Portage::SearchPointsByCells< dim, SourceSwarm, TargetSwarm >::operator= ( SearchPointsByCells< dim, SourceSwarm, TargetSwarm > const &  )
delete

Assignment operator (disabled)


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