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

Class which performs the Reverse Cuthill-McKee numbering scheme on the vertices of a graph. More...

#include <MyRCM.h>

Inheritance diagram for XC::MyRCM:
XC::BaseNumberer XC::GraphNumberer XC::MovableObject XC::DistributedBase

Public Member Functions

void setStartVertex (int startVertex)
 
void setMinDegreeFlag (bool flag)
 
const IDnumber (Graph &theGraph, int lastVertex=-1)
 Graph numbering. More...
 
const IDnumber (Graph &theGraph, const ID &lastVertices)
 Graph numbering. More...
 
virtual int sendSelf (CommParameters &)
 Send the object. More...
 
virtual 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

 MyRCM (int startVertex=-1, bool minDegreeFlag=false)
 Constructor.
 
GraphNumberergetCopy (void) const
 Virtual constructor.
 
- Protected Member Functions inherited from XC::BaseNumberer
 BaseNumberer (int classTag)
 Constructor.
 
int getNumVertex (void) const
 
bool checkSize (const Graph &)
 Allocates space enough for the theRefResult vector. More...
 
- Protected Member Functions inherited from XC::GraphNumberer
 GraphNumberer (int classTag)
 Constructor. More...
 

Friends

class FEM_ObjectBroker
 
class DOF_Numberer
 

Additional Inherited Members

- Protected Attributes inherited from XC::BaseNumberer
ID theRefResult
 

Detailed Description

Class which performs the Reverse Cuthill-McKee numbering scheme on the vertices of a graph.

This is done by invoking the number() method with the Graph to be numbered.

Member Function Documentation

§ number() [1/2]

const XC::ID & XC::MyRCM::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::MyRCM::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.

§ recvSelf()

int XC::MyRCM::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::MyRCM::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.


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