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:

[legend]

Collaboration diagram for XC::MaxNodeDispRecorder:

[legend]

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 (Communicator &)
	Send the object. More...

virtual int	recvSelf (const Communicator &)
	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 (Communicator &)
	Return the object identifier in the database.

void	setDbTag (int dbTag)
	Sets the object identifier in the database.

void	setDbTag (Communicator &)
	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	~DistributedBase (void)
	Destructor.

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.

Public Member Functions inherited from CommandEntity
	CommandEntity (CommandEntity *owr=nullptr)
	Default constructor.

CommandEntity *	Owner (void)
	Return a pointer to the object owner.

const CommandEntity *	Owner (void) const
	Return un puntero al objeto propietario de ESTE.

const StandardOutputWrapper &	getStandardOutputWrapper (void) const
	Return the regular output stream wrapper.

StandardOutputWrapper &	getStandardOutputWrapper (void)
	Return the regular output stream wrapper.

const std::string &	getLogFileName (void) const
	Returns log file name.

void	setLogFileName (const std::string &)
	Sets log file name.

const std::string &	getErrFileName (void) const
	Returns err file name.

void	setErrFileName (const std::string &)
	Sets error file name.

const std::string &	getOutputFileName (void) const
	Returns regular output file name.

void	setOutputFileName (const std::string &)
	Sets regular output file name.

boost::python::object	evalPy (boost::python::object dict, const std::string &)
	Return the Python object that results from evaluating the argument.

boost::python::object	execPy (boost::python::object dict, const std::string &)
	Return the Python objects that results from executing the code in the string argument.

boost::python::object	execFilePy (boost::python::object dict, const std::string &)
	Return the Python object that results from executing the code in the file.

Public Member Functions inherited from EntityWithProperties
	EntityWithProperties (EntityWithProperties *owr=nullptr)
	Default constructor.

virtual bool	operator== (const EntityWithProperties &) const
	Comparison operator.

void	clearPyProps (void)
	Clear python properties map.

bool	hasPyProp (const std::string &)
	Returns true if property exists.

boost::python::object	getPyProp (const std::string &str)
	Return the Python object with the name being passed as parameter.

void	setPyProp (std::string str, boost::python::object val)
	Sets/appends a value tho the Python object's dictionary.

void	copyPropsFrom (const EntityWithProperties &)
	Copy the properties from the argument.

boost::python::list	getPropNames (void) const
	Return the names of the object properties weightings.

const PythonDict &	getPropertiesDict (void) const
	Return a std::map container with the properties of the object.

boost::python::dict	getPyDict (void) const
	Return a Python dictionary containing the object members values.

void	setPyDict (const boost::python::dict &)
	Set the values of the object members from a Python dictionary.

Public Member Functions inherited from EntityWithOwner
	EntityWithOwner (EntityWithOwner *owr=nullptr)
	Default constructor.

	EntityWithOwner (const EntityWithOwner &)
	Copy constructor.

EntityWithOwner &	operator= (const EntityWithOwner &)
	Assignment operator.

virtual bool	operator== (const EntityWithOwner &) const
	Comparison operator.

virtual	~EntityWithOwner (void)
	Virtual destructor.

virtual std::string	getClassName (void) const
	Returns demangled class name.

void	set_owner (EntityWithOwner *owr)
	Assigns the owner of the object.

EntityWithOwner *	Owner (void)

const EntityWithOwner *	Owner (void) const

Additional Inherited Members
Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object >	PythonDict

Static Public Member Functions inherited from CommandEntity
static void	resetStandardOutput (void)
	Reset the standard output streams to its defaults buffers.

Static Public Member Functions inherited from EntityWithOwner
static int	getVerbosityLevel (void)
	Get the value of the verbosity level.

static void	setVerbosityLevel (const int &)
	Set the value of the verbosity level.

Protected Member Functions inherited from CommandEntity
template<class T >
void	string_to (T &, const std::string &) const

Static Protected Member Functions inherited from CommandEntity
static CommandEntity *	entcmd_cast (boost::any &data)

Protected Attributes inherited from XC::DomainRecorderBase
Domain *	theDomain

Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

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