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

Numberer for problem's degrees of freedom. More...

#include <GraphNumberer.h>

Inheritance diagram for XC::GraphNumberer:
XC::MovableObject XC::DistributedBase XC::BaseNumberer XC::Metis XC::MyRCM XC::RCM XC::SimpleNumberer

Public Member Functions

virtual const IDnumber (Graph &theGraph, int lastVertex=-1)=0
 Graph numbering. More...
 
virtual const IDnumber (Graph &theGraph, const ID &lastVertices)=0
 Graph numbering. 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 sendSelf (CommParameters &cp)=0
 Send the object. More...
 
virtual int recvSelf (const CommParameters &cp)=0
 Receive the object. 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

 GraphNumberer (int classTag)
 Constructor. More...
 
virtual GraphNumberergetCopy (void) const =0
 Virtual constructor.
 

Friends

class DOF_Numberer
 

Detailed Description

Numberer for problem's degrees of freedom.

GraphNumberer is an abstract class. The GraphNumberer class defines the interface that all programmers must provide when introducing new GraphNumberer subclasses. A GraphNumberer is an algorithmic class for numbering the Vertices of a Graph; that is assigning a unique integer value ( \(0\) through numVertex \(-1\)) to each Vertex (uses tmp variable of Vertex) of the Graph.

Constructor & Destructor Documentation

§ GraphNumberer()

XC::GraphNumberer::GraphNumberer ( int  classTag)
protected

Constructor.

The integer classTag is passed to the MovableObject classes constructor.

Member Function Documentation

§ number() [1/2]

virtual const ID& XC::GraphNumberer::number ( Graph theGraph,
int  lastVertex = -1 
)
pure 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).

Implemented in XC::Metis, XC::MyRCM, XC::RCM, and XC::SimpleNumberer.

§ number() [2/2]

virtual const ID& XC::GraphNumberer::number ( Graph theGraph,
const ID lastVertices 
)
pure 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).

Implemented in XC::Metis, XC::MyRCM, XC::RCM, and XC::SimpleNumberer.


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