GmpUserPartitioning Class Reference

Implements the partition method based on a user given table. More...

#include <gmpUserPartitioning.h>

Inheritance diagram for GmpUserPartitioning:

Collaboration diagram for GmpUserPartitioning:

Public Member Functions
virtual bool	checkOptions (const GmLogCategory &logger)
	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
	Virtual method responsible for printing the partition method description.
virtual bool	partition (GmCellMesh *mesh, int numPartitions, QVector< int > &cellPartition, const GmLogCategory &logger) const
	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.
	GmpPartitionMethod (const QVariantMap &options)
Public Member Functions inherited from GmpPartitionMethod
	GmpPartitionMethod (const QVariantMap &options)

Additional Inherited Members
Protected Attributes inherited from GmpPartitionMethod
const QVariantMap &	_options
	The user provided options.

Detailed Description

Implements the partition method based on a user given table.

Member Function Documentation

checkOptions()

bool GmpUserPartitioning::checkOptions ( const GmLogCategory & logger )

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.

Implements GmpPartitionMethod.

partition()

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

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.

Implements GmpPartitionMethod.

printParameters()

void GmpUserPartitioning::printParameters ( const GmLogCategory & logger ) const

virtual

Virtual method responsible for printing the partition method description.

Implements GmpPartitionMethod.

---

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

• inc/gmpUserPartitioning.h
• src/gmpUserPartitioning.cpp