Base class for DOF numbererers. More...

#include <DOF_Numberer.h>

Inheritance diagram for XC::DOF_Numberer:

Collaboration diagram for XC::DOF_Numberer:

Public Member Functions
virtual	~DOF_Numberer (void)
	Destructor.

virtual int	numberDOF (int lastDOF_Group=-1)
	Invoked to assign the equation numbers to the dofs. More...

virtual int	numberDOF (ID &lastDOF_Groups)
	Invoked to assign the equation numbers to the dofs. More...

void	useAlgorithm (const std::string &)
	Sets the algorithm to be used for numerating the graph «Reverse Cuthill-Macgee» o simple. More...

virtual int	sendSelf (Communicator &)
	Sends object through the communicator argument.

virtual int	recvSelf (const Communicator &)
	Receives object through the communicator argument.

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 &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 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
AnalysisModel *	getAnalysisModelPtr (void)
	Returns a pointer to the analysis model.

GraphNumberer *	getGraphNumbererPtr (void)
	Return a pointer to the GraphNumberer object associated with the DOF_Numberer, `theGraphNumberer`. More...

const AnalysisModel *	getAnalysisModelPtr (void) const
	Returns a pointer to the analysis model.

const GraphNumberer *	getGraphNumbererPtr (void) const
	Return a const pointer to the GraphNumberer object associated with the DOF_Numberer, `theGraphNumberer`. More...

int	sendData (Communicator &)
	Send object members through the communicator argument. More...

int	recvData (const Communicator &)
	Receives object members through the communicator argument. More...

void	alloc (const std::string &)
	Create the graph numberer (.

void	copy (const GraphNumberer &)
	Copy the graph numberer.

void	free_mem (void)
	Constructor.

	DOF_Numberer (ModelWrapper *, int classTag=NUMBERER_TAG_DOF_Numberer)
	Constructor. More...

	DOF_Numberer (const DOF_Numberer &)
	Copy constructor.

DOF_Numberer &	operator= (const DOF_Numberer &)

virtual DOF_Numberer *	getCopy (void) const
	Virtual constructor.

Protected Member Functions inherited from CommandEntity
template<class T >
void	string_to (T &, const std::string &) const

Friends
class	ModelWrapper

class	FEM_ObjectBroker

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)

Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

Base class for DOF numbererers.

DOF numberers purpose is to define the interface common among all subclasses. A DOF_Numberer object is responsible for assigning the equation numbers to the individual dofs in each of the DOF_Groups in the AnalysisModel. The base DOF_Numberer uses a GraphNumberer object to first number the DOF_Groups, based on the ordering of the DOF_Group objects, it assigns the equation numbers to the individual degrees-of-freedom. Subtypes may wish to implement the numbering in a more efficient manner by using the FE_Element and DOF_Group objects directly.

Constructor & Destructor Documentation

◆ DOF_Numberer()

XC::DOF_Numberer::DOF_Numberer	(	ModelWrapper *	owr,
		int	clsTag = `NUMBERER_TAG_DOF_Numberer`
	)

protected

Constructor.

Parameters

owr	pointer to the ModelWrapper that ows this object.
clsTag	class identifier.

Member Function Documentation

◆ getGraphNumbererPtr() [1/2]

XC::GraphNumberer * XC::DOF_Numberer::getGraphNumbererPtr ( void )

protected

Return a pointer to the GraphNumberer object associated with the DOF_Numberer, theGraphNumberer.

◆ getGraphNumbererPtr() [2/2]

const XC::GraphNumberer * XC::DOF_Numberer::getGraphNumbererPtr ( void ) const

protected

Return a const pointer to the GraphNumberer object associated with the DOF_Numberer, theGraphNumberer.

◆ numberDOF() [1/2]

int XC::DOF_Numberer::numberDOF ( int lastDOF_Group = -1 )

virtual

Invoked to assign the equation numbers to the dofs.

Invoked to assign the equation numbers to the dofs in the DOF_Groups and the FE_Elements, ensuring that the dof's in the DOF_Group whose tag is given by {lastDOF_Group} are numbered last in a \(-2\) or \(-3\) group. The initial values of these equation numbers have been set by the ConstraintHandler object to be \(-1\), \(-2\) or \(-3\), all dofs with a \(-3\) are to be assigned higher equation numbers than those assigned a \(-2\). To set the numEqn in the AnalysisModel and to return the number of equations numEqn if successful, a negative number if not. This base class performs the ordering by getting an ID containing the ordered DOF_Group tags, obtained by invoking {number(theModel- \(>\)getDOFGroupGraph(), lastDOF_Group)} on the GraphNumberer, theGraphNumberer, passed in the constructor. The base class then makes two passes through the DOF_Group objects in the AnalysisModel by looping through this ID; in the first pass assigning the equation numbers incrementally to any degree-of-freedom marked with a \(-2\) and in the second pass assigning the equation numbers incrementally to any degree-of-freedom marked with a \(-3\). It then iterates through the FE_Elements in the AnalsisModel invoking {setID()} on each object. Finally {setNumEqn(numEqn)} is invoked on the AnalysisModel. Return numEqn if successful, a warning message and a negative number is returned if an error occurs; \(-1\) is returned if setLinks() has not yet been invoked, \(-2\) if no GraphNumberer was passed in the constructor, \(-3\) if the number of {DOF_Groups} in AnalysisModel and size of ID returned are not the same, and a \(-4\) if there is no DOF_Group corresponding to one of the tags given in the ID.

Reimplemented in XC::ParallelNumberer, and XC::PlainNumberer.

◆ numberDOF() [2/2]

int XC::DOF_Numberer::numberDOF ( ID & lastDOFs )

virtual

Invoked to assign the equation numbers to the dofs.

Invoked to assign the equation numbers to the dofs in the DOF_Groups and the FE_Elements, ensuring that the dof's in the DOF_Groups whose tag is given in {lastDOF_Groups} are numbered last in a \(-2\) or \(-3\) group. The initial values of these equation numbers have been set by the ConstraintHandler object to be \(-1\), \(-2\) or \(-3\), all dofs with a \(-3\) are to be assigned higher equation numbers than those assigned a \(-2\). To set the numEqn in the AnalysisModel and to return the number of equations numEqn if successful, a negative number if not.

This method in the base class is almost identical to the one just described. The only difference is that the ID identifying the order of the DOF_Groups is obtained by invoking {number(theModel- \(>\)getDOFGroupGraph(), lastDOF_Groups)} on the GraphNumberer.

Reimplemented in XC::ParallelNumberer, and XC::PlainNumberer.

◆ recvData()

int XC::DOF_Numberer::recvData ( const Communicator & comm )

protected

Receives object members through the communicator argument.

The DOF_Numberer receives the class identifier and database tag of the GraphNumberer in an ID from the communicator, if no GraphNumberer is associated a \(-1\) is received. The DOF_Numberer will then ask {theBroker} for a GraphNumberer with that class identifier, it sets the database tag for the GraphNumberer and it then invokes {recvSelf()} on that GraphNumberer.

◆ sendData()

int XC::DOF_Numberer::sendData ( Communicator & comm )

protected

Send object members through the communicator argument.

The DOF_Numberer sends the class identifier and database tag of the GraphNumberer in a ID to the communicator, if no GraphNumberer is associated a \(-1\) is sent as the class tag. The object then invokes sendSelf() on the GraphNumberer.

◆ useAlgorithm()

void XC::DOF_Numberer::useAlgorithm ( const std::string & nmb )

Sets the algorithm to be used for numerating the graph «Reverse Cuthill-Macgee» o simple.

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

src/solution/analysis/numberer/DOF_Numberer.h
src/solution/analysis/numberer/DOF_Numberer.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DOF_Numberer()

Member Function Documentation

◆ getGraphNumbererPtr() [1/2]

◆ getGraphNumbererPtr() [2/2]

◆ numberDOF() [1/2]

◆ numberDOF() [2/2]

◆ recvData()

◆ sendData()

◆ useAlgorithm()