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:
Inheritance graph
[legend]
Collaboration diagram for XC::GraphNumberer:
Collaboration graph
[legend]

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 (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 sendSelf (Communicator &comm)=0
 Send the object. More...
 
virtual int recvSelf (const Communicator &comm)=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 ~DistributedBase (void)
 Destructor.
 
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.
 
- Public Member Functions inherited from CommandEntity
 CommandEntity (CommandEntity *owr=nullptr)
 Default constructor.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (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.
 
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.
 
EntityWithOwneroperator= (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.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Protected Member Functions

 GraphNumberer (int classTag)
 Constructor. More...
 
virtual GraphNumberergetCopy (void) const =0
 Virtual constructor.
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) const
 
- Protected Member Functions inherited from EntityWithProperties
bool isEqual (const EntityWithProperties &) const
 Return true if both objects are equal.
 
- Protected Member Functions inherited from EntityWithOwner
virtual bool isEqual (const EntityWithOwner &) const
 Return true if both objects are equal.
 

Friends

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 CommandEntityentcmd_cast (boost::any &data)
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

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, XC::SimpleNumberer, and XC::AMD.

◆ 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, XC::SimpleNumberer, and XC::AMD.


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