xc
Public Member Functions | Protected Member Functions | List of all members
XC::DriftRecorder Class Reference

Records relative displacement between nodes. More...

#include <DriftRecorder.h>

Inheritance diagram for XC::DriftRecorder:
XC::HandlerRecorder XC::DomainRecorderBase XC::Recorder XC::MovableObject XC::DistributedBase

Public Member Functions

 DriftRecorder (int ndI, int ndJ, int dof, int perpDirn, Domain &theDomain, DataOutputHandler &theHandler, bool echoTime=false)
 
 DriftRecorder (const ID &ndI, const ID &ndJ, int dof, int perpDirn, Domain &theDomain, DataOutputHandler &theHandler, bool echoTime=false)
 
int record (int commitTag, double timeStamp)
 Invoked by the Domain object after commit() has been invoked on all the domain component objects. More...
 
int restart (void)
 Invoked by the Domain object when revertToStart() is invoked on the Domain object. More...
 
int sendSelf (CommParameters &)
 Sends the object through the communicator being passed as parameter.
 
int recvSelf (const CommParameters &)
 Receives the object through the communicator being passed as parameter.
 
- Public Member Functions inherited from XC::HandlerRecorder
 HandlerRecorder (int classTag)
 
 HandlerRecorder (int classTag, Domain &theDomain, DataOutputHandler &theOutputHandler, bool timeFlag)
 
void SetOutputHandler (DataOutputHandler *tH)
 Sets de data output handler.
 
- Public Member Functions inherited from XC::DomainRecorderBase
 DomainRecorderBase (int classTag, Domain *ptr_dom=nullptr)
 Constructor. More...
 
int setDomain (Domain &theDomain)
 Set the link with the domain.
 
DomaingetDomain (void)
 
- Public Member Functions inherited from XC::Recorder
 Recorder (int classTag)
 
virtual int playback (int commitTag)
 //! Invoked by the analyst after the analysis has been performed. 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

void free_nodes (void)
 
int alloc_nodes (const int &, const int &)
 
void free_ndIJ (void)
 
void alloc_ndIJ (const int &)
 
void set_ndIJ (const ID &nI, const ID &)
 
void setup_ndIJ (const int &)
 
- Protected Member Functions inherited from XC::HandlerRecorder
int sendData (CommParameters &)
 Sends objet through the communicator being passed as parameter.
 
int receiveData (const CommParameters &)
 Receives objet through the communicator being passed as parameter.
 

Additional Inherited Members

- Protected Attributes inherited from XC::HandlerRecorder
DataOutputHandlertheHandler
 Output handler (TO DEPRECATE).
 
bool initializationDone
 
bool echoTimeFlag
 
- Protected Attributes inherited from XC::DomainRecorderBase
DomaintheDomain
 

Detailed Description

Records relative displacement between nodes.

The drift is taken as the ratio between the prescribed relative displacement and the specified distance between the nodes.

Member Function Documentation

§ record()

int XC::DriftRecorder::record ( int  commitTag,
double  timeStamp 
)
virtual

Invoked by the Domain object after commit() has been invoked on all the domain component objects.

What the Recorder records depends on the concrete subtype.

Implements XC::Recorder.

§ restart()

int XC::DriftRecorder::restart ( void  )
virtual

Invoked by the Domain object when revertToStart() is invoked on the Domain object.

What the Recorder does depends on the concrete subtype.

Reimplemented from XC::Recorder.


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