Public Member Functions

apf::Splitter Class Reference

Splits a mesh part into many. More...

List of all members.

Public Member Functions

virtual Migrationsplit (MeshTag *weights, double tolerance, int multiple)=0
 call the underlying split algorithm

Detailed Description

Splits a mesh part into many.

usually the construction of a specific Splitter will ask for a mesh object, which is the part to be acted upon


Member Function Documentation

virtual Migration* apf::Splitter::split ( MeshTag *  weights,
double  tolerance,
int  multiple 
) [pure virtual]

call the underlying split algorithm

Parameters:
weights a tag of one double that should be attached to all the elements. splitters will try to balance the total element weight of the resulting parts. Some splitters support a weights pointer of zero, in which case elements are weighted equally
tolerance a factor greater than one at such that if max_weight < tolerance * average_weight the splitter will consider the parts balanced
multiple how many output parts to generate
Returns:
a migration object mapping all elements in the local part to part ids from 0 to multiple - 1. some splitters have convenience options that will change the resulting part ids.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines