XC::PlainNumberer Class Reference

Trivial DOF numberer. More...

#include <PlainNumberer.h>

Inheritance diagram for XC::PlainNumberer:

Collaboration diagram for XC::PlainNumberer:

Public Member Functions
virtual DOF_Numberer *	getCopy (void) const
	Virtual constructor.
int	numberDOF (int lastDOF=-1)
	Method to number the unnumbered DOFs in the DOF Groups. More...
int	numberDOF (ID &lastDOFs)
	The method is identical to that outlined above. More...
virtual int	sendSelf (Communicator &)
	Does nothing.
virtual int	recvSelf (const Communicator &)
	Does nothing.
Public Member Functions inherited from XC::DOF_Numberer
virtual	~DOF_Numberer (void)
	Destructor.
void	useAlgorithm (const std::string &)
	Sets the algorithm to be used for numerating the graph «Reverse Cuthill-Macgee» o simple. 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 &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.
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
	PlainNumberer (ModelWrapper *)
	Constructor. More...
Protected Member Functions inherited from XC::DOF_Numberer
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 &)
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	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

Trivial DOF numberer.

The PlainNumberer class is a DOF_Numberer. An object of this class assigns the equation numbers to thee DOF_Groups based on the order in which they are obtained from the DOF_GroupIter object obtained from the AnalyisModel. The class is useful for situations where the SystemOfEqn or Solver objects will impose a renumbering on the equations, which makes performing a complex numbering of the degrees-of-freedom a waste of computational effort.

Constructor & Destructor Documentation

PlainNumberer()

XC::PlainNumberer::PlainNumberer ( ModelWrapper *  owr )

protected

Constructor.

Parameters

owr	object owner.

Member Function Documentation

numberDOF() [1/2]

int XC::PlainNumberer::numberDOF ( int  lastDOF = -1 )

virtual

Method to number the unnumbered DOFs in the DOF Groups.

The PlainNumberer will twice obtain the DOF_GroupIter from the AnalysisModel. It iterates twice through the DOF_Groups first assigning the dofs with eqn numbers assigned -2 a number and then on the next pass the dofs assigned -3. The PlainNumberer then invokes setID() on each FE_Element in the AnalysisModel. Finally it invokes {setEqnNum(numEqn)} on the AnalyisModel. Returns a positive integer equal to the last equation number set if successful, a negative number if not; the value of which depends on the type of the PlainNumberer. A PlainNumberer will not use the {lastDOF_Group} integer, if one is supplied a warning message is printed.

Reimplemented from XC::DOF_Numberer.

numberDOF() [2/2]

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

virtual

The method is identical to that outlined above.

A PlainNumberer will not use the {lastDOF_Groups} ID, if this method is invoked a warning message is printed.

Reimplemented from XC::DOF_Numberer.

---

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

• src/solution/analysis/numberer/PlainNumberer.h
• src/solution/analysis/numberer/PlainNumberer.cpp