Base class for body loads over elements. More...
#include <ElementBodyLoad.h>
Inheritance diagram for XC::ElementBodyLoad:
Public Member Functions | |
| ElementBodyLoad (int tag, int classTag, const ID &theElementTags) | |
| ElementBodyLoad (int tag, int classTag) | |
| ElementBodyLoad (int classTag) | |
| virtual void | setDomain (Domain *theDomain) |
| Sets the pointer to the domain. More... | |
| virtual void | applyLoad (double loadfactor) |
The load object is to add loadFactor times the load to the corresponding residual value at its associated element(s) or node(s). More... | |
| virtual int | removeElement (int tag) |
| Removes the element from those affected by the load. More... | |
| void | Print (std::ostream &s, int flag=0) const |
| Print stuff. | |
 Public Member Functions inherited from XC::ElementalLoad | |
| ElementalLoad (int tag=0, int classTag=0) | |
| Constructor. More... | |
| ElementalLoad (int tag, int classTag, const ID &) | |
| Constructor. More... | |
| int | numElements (void) const |
| Return the number of loaded elements. | |
| int | setElementTags (const ID &theEleTags) |
| Sets the identifiers of the loaded elements. | |
| virtual const ID & | getElementTags (void) const |
| Return the identifiers of the loaded elements. | |
| virtual const Vector & | getData (int &type, const double &loadFactor) const =0 |
| virtual const Vector & | getSensitivityData (const int &gradIndex) const |
| Public Member Functions inherited from XC::Load | |
| Load (int tag, int classTag) | |
| Constructor. More... | |
| virtual void | setLoadPatternTag (int loadPaternTag) |
| Sets the identifier of the pattern to which the load belongs. | |
| virtual int | getLoadPatternTag (void) const |
| Return the identifier of the pattern to which the load belongs. More... | |
| 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 Domain * | getDomain (void) const |
| Returns a pointer to the enclosing domain. More... | |
| const Preprocessor * | getPreprocessor (void) const |
| Returns (if possible) a pointer to the preprocessor. | |
| Preprocessor * | getPreprocessor (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 TaggedObject * | getCopy (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. | |
| virtual void | Print (std::ostream &, int flag=0) |
| Print stuff. | |
| 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 (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 | sendSelf (CommParameters &cp)=0 |
| Send the object. More... | |
| virtual int | recvSelf (const CommParameters &cp)=0 |
| Receive the object. More... | |
| virtual int | setParameter (const std::vector< std::string > &argv, Parameter ¶m) |
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 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. | |
Protected Member Functions | |
| int | sendData (CommParameters &cp) |
| Send data through the channel being passed as parameter. | |
| int | recvData (const CommParameters &cp) |
| Receive data through the channel being passed as parameter. | |
| Protected Member Functions inherited from XC::ElementalLoad | |
| int | sendData (CommParameters &cp) |
| Send data through the channel being passed as parameter. | |
| int | recvData (const CommParameters &cp) |
| Receive data through the channel being passed as parameter. | |
| Protected Member Functions inherited from XC::Load | |
| int | sendData (CommParameters &cp) |
| Send data through the channel being passed as parameter. | |
| int | recvData (const CommParameters &cp) |
| Receive data through the channel 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... | |
Additional Inherited Members | |
| Protected Attributes inherited from XC::ElementalLoad | |
| ID | elemTags |
| Tags of loaded elements. | |
Detailed Description
Base class for body loads over elements.
Member Function Documentation
§ applyLoad()
|
virtual |
The load object is to add loadFactor times the load to the corresponding residual value at its associated element(s) or node(s).
Implements XC::Load.
§ removeElement()
|
virtual |
Removes the element from those affected by the load.
If it fails returns -1.
§ setDomain()
|
virtual |
Sets the pointer to the domain.
Sets the encompassing domain of the component to that given by {theDomain}. This method is invoked by theDomain when the component is being added to the domain, in an {addDomain..} invocation (see interface for Domain).
Reimplemented from XC::DomainComponent.
The documentation for this class was generated from the following files:
- src/domain/load/ElementBodyLoad.h
- src/domain/load/ElementBodyLoad.cc
