Portage::SearchSimple< SourceMeshType, TargetMeshType > Class Template Reference

A simple, crude search algorithm that utilizes bounding boxes in 2d. More...

#include <search_simple.h>

Public Member Functions

 SearchSimple ()=delete
 Default constructor (disabled) More...
 
 SearchSimple (const SourceMeshType &source_mesh, const TargetMeshType &target_mesh)
 Builds the search structure for finding intersection. More...
 
 SearchSimple (const SearchSimple &)=delete
 Copy constructor (disabled) More...
 
SearchSimpleoperator= (const SearchSimple &)=delete
 Assignment operator (disabled) More...
 
 ~SearchSimple ()=default
 Destructor. More...
 
void operator() (const int cellId, std::vector< int > *candidates) const
 Find the source mesh cells potentially overlapping a given target cell. More...
 

Detailed Description

template<typename SourceMeshType, typename TargetMeshType>
class Portage::SearchSimple< SourceMeshType, TargetMeshType >

A simple, crude search algorithm that utilizes bounding boxes in 2d.

Template Parameters
SourceMeshTypeThe mesh type of the input mesh.
TargetMeshTypeThe mesh type of the output mesh.

This search is only valid for 2d meshes.

Constructor & Destructor Documentation

◆ SearchSimple() [1/3]

template<typename SourceMeshType , typename TargetMeshType >
Portage::SearchSimple< SourceMeshType, TargetMeshType >::SearchSimple ( )
delete

Default constructor (disabled)

◆ SearchSimple() [2/3]

template<typename SourceMeshType , typename TargetMeshType >
Portage::SearchSimple< SourceMeshType, TargetMeshType >::SearchSimple ( const SourceMeshType &  source_mesh,
const TargetMeshType &  target_mesh 
)
inline

Builds the search structure for finding intersection.

Parameters
[in]source_mesh_wrapperPointer to a mesh wrapper for getting the source mesh info.
[in]target_mesh_wrapperPointer to a mesh wrapper for getting the target mesh info.

Constructor for search structure for finding cells from a source mesh that overlap the target mesh.

◆ SearchSimple() [3/3]

template<typename SourceMeshType , typename TargetMeshType >
Portage::SearchSimple< SourceMeshType, TargetMeshType >::SearchSimple ( const SearchSimple< SourceMeshType, TargetMeshType > &  )
delete

Copy constructor (disabled)

◆ ~SearchSimple()

template<typename SourceMeshType , typename TargetMeshType >
Portage::SearchSimple< SourceMeshType, TargetMeshType >::~SearchSimple ( )
default

Destructor.

Member Function Documentation

◆ operator()()

template<typename SourceMeshType , typename TargetMeshType >
void Portage::SearchSimple< SourceMeshType, TargetMeshType >::operator() ( const int  cellId,
std::vector< int > *  candidates 
) const

Find the source mesh cells potentially overlapping a given target cell.

Parameters
[in]cellIdThe index of the cell in the target mesh for which we wish to find the candidate overlapping cells in the source mesh.
[in,out]candidatesPointer to a vector of potential candidate cells in the source mesh.

◆ operator=()

template<typename SourceMeshType , typename TargetMeshType >
SearchSimple& Portage::SearchSimple< SourceMeshType, TargetMeshType >::operator= ( const SearchSimple< SourceMeshType, TargetMeshType > &  )
delete

Assignment operator (disabled)


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