GmpCellRenumberingMethod< IntVector > Class Template Reference

The abstract interface for a cell renumbering method implementation. Template parameter is the type for a vector of ints for the sorted to original mapping (either GmSingleVector<int> or GmDualVector<int>). More...

#include <gmpGemaCR.h>

Inheritance diagram for GmpCellRenumberingMethod< IntVector >:

Public Member Functions
	GmpCellRenumberingMethod (const QVariantMap &options)
virtual bool	checkOptions (const GmLogCategory &logger)=0
	Virtual method responsible for validating the parameters supplied on the class constructor. Can be used to parse the options. Should returns false and emit an error message in case of errors.
virtual void	printParameters (const GmLogCategory &logger) const =0
	Virtual method responsible for printing the renumbering method description.
virtual QStringList	cellMappingRequiredGroups () const =0
	Returns the list of cell group names required for the cell renumbering, if that is the case. Should return an empty list if the method does not depend on mesh cell groups.
virtual bool	renumber (GmPCR *pcr, IntVector &sortedToOriginal, const GmLogCategory &logger) const =0
	The cell renumbering function. It gets as input parameter a pointer to the PCR object so that it can retrieve coloring or mesh information, as required by the method. It should fill the sortedToOriginal vector with the reordering mapping. On input, the output vector is initially filled with the identity mapping (with size equal to mesh->numCells()). The given logger can be used to log error messages if necessary.
virtual bool	usesSequentialColoring () const =0
	Virtual method that should return true if the renumbering is based on sequentially numbering the cells, according to their order in a mesh coloring. When this method returns true, the cell group objects stored inside the GmpColorData objects created by the coloring, will be replaced by objects that only store the cell range, instead of the original full list of cell ids.

Protected Attributes
const QVariantMap &	_options
	The user provided options.

Detailed Description

template<class IntVector>
class GmpCellRenumberingMethod< IntVector >

The abstract interface for a cell renumbering method implementation. Template parameter is the type for a vector of ints for the sorted to original mapping (either GmSingleVector<int> or GmDualVector<int>).

Member Function Documentation

cellMappingRequiredGroups()

template<class IntVector >

virtual QStringList GmpCellRenumberingMethod< IntVector >::cellMappingRequiredGroups ( ) const

pure virtual

Returns the list of cell group names required for the cell renumbering, if that is the case. Should return an empty list if the method does not depend on mesh cell groups.

Implemented in GmpColorBasedCellRenumbering< IntVector >.

checkOptions()

template<class IntVector >

virtual bool GmpCellRenumberingMethod< IntVector >::checkOptions ( const GmLogCategory & logger )

pure virtual

Virtual method responsible for validating the parameters supplied on the class constructor. Can be used to parse the options. Should returns false and emit an error message in case of errors.

Implemented in GmpColorBasedCellRenumbering< IntVector >.

printParameters()

template<class IntVector >

virtual void GmpCellRenumberingMethod< IntVector >::printParameters ( const GmLogCategory & logger ) const

pure virtual

Virtual method responsible for printing the renumbering method description.

Implemented in GmpColorBasedCellRenumbering< IntVector >.

renumber()

template<class IntVector >

virtual bool GmpCellRenumberingMethod< IntVector >::renumber ( GmPCR * pcr, IntVector & sortedToOriginal, const GmLogCategory & logger ) const

pure virtual

The cell renumbering function. It gets as input parameter a pointer to the PCR object so that it can retrieve coloring or mesh information, as required by the method. It should fill the sortedToOriginal vector with the reordering mapping. On input, the output vector is initially filled with the identity mapping (with size equal to mesh->numCells()). The given logger can be used to log error messages if necessary.

Implemented in GmpColorBasedCellRenumbering< IntVector >.

usesSequentialColoring()

template<class IntVector >

virtual bool GmpCellRenumberingMethod< IntVector >::usesSequentialColoring ( ) const

pure virtual

Virtual method that should return true if the renumbering is based on sequentially numbering the cells, according to their order in a mesh coloring. When this method returns true, the cell group objects stored inside the GmpColorData objects created by the coloring, will be replaced by objects that only store the cell range, instead of the original full list of cell ids.

Implemented in GmpColorBasedCellRenumbering< IntVector >.

---

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

• inc/gmpGemaCR.h