comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType > Struct Template Reference

Functor performing the initialization of a seeds pool. More...

#include <Seeds_Pool.h>

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

Public Types
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
	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::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >

Functor performing the initialization of a seeds pool.

Template Parameters

CoMMAIndexType	the CoMMA index type for the global index of the mesh
CoMMAWeightType	the CoMMA weight type for the weights (volume or area) of the nodes or edges of the Mesh
CoMMAIntType	the CoMMA type for integers

Member Typedef Documentation

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.

CoMMASetOfPairType

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

using comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::CoMMASetOfPairType = std::set<CoMMAPairType, CustomPairGreaterFunctor<CoMMAPairType> >

Type of set of pairs.

Constructor & Destructor Documentation

SPInitializator()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::SPInitializator ( )

default

Constructor.

~SPInitializator()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

virtual comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::~SPInitializator ( )

virtualdefault

Destructor.

Member Function Documentation

operator()()

template<typename CoMMAIndexType , typename CoMMAWeightType , typename CoMMAIntType >

virtual void comma::SPInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >::operator() ( const std::vector< CoMMAWeightType > &  priority_weights, const std::vector< CoMMAIntType > &  n_bnd_faces, const CoMMAIntType  max_bnd, CoMMAQueueType &  queue  )

pure virtual

Initialize a queue of a seeds pool.

Parameters

[in]	priority_weights	Weights used to set the order of the seed to choose
[in]	n_bnd_faces	Vector telling how many boundary faces each cell has
[in]	max_bnd	Reference value for boundary faces: only cells with boundaries higher than this are considered
[out]	queue	The queue to build

Implemented in comma::SPFullInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >, and comma::SPOnePointInitializator< CoMMAIndexType, CoMMAWeightType, CoMMAIntType >.

---

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

• include/CoMMA/Seeds_Pool.h