Class designed to perform the Reverse Cuthill-McKee numbering scheme on the vertices of a graph. More...
#include <RCM.h>
Public Member Functions | |
| const ID & | number (Graph &theGraph, int lastVertex=-1) |
| Method to perform the Reverse Cuthill-mcKenn numbering scheme. More... | |
| const ID & | number (Graph &theGraph, const ID &lastVertices) |
| Determine the best starting vertex. More... | |
| int | sendSelf (Communicator &) |
| Send the object. More... | |
| int | recvSelf (const Communicator &) |
| 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. | |
| MovableObject & | operator= (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 (Communicator &) |
| Return the object identifier in the database. | |
| void | setDbTag (int dbTag) |
| Sets the object identifier in the database. | |
| void | setDbTag (Communicator &) |
| Sets the object identifier in the database if not already set. More... | |
| virtual int | setParameter (const std::vector< std::string > &argv, Parameter ¶m) |
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 | ~DistributedBase (void) |
| Destructor. | |
| virtual DbTagData & | getDbTagData (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. | |
| Public Member Functions inherited from CommandEntity | |
| CommandEntity (CommandEntity *owr=nullptr) | |
| Default constructor. | |
| CommandEntity * | Owner (void) |
| Return a pointer to the object owner. | |
| const CommandEntity * | Owner (void) const |
| Return un puntero al objeto propietario de ESTE. | |
| const StandardOutputWrapper & | getStandardOutputWrapper (void) const |
| Return the regular output stream wrapper. | |
| StandardOutputWrapper & | getStandardOutputWrapper (void) |
| Return the regular output stream wrapper. | |
| const std::string & | getLogFileName (void) const |
| Returns log file name. | |
| void | setLogFileName (const std::string &) |
| Sets log file name. | |
| const std::string & | getErrFileName (void) const |
| Returns err file name. | |
| void | setErrFileName (const std::string &) |
| Sets error file name. | |
| const std::string & | getOutputFileName (void) const |
| Returns regular output file name. | |
| void | setOutputFileName (const std::string &) |
| Sets regular output file name. | |
| boost::python::object | evalPy (boost::python::object dict, const std::string &) |
| Return the Python object that results from evaluating the argument. | |
| boost::python::object | execPy (boost::python::object dict, const std::string &) |
| Return the Python objects that results from executing the code in the string argument. | |
| boost::python::object | execFilePy (boost::python::object dict, const std::string &) |
| Return the Python object that results from executing the code in the file. | |
| Public Member Functions inherited from EntityWithProperties | |
| EntityWithProperties (EntityWithProperties *owr=nullptr) | |
| Default constructor. | |
| virtual bool | operator== (const EntityWithProperties &) const |
| Comparison operator. | |
| void | clearPyProps (void) |
| Clear python properties map. | |
| bool | hasPyProp (const std::string &) |
| Returns true if property exists. | |
| boost::python::object | getPyProp (const std::string &str) |
| Return the Python object with the name being passed as parameter. | |
| void | setPyProp (std::string str, boost::python::object val) |
| Sets/appends a value tho the Python object's dictionary. | |
| void | copyPropsFrom (const EntityWithProperties &) |
| Copy the properties from the argument. | |
| boost::python::list | getPropNames (void) const |
| Return the names of the object properties weightings. | |
| const PythonDict & | getPropertiesDict (void) const |
| Return a std::map container with the properties of the object. | |
| boost::python::dict | getPyDict (void) const |
| Return a Python dictionary containing the object members values. | |
| void | setPyDict (const boost::python::dict &) |
| Set the values of the object members from a Python dictionary. | |
| Public Member Functions inherited from EntityWithOwner | |
| EntityWithOwner (EntityWithOwner *owr=nullptr) | |
| Default constructor. | |
| EntityWithOwner (const EntityWithOwner &) | |
| Copy constructor. | |
| EntityWithOwner & | operator= (const EntityWithOwner &) |
| Assignment operator. | |
| virtual bool | operator== (const EntityWithOwner &) const |
| Comparison operator. | |
| virtual | ~EntityWithOwner (void) |
| Virtual destructor. | |
| virtual std::string | getClassName (void) const |
| Returns demangled class name. | |
| void | set_owner (EntityWithOwner *owr) |
| Assigns the owner of the object. | |
| EntityWithOwner * | Owner (void) |
| const EntityWithOwner * | Owner (void) const |
Protected Member Functions | |
| RCM (bool GPS=true) | |
| Constructor. More... | |
| GraphNumberer * | getCopy (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... | |
| Protected Member Functions inherited from CommandEntity | |
| template<class T > | |
| void | string_to (T &, const std::string &) const |
Friends | |
| class | FEM_ObjectBroker |
| class | DOF_Numberer |
Additional Inherited Members | |
| Public Types inherited from EntityWithProperties | |
| typedef std::map< std::string, boost::python::object > | PythonDict |
| Static Public Member Functions inherited from CommandEntity | |
| static void | resetStandardOutput (void) |
| Reset the standard output streams to its defaults buffers. | |
| Static Public Member Functions inherited from EntityWithOwner | |
| static int | getVerbosityLevel (void) |
| Get the value of the verbosity level. | |
| static void | setVerbosityLevel (const int &) |
| Set the value of the verbosity level. | |
| Static Protected Member Functions inherited from CommandEntity | |
| static CommandEntity * | entcmd_cast (boost::any &data) |
| Protected Attributes inherited from XC::BaseNumberer | |
| ID | theRefResult |
| Static Protected Attributes inherited from EntityWithOwner | |
| static int | verbosity = 1 |
| Object that owns THIS ONE. More... | |
Detailed Description
Class designed to perform 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.
Reference: Cuthill–McKee algorithm.
Constructor & Destructor Documentation
◆ RCM()
|
protected |
Constructor.
The flag GPS is used to mark whether the Gibbs-Poole-Stodlmyer algorithm is used to determine a starting vertex when no starting vertex is given.
Member Function Documentation
◆ number() [1/2]
Method to perform the Reverse Cuthill-mcKenn numbering scheme.
The user can supply a starting vertex, if none is provided the first vertex returned by the iter is used. If minDegree flag is set to true, at each level set the adjacent vertices not yet added from a vertex in the previous level set are added in descending degree. The result of the numbering scheme is returned in an ID which contains the references for the vertices.
side effects: this routine changes the color of the vertices. If the present ID used for the result is not of size equal to the number of Vertices in theGraph, it deletes the old and constructs a new ID. Starts by iterating through the Vertices of the graph setting the tmp variable of each to \(-1\). The Vertices are then numbered using a depth first sort of the Graph, with each unmarked Vertex in the Graph at a distance \(d\) from starting Vertex being placed in the d'th level set. As this is RCM, the Vertices in level set \(n\) are assigned a higher number than those in level set \(n+1\) with the tmp variable of the starting Vertex being assigned numVertices \(-1\). The tags of the Vertices are placed into the ID at location given by their tmp variable. These are replaced with the ref variable of each Vertex, which is returned on successful completion.
The Vertex chosen as the starting Vertex is the one whose tag is given by lastVertex. If this is \(-1\) or the Vertex corresponding to lastVertex does not exist then another Vertex is chosen. If the GPS flag in constructor is false the first Vertex from the Graphs VertexIter is used; if true a RCM numbering using the first Vertex from the VertexIter is performed and the Vertices in the last level set are then used to create an ID lastVertices with which {number(theGraph, lastVertices)} can be invoked to determine the numbering.
Implements XC::GraphNumberer.
◆ number() [2/2]
Determine the best starting vertex.
This method is invoked to determine the best starting Vertex for a RCM using a Vertex whose tag is in lastVertices. To do a RCM numbering is performed using each of the Vertices in {startVertices} as the Vertex in level set \(0\). The Vertex which results in the numbering with the smallest profile is chosen as the starting Vertex. The RCM algorithm outlined above is then called with this starting Vertex.
Implements XC::GraphNumberer.
◆ recvSelf()
|
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()
|
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:
- src/solution/graph/numberer/RCM.h
- src/solution/graph/numberer/RCM.cpp
