xc
Public Member Functions | Protected Member Functions | Friends | List of all members

type of GraphPartitioner which uses 'METIS - Unstructured Graph Partitioning And Sparse Matrix Ordering System', developed by G. More...

#include <MetisNumberer.h>

Inheritance diagram for XC::Metis:
XC::GraphPartitioner XC::GraphNumberer XC::GraphPartitioner XC::MovableObject XC::DistributedBase

Public Member Functions

bool setOptions (int Ptype, int Mtype, int coarsenTo, int Rtype, int IPtype)
 Sets the options for the partitioning to those passed as arguments. More...
 
bool setDefaultOptions (void)
 Sets the default options.
 
int partition (Graph &theGraph, int numPart)
 Method to partition the graph. More...
 
bool setOptions (int Ptype, int Mtype, int coarsenTo, int Rtype, int IPtype)
 
bool setDefaultOptions (void)
 
int partitionHexMesh (int *elmnts, int *epart, int *npart, int ne, int nn, int nparts, bool whichToUse)
 
int partition (Graph &theGraph, int numPart)
 Method invoked to partition the graph. More...
 
int partitionGraph (int *nvtxs, int *xadj, int *adjncy, int *vwgt, int *adjwgt, int *wgtflag, int *numflag, int *nparts, int *options, int *edgecut, int *part, bool whichToUse)
 
const IDnumber (Graph &theGraph, int lastVertex=-1)
 Graph numbering. More...
 
const IDnumber (Graph &theGraph, const ID &lastVertices)
 Graph numbering. More...
 
int sendSelf (CommParameters &)
 Send the object. More...
 
int recvSelf (const CommParameters &)
 Receive the object. More...
 
- Public Member Functions inherited from XC::MovableObject
 MovableObject (int classTag, int dbTag)
 Constructor. More...
 
 MovableObject (int classTag)
 Constructor. More...
 
 MovableObject (const MovableObject &)
 Copy constructor. Doesn't copy the dbTag.
 
MovableObjectoperator= (const MovableObject &)
 Assignment operator. Doesn't copy the dbTag.
 
int getClassTag (void) const
 Return the class identifier.
 
int getDbTag (void) const
 Return the object identifier in the database.
 
int getDbTag (CommParameters &)
 Return the object identifier in the database.
 
void setDbTag (int dbTag)
 Sets the object identifier in the database.
 
void setDbTag (CommParameters &)
 Sets the object identifier in the database if not already set. More...
 
virtual int setParameter (const std::vector< std::string > &argv, Parameter &param)
 Sets the value param to the parameter argv.
 
virtual int updateParameter (int parameterID, Information &info)
 Updates the parameter identified by parameterID with info.
 
virtual int activateParameter (int parameterID)
 Activates the parameter identified by parameterID.
 
virtual int setVariable (const std::string &variable, Information &)
 Set the value of the variable idenfified by var.
 
virtual int getVariable (const std::string &variable, Information &)
 Return the value of the variable idenfified by var.
 
- Public Member Functions inherited from XC::DistributedBase
 DistributedBase (void)
 Constructor.
 
virtual DbTagDatagetDbTagData (void) const
 Returns a vector to store class dbTags.
 
const int & getDbTagDataPos (const int &i) const
 Returns the data at the i-th position.
 
void setDbTagDataPos (const int &i, const int &v)
 Sets the data at the i-th position.
 
void inicComm (const int &dataSize) const
 Initializes communication.
 

Protected Member Functions

 Metis (int Ptype, int Mtype, int coarsenTo, int Rtype, int IPtype)
 
GraphNumberergetCopy (void) const
 Virtual constructor.
 
- Protected Member Functions inherited from XC::GraphPartitioner
 GraphPartitioner (void)
 Constructor.
 
- Protected Member Functions inherited from XC::GraphNumberer
 GraphNumberer (int classTag)
 Constructor. More...
 

Friends

class DOF_Numberer
 

Detailed Description

type of GraphPartitioner which uses 'METIS - Unstructured Graph Partitioning And Sparse Matrix Ordering System', developed by G.

Metis is a type of GraphPartitioner which uses METIS library.

Karypis and V. Kumar at the University of Minnesota. The metis files are found in metis-2.0 which were downloaded.

The Metis graph partitioner calls procedures defined in the METIS library to partition the graph. METIS is currently being developed by G.~Karypis and V.~Kumar at the University of Minnesota. At the present time the Graph to be partitioned MUST have the vertices labeled \(0\) through \(numVertex-1\). The METIS library uses two integer arrays to represent the graph, {xadj} and adjncy. \(xadj(i)\) stores the location in adjncy of the start of the \(i\)'th Vertices adjacent Vertices. adjncy contains the tags of all the adjacent vertices. For example, the graph which is represented by the following matrix \(A\): 'METIS - Unstructured Graph Partitioning And Sparse Matrix Ordering System', developed by G. Karypis and V. Kumar at the University of Minnesota. The metis files are found in metis-2.0 which were downloaded.

Member Function Documentation

§ number() [1/2]

const XC::ID & XC::Metis::number ( Graph theGraph,
int  lastVertex = -1 
)
virtual

Graph numbering.

This is the method invoked to perform the graph numbering, that is to assign a unique integer \(1\) through numVertex, to each Vertex in the Graph. Returns an ordered ID containing the vertex references in the order of the numbering, i.e. \(ID(0)\) contains the integer reference for the vertex assigned the number 1, \(ID(1)\) contains the integer reference for the vertex assigned the number 2 and so on. A side effect of the numbering is that the Tmp variable of each vertex is set to the number assigned to that vertex. If lastVertex is not \(-1\) the Vertex whose tag is given by lastVertex should be numbered last (it does not have to be though THIS MAY CHANGE).

Implements XC::GraphNumberer.

§ number() [2/2]

const XC::ID & XC::Metis::number ( Graph theGraph,
const ID lastVertices 
)
virtual

Graph numbering.

This is the method invoked to perform the graph numbering, that is to assign a unique integer \(1\) through numVertex, to each Vertex in the Graph. Returns an ordered ID containing the vertex references in the order of the numbering, i.e. \(ID(0)\) contains the integer reference for the vertex assigned the number 1, \(ID(1)\) contains the integer reference for the vertex assigned the number 2 and so on. A side effect of the numbering is that the Tmp variable of each vertex is set to the number assigned to that vertex. If lastVertex is not \(-1\) the Vertex whose tag is given by lastVertex should be numbered last (it does not have to be though THIS MAY CHANGE).

Implements XC::GraphNumberer.

§ partition() [1/2]

int XC::Metis::partition ( Graph theGraph,
int  numPart 
)
virtual

Method to partition the graph.

Method that performs the graph partitioning.

It first creates the arrays needed by the metis lib and then invokes a function from the metis lib to partition the graph. The solors of the vertices of the graph are set to colors 0 through numPart-1 to indicate which partition the vertices are in. Returns -1 if options are not set, -2 if metis failed.

This is the method invoked to partition the graph into numPart partitions. On completion of the routine each vertex will be assigned a color \(1\) through numPart, the color assigned indicating the partition to which the vertex belongs.

To partition a number of integer arrays are created, {options[5]}, {partition[numVertex+1]}, {xadj[numVertex+1]} and {adjncy[2*numEdge]} (CURRENTLY ASSUMING GRAPH IS SYMMETRIC - THIS MAY CHANGE & xadj and partition 1 LARGER THAN REQUIRED). If not enough memory is available for the arrays, a warning message is printed and \(-2\) is returned. The data for xadj and adjncy are determined from the Vertices of the Graph by iterating over each Vertex from \(0\) through numVertex \(-1\). If default options are specified {options[0]} is set to \(0\), otherwise \(1\) with {options[1:4] = coarsenTo, mType, ipType, rType}. if pType equals \(1\) PMETIS is called, otherwise KMETIS is called. Both are called with the following arguments: {numVertex, xadj,adjncy, 0, 0, &weightFlag, options, numPart, &numbering, &edgecut, partition} The colors of the partitions are then set equal to the color indicated in partition. The integer arrays are destroyed and \(0\) returned.

Implements XC::GraphPartitioner.

§ partition() [2/2]

int XC::Metis::partition ( Graph theGraph,
int  numPart 
)
virtual

Method invoked to partition the graph.

This is the method invoked to partition the graph into numPart partitions. On completion of the routine each vertex will be assigned a color \(1\) through numPart, the color assigned indicating the partition to which the vertex belongs. Returns a 0 if successful, a negative number if not; the value depending on the subclass.

Implements XC::GraphPartitioner.

§ recvSelf()

int XC::Metis::recvSelf ( const CommParameters cp)
virtual

Receive the object.

Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through cp. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using #theBroker. To return 0 if successful or a -1 if not.

Implements XC::MovableObject.

§ sendSelf()

int XC::Metis::sendSelf ( CommParameters cp)
virtual

Send the object.

Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by cp object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a receiveSelf() to receive the data. Returns 0 if successful (successful in that the data got to the channel), or a - if no data was sent.

Implements XC::MovableObject.

§ setOptions()

bool XC::Metis::setOptions ( int  Ptype,
int  Mtype,
int  coarsenTo,
int  Rtype,
int  IPtype 
)

Sets the options for the partitioning to those passed as arguments.

Then invokes checkOptions() to see if the options are valid. HOW ABOUT REFERRINGR TO MANUAL TO SEE WHAT OPTIONS MEAN.


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