Portage::SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType > Class Template Reference

The search algorithm that is used for the swept face remap. More...

#include <search_swept_face.h>

Public Member Functions

 SearchSweptFace ()=delete
 Default constructor (disabled) More...
 
 SearchSweptFace (const SourceMeshType &source_mesh, const TargetMeshType &target_mesh)
 Builds the search structure for the swept face algorithm. More...
 
 SearchSweptFace (const SearchSweptFace &)=delete
 Copy constructor (disabled) More...
 
SearchSweptFaceoperator= (const SearchSweptFace &)=delete
 Assignment operator (disabled) More...
 
 ~SearchSweptFace ()=default
 Destructor. More...
 
std::vector< int > operator() (const int entityId) const
 Find the source mesh entities that are adjacent to the given target mesh entity through the faces. Topology and indexing of the source and target meshes are assumed to be identical. More...
 

Detailed Description

template<int D, Entity_kind on_what, typename SourceMeshType, typename TargetMeshType>
class Portage::SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType >

The search algorithm that is used for the swept face remap.

Template Parameters
DThe dimension of the problem space.
on_whatThe kind of entity we are doing a search on (NODE, CELL)
SourceMeshTypeThe mesh type of the input mesh.
TargetMeshTypeThe mesh type of the output mesh.

Constructor & Destructor Documentation

◆ SearchSweptFace() [1/3]

template<int D, Entity_kind on_what, typename SourceMeshType , typename TargetMeshType >
Portage::SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType >::SearchSweptFace ( )
delete

Default constructor (disabled)

◆ SearchSweptFace() [2/3]

template<int D, Entity_kind on_what, typename SourceMeshType , typename TargetMeshType >
Portage::SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType >::SearchSweptFace ( const SourceMeshType &  source_mesh,
const TargetMeshType &  target_mesh 
)
inline

Builds the search structure for the swept face algorithm.

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 the search structure that finds mesh entities that are neighbors through the faces. Topology and indexing of the source and target meshes are assumed to be identical.

◆ SearchSweptFace() [3/3]

template<int D, Entity_kind on_what, typename SourceMeshType , typename TargetMeshType >
Portage::SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType >::SearchSweptFace ( const SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType > &  )
delete

Copy constructor (disabled)

◆ ~SearchSweptFace()

template<int D, Entity_kind on_what, typename SourceMeshType , typename TargetMeshType >
Portage::SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType >::~SearchSweptFace ( )
default

Destructor.

Member Function Documentation

◆ operator()()

template<int D, Entity_kind on_what, typename SourceMeshType , typename TargetMeshType >
std::vector<int> Portage::SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType >::operator() ( const int  entityId) const
inline

Find the source mesh entities that are adjacent to the given target mesh entity through the faces. Topology and indexing of the source and target meshes are assumed to be identical.

Parameters
[in]entityIdThe index of the entity in the target mesh for which we wish to find the candidate overlapping entities in the source mesh.
Returns
Vector of potential candidate entities in the source mesh.

◆ operator=()

template<int D, Entity_kind on_what, typename SourceMeshType , typename TargetMeshType >
SearchSweptFace& Portage::SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType >::operator= ( const SearchSweptFace< D, on_what, SourceMeshType, TargetMeshType > &  )
delete

Assignment operator (disabled)


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