A MaxNodeDispRecorder is used to determine the max nodal displacement at a collection of nodes over an analysis. More...

#include <MaxNodeDispRecorder.h>

Inheritance diagram for XC::MaxNodeDispRecorder:

Public Member Functions
	MaxNodeDispRecorder (void)
	Default constructor.

	MaxNodeDispRecorder (int dof, const ID &nodeTags, Domain &theDomain)
	Constructor. More...

int	record (int commitTag, double timeStamp)
	For each node in `nodeTags` the value of the `dof'th` committed displacement is obtained. More...

int	playback (int commitTag)
	Prints to clog the vector containing the maximum absolute nodal displacements. More...

int	restart (void)
	Zeros the Vector of maximum nodal displacements.

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.

Domain *	getDomain (void)

Public Member Functions inherited from XC::Recorder
	Recorder (int classTag)

virtual int	sendSelf (CommParameters &)
	Send the object. More...

virtual int	recvSelf (const CommParameters &)
	Receive the object. 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 (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 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.

Additional Inherited Members
Protected Attributes inherited from XC::DomainRecorderBase
Domain *	theDomain

Detailed Description

A MaxNodeDispRecorder is used to determine the max nodal displacement at a collection of nodes over an analysis.

(between commitTag of 0 and last commitTag).

Constructor & Destructor Documentation

§ MaxNodeDispRecorder()

XC::MaxNodeDispRecorder::MaxNodeDispRecorder	(	int	theDof,
		const ID &	nTags,
		Domain &	theDom
	)

Constructor.

Parameters

theDof	index of the degree of freedom to follow.
nTags	identifiers of the nodes to follow.
theDom	domain of the nodes.

Member Function Documentation

§ playback()

int XC::MaxNodeDispRecorder::playback ( int commitTag )

virtual

Prints to clog the vector containing the maximum absolute nodal displacements.

Note, at the end of the analysis, what is printed is independent of commitTag. Returns \(0\).

Reimplemented from XC::Recorder.

§ record()

int XC::MaxNodeDispRecorder::record	(	int	commitTag,
		double	timeStamp
	)

virtual

For each node in nodeTags the value of the dof'th committed displacement is obtained.

If the absolute value of this is greater than the value currently stored in the Vector of max displacements, the value in the Vector is updated. If no Node exists in {theDomain} with the tag or the Node does not have a dof'th degree-of-freedom associated with it \(0\) is entered in the Vector. Returns \(0\).

Implements XC::Recorder.

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

src/utility/recorder/MaxNodeDispRecorder.h
src/utility/recorder/MaxNodeDispRecorder.cpp