CoMMA 1.3.2
A geometric agglomerator for unstructured meshes
Loading...
Searching...
No Matches
comma::SPOnePointInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType > Struct Template Reference

Functor performing the one-point initialization of a seeds pool. More...

#include <Seeds_Pool.h>

Inheritance diagram for comma::SPOnePointInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >:
comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >

Public Types

using BaseClass = SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >
 Parent class. More...
 
using CoMMAPairType = std::pair< CoMMAIndexType, CoMMAWeightType >
 Type of pair. More...
 
using CoMMAQueueType = std::deque< CoMMAIndexType >
 Type of queue which holds seeds. More...
 
- Public Types inherited from comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >
using CoMMAPairType = std::pair< CoMMAIndexType, CoMMAWeightType >
 Type of pair. More...
 
using CoMMAQueueType = std::deque< CoMMAIndexType >
 Type of queue which holds seeds. More...
 
using CoMMASetOfPairType = std::set< CoMMAPairType, CustomPairGreaterFunctor< CoMMAPairType > >
 Type of set of pairs. More...
 

Public Member Functions

 SPOnePointInitializator ()
 Constructor. More...
 
 ~SPOnePointInitializator () override=default
 Destructor. More...
 
void operator() (const std::vector< CoMMAWeightType > &priority_weights, const std::vector< CoMMAIntType > &n_bnd_faces, const CoMMAIntType max_bnd, CoMMAQueueType &queue) override
 Initialize a queue of a seeds pool. More...
 
- Public Member Functions inherited from comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >
 SPInitializator ()=default
 Constructor. More...
 
virtual ~SPInitializator ()=default
 Destructor. More...
 
virtual void operator() (const std::vector< CoMMAWeightType > &priority_weights, const std::vector< CoMMAIntType > &n_bnd_faces, const CoMMAIntType max_bnd, CoMMAQueueType &queue)=0
 Initialize a queue of a seeds pool. More...
 

Detailed Description

template<typename CoMMAIndexType, typename CoMMAWeightType, typename CoMMAIntType>
struct comma::SPOnePointInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >

Functor performing the one-point initialization of a seeds pool.

Template Parameters
CoMMAIndexTypethe CoMMA index type for the global index of the mesh
CoMMAWeightTypethe CoMMA weight type for the weights (volume or area) of the nodes or edges of the Mesh
CoMMAIntTypethe CoMMA type for integers

Member Typedef Documentation

◆ BaseClass

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >
using comma::SPOnePointInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::BaseClass = SPInitializator<CoMMAIndexType, CoMMAWeightType, CoMMAIntType>

Parent class.

◆ CoMMAPairType

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >
using comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::CoMMAPairType = std::pair<CoMMAIndexType, CoMMAWeightType>

Type of pair.

◆ CoMMAQueueType

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >
using comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::CoMMAQueueType = std::deque<CoMMAIndexType>

Type of queue which holds seeds.

Constructor & Destructor Documentation

◆ SPOnePointInitializator()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >
comma::SPOnePointInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::SPOnePointInitializator ( )
inline

Constructor.

◆ ~SPOnePointInitializator()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >
comma::SPOnePointInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::~SPOnePointInitializator ( )
overridedefault

Destructor.

Member Function Documentation

◆ operator()()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >
void comma::SPOnePointInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::operator() ( const std::vector< CoMMAWeightType > &  priority_weights,
const std::vector< CoMMAIntType > &  n_bnd_faces,
const CoMMAIntType  max_bnd,
CoMMAQueueType queue 
)
inlineoverridevirtual

Initialize a queue of a seeds pool.

Parameters
[in]priority_weightsWeights used to set the order of the seed to choose
[in]n_bnd_facesVector telling how many boundary faces each cell has
[in]max_bndReference value for boundary faces: only cells with boundaries higher than this are considered
[out]queueThe queue to build

Implements comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >.


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