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

Trivial DOF numberer. More...

#include <PlainNumberer.h>

Inheritance diagram for XC::PlainNumberer:
XC::DOF_Numberer XC::MovableObject XC::DistributedBase

Public Member Functions

virtual DOF_NumberergetCopy (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 (CommParameters &)
 Does nothing.
 
virtual int recvSelf (const CommParameters &)
 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.
 
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 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

 PlainNumberer (ModelWrapper *)
 Constructor. More...
 
- Protected Member Functions inherited from XC::DOF_Numberer
AnalysisModelgetAnalysisModelPtr (void)
 Returns a pointer to the analysis model.
 
GraphNumberergetGraphNumbererPtr (void)
 Return a pointer to the GraphNumberer object associated with the DOF_Numberer, theGraphNumberer. More...
 
const AnalysisModelgetAnalysisModelPtr (void) const
 Returns a pointer to the analysis model.
 
const GraphNumberergetGraphNumbererPtr (void) const
 Return a const pointer to the GraphNumberer object associated with the DOF_Numberer, theGraphNumberer. More...
 
int sendData (CommParameters &)
 Send object members through the channel passed as parameter. More...
 
int recvData (const CommParameters &)
 Receives object members through the channel being passed as parameter. 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_Numbereroperator= (const DOF_Numberer &)
 

Friends

class ModelWrapper
 
class FEM_ObjectBroker
 

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
owrobject 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: