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

Single freedom constraints that make part of a load pattern. More...

#include <NodeLocker.h>

Inheritance diagram for XC::NodeLocker:
XC::ForceReprComponent XC::DomainComponent XC::TaggedObject XC::MovableObject XC::DistributedBase XC::LoadPattern XC::EQBasePattern XC::PBowlLoading XC::EarthquakePattern XC::MultiSupportPattern XC::UniformExcitation

Public Member Functions

virtual ~NodeLocker (void)
 Destructor.
 
virtual void setDomain (Domain *theDomain)
 Set the domain for the constraints.
 
virtual SFreedom_ConstraintaddSFreedom_Constraint (const int &nodeTag, const int &dofId, const double &)
 Adds the single freedom constraint being passed as parameter.
 
virtual SFreedom_ConstraintItergetSPs (void)
 Returns an iterator to the single freedom constraints.
 
int getNumSPs (void) const
 Returns the number of single freedom constraints.
 
virtual void clearAll (void)
 Deletes all constraints.
 
SFreedom_ConstraintnewSPConstraint (const int &, const int &, const double &)
 Creates a single freedom constraint. More...
 
virtual bool removeSFreedom_Constraint (int tag)
 Erases the single freedom constraint identified by the argument. More...
 
virtual void applyLoad (const double &pseudoTime=0.0, const double &factor=1.0)
 Applies the single freedom constraints. More...
 
virtual int sendSelf (CommParameters &)
 Sends object through the channel being passed as parameter.
 
virtual int recvSelf (const CommParameters &)
 Receives object through the channel being passed as parameter.
 
virtual void Print (std::ostream &s, int flag=0)
 Imprime el load pattern.
 
std::deque< int > getTagsSPsNode (int theNode, int theDOF) const
 Returns the constraint that affect the node and DOF being passed as parameter. More...
 
std::deque< int > getTagsSPsNode (int theNode) const
 Returns the constraint that affect the node being passed as parameter. More...
 
bool nodeAffectedBySPs (int nodeTag) const
 Returns true if the single freedom constraints affect the node which identifier is being passed as parameter. More...
 
- Public Member Functions inherited from XC::ForceReprComponent
 ForceReprComponent (int classTag)
 
 ForceReprComponent (int tag, int classTag)
 
- Public Member Functions inherited from XC::DomainComponent
 ~DomainComponent (void)
 Destructor.
 
size_t getIdx (void) const
 Returns the index of the object (to be used in VTK arrays).
 
virtual DomaingetDomain (void) const
 Returns a pointer to the enclosing domain. More...
 
const PreprocessorgetPreprocessor (void) const
 Returns (if possible) a pointer to the preprocessor.
 
PreprocessorgetPreprocessor (void)
 Return (if possible) a pointer to the preprocessor.
 
void set_index (const size_t &i)
 Set the index for the object (see numera in Set). More...
 
- Public Member Functions inherited from XC::TaggedObject
 TaggedObject (int tag, CommandEntity *owr=nullptr)
 Constructor. More...
 
virtual TaggedObjectgetCopy (void) const
 Virtual constructor.
 
void assignTag (int newTag)
 Set tag (to be called from Python interface).
 
int getTag (void) const
 Returns the tag associated with the object.
 
- 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.
 
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

DbTagDatagetDbTagData (void) const
 Returns a vector to store the dbTags de los miembros of the clase. More...
 
int sendData (CommParameters &cp)
 Send members through the channel being passed as parameter.
 
int recvData (const CommParameters &cp)
 Receives members through the channel being passed as parameter.
 
 NodeLocker (void)
 Default constructor.
 
 NodeLocker (int tag)
 Constructor.
 
 NodeLocker (int tag, int classTag)
 Constructor.
 
virtual bool addSFreedom_Constraint (SFreedom_Constraint *theSp)
 Adds the single freedom constraint being passed as parameter.
 
- Protected Member Functions inherited from XC::DomainComponent
 DomainComponent (int tag, int classTag)
 Constructor. More...
 
int sendData (CommParameters &)
 Send object members through the channel being passed as parameter.
 
int recvData (const CommParameters &)
 Receive object members through the channel being passed as parameter.
 
- Protected Member Functions inherited from XC::TaggedObject
void setTag (int newTag)
 Set tag. More...
 

Protected Attributes

int nextTag
 Default tag for next node locker.
 
int currentGeoTag
 
int lastGeoSendTag
 
TaggedObjectStorage * theSPs
 Constraint container.
 
SingleDomSFreedom_ItertheSpIter
 Constraint iterator.
 

Friends

class NodeLockers
 
class FEM_ObjectBroker
 

Detailed Description

Single freedom constraints that make part of a load pattern.

Member Function Documentation

§ applyLoad()

void XC::NodeLocker::applyLoad ( const double &  pseudoTime = 0.0,
const double &  factor = 1.0 
)
virtual

Applies the single freedom constraints.

Parameters
pseudoTimeignored (single freedom constraints doesn't depend on it).
factorfactor that weights the prescribed values.

§ getDbTagData()

XC::DbTagData & XC::NodeLocker::getDbTagData ( void  ) const
protectedvirtual

Returns a vector to store the dbTags de los miembros of the clase.

Reimplemented from XC::DistributedBase.

§ getTagsSPsNode() [1/2]

std::deque< int > XC::NodeLocker::getTagsSPsNode ( int  theNode,
int  theDOF 
) const

Returns the constraint that affect the node and DOF being passed as parameter.

Parameters
theNodenode identifier.
theDOFidentifier or the degree of freedom.

§ getTagsSPsNode() [2/2]

std::deque< int > XC::NodeLocker::getTagsSPsNode ( int  theNode) const

Returns the constraint that affect the node being passed as parameter.

Parameters
theNodenode identifier.

§ newSPConstraint()

XC::SFreedom_Constraint * XC::NodeLocker::newSPConstraint ( const int &  tag_nod,
const int &  dofId,
const double &  value 
)

Creates a single freedom constraint.

Parameters
tag_nodidentifier of the constrained node.
dofIdidentifier of the degree of freedom.
valuevalue of the prescribed displacement.

§ nodeAffectedBySPs()

bool XC::NodeLocker::nodeAffectedBySPs ( int  nodeTag) const

Returns true if the single freedom constraints affect the node which identifier is being passed as parameter.

§ removeSFreedom_Constraint()

bool XC::NodeLocker::removeSFreedom_Constraint ( int  tag)
virtual

Erases the single freedom constraint identified by the argument.

Parameters
tagsingle freedom constraint identifier.

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