GemaPCR
The GeMA PCR (Partition-Color-Renumber) Plugin
Loading...
Searching...
No Matches
GmpNodeRenumberingMethod< IntVector > Class Template Referenceabstract

The abstract interface for a node renumbering method implementation. Template parameters 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 GmpNodeRenumberingMethod< IntVector >:

Public Member Functions

 GmpNodeRenumberingMethod (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 bool renumber (GmValueAccessor *ac, IntVector &sortedToOriginal, const GmLogCategory &logger) const =0
 The node renumbering function. It gets as input parameter an accessor to the mesh coordinates. 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 ac->size()). The given logger can be used to log error messages if necessary.
 

Protected Attributes

const QVariantMap & _options
 The user provided options.
 

Detailed Description

template<class IntVector>
class GmpNodeRenumberingMethod< IntVector >

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

Member Function Documentation

◆ checkOptions()

template<class IntVector >
virtual bool GmpNodeRenumberingMethod< 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 GmpMortonNodeRenumbering< IntVector >.

◆ printParameters()

template<class IntVector >
virtual void GmpNodeRenumberingMethod< IntVector >::printParameters ( const GmLogCategory & logger) const
pure virtual

Virtual method responsible for printing the renumbering method description.

Implemented in GmpMortonNodeRenumbering< IntVector >.

◆ renumber()

template<class IntVector >
virtual bool GmpNodeRenumberingMethod< IntVector >::renumber ( GmValueAccessor * ac,
IntVector & sortedToOriginal,
const GmLogCategory & logger ) const
pure virtual

The node renumbering function. It gets as input parameter an accessor to the mesh coordinates. 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 ac->size()). The given logger can be used to log error messages if necessary.

Implemented in GmpMortonNodeRenumbering< IntVector >.


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