GmpPartitionMethod Class Reference

The abstract interface for a partition method implementation. More...

#include <gmpGemaPCR.h>

Inheritance diagram for GmpPartitionMethod:

Public Member Functions
	GmpPartitionMethod (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 partition method description.
virtual bool	partition (GmCellMesh *mesh, int numPartitions, QVector< int > &cellPartition, const GmLogCategory &logger) const =0
	The cell partition function. It gets as input parameters the cell mesh with a valid cell incidence information plus the number of partitions. On output, it fills cellPartition with the partition number for each mesh cell. The given logger can be used to log error messages if necessary. It should return true on success, false on error.

Protected Attributes
const QVariantMap &	_options
	The user provided options.

Detailed Description

The abstract interface for a partition method implementation.

Member Function Documentation

checkOptions()

virtual bool GmpPartitionMethod::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 GmpMetisPartitioning, and GmpUserPartitioning.

partition()

virtual bool GmpPartitionMethod::partition ( GmCellMesh * mesh, int numPartitions, QVector< int > & cellPartition, const GmLogCategory & logger ) const

pure virtual

The cell partition function. It gets as input parameters the cell mesh with a valid cell incidence information plus the number of partitions. On output, it fills cellPartition with the partition number for each mesh cell. The given logger can be used to log error messages if necessary. It should return true on success, false on error.

Implemented in GmpMetisPartitioning, and GmpUserPartitioning.

printParameters()

virtual void GmpPartitionMethod::printParameters ( const GmLogCategory & logger ) const

pure virtual

Virtual method responsible for printing the partition method description.

Implemented in GmpMetisPartitioning, and GmpUserPartitioning.

---

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

• inc/gmpGemaPCR.h