A LoadContainer object is used to to store loads on nodes and elements. More...

#include <LoadContainer.h>

Inheritance diagram for XC::LoadContainer:

Collaboration diagram for XC::LoadContainer:

Public Member Functions
	LoadContainer (CommandEntity *)
	Default constructor.

virtual	~LoadContainer (void)
	Destructor.

virtual void	setDomain (Domain *theDomain)
	Set the domain for the pattern loads.

virtual NodalLoadIter &	getNodalLoads (void)
	Returns an iterator to the nodal loads.

virtual ElementalLoadIter &	getElementalLoads (void)
	Returns an iterator to the elemental loads.

int	getNumNodalLoads (void) const
	Returns the number of nodal loadss.

int	getNumElementalLoads (void) const
	Returns the number of elemental loadss.

int	getNumLoads (void) const
	Returns the total number of loads.

bool	empty (void) const
	Returns true if there is no loads.

bool	actsOn (const Node *) const
	Return true if the load pattern acts on the given node.

void	removeLoadsOn (const Node *)
	Remove the loads acting on the given node.

std::list< NodalLoad * >	getLoadsOn (const Node *)
	Return the loads acting on the given node.

bool	actsOn (const Element *) const
	Return true if the load pattern acts on the given element.

void	removeLoadsOn (const Element *)
	Remove the loads acting on the given element.

void	copyLoads (const Element , const Element )
	Copy the loads from the first element to the second one. More...

virtual void	clearAll (void)
	Deletes all loads, constraints AND pointer to time series.

virtual void	clearLoads (void)
	Deletes all loads.

virtual void	applyLoad (const double &)
	Apply the load multiplied by the factor. More...

virtual int	sendSelf (Communicator &)
	Sends object through the communicator argument.

virtual int	recvSelf (const Communicator &)
	Receives object through the communicator argument.

virtual void	Print (std::ostream &s, int flag=0) const
	Prints load pattern information.

virtual LoadContainer *	getCopy (void)
	Virtual constructor.

virtual void	applyLoadSensitivity (const double &)

virtual int	setParameter (const std::vector< std::string > &, Parameter &)
	Sets the value `param` to the parameter `argv`.

virtual int	updateParameter (int parameterID, Information &)
	Updates the parameter identified by `parameterID` with `info`.

virtual int	activateParameter (int parameterID)
	Activates the parameter identified by `parameterID`.

Vector	getExternalForceSensitivity (int gradNumber)

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.

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

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	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.

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
DbTagData &	getDbTagData (void) const
	Returns a vector to store the dbTags of the class members. More...

int	sendData (Communicator &comm)
	Send members through the communicator argument.

int	recvData (const Communicator &comm)
	Receives members through the communicator argument.

virtual bool	addNodalLoad (NodalLoad *)
	Adds the nodal load being passed as parameter.

virtual bool	addElementalLoad (ElementalLoad *)
	Adds the element load being passed as parameter.

virtual bool	removeNodalLoad (int tag)
	To remove the nodal load whose identifier is given by `tag` from the LoadPattern and sets the loads associated Domain object to \(0\). More...

virtual bool	removeElementalLoad (int tag)
	To remove the elemental load whose identifier is given by `tag` from the LoadPattern and set the loads associated Domain object to \(0\). More...

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

Protected Member Functions inherited from EntityWithProperties
bool	isEqual (const EntityWithProperties &) const
	Return true if both objects are equal.

Protected Member Functions inherited from EntityWithOwner
virtual bool	isEqual (const EntityWithOwner &) const
	Return true if both objects are equal.

Friends
class	LoadPattern

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.

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

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

Detailed Description

A LoadContainer object is used to to store loads on nodes and elements.

Member Function Documentation

◆ applyLoad()

void XC::LoadContainer::applyLoad ( const double & factor )

virtual

Apply the load multiplied by the factor.

To apply the load for the pseudo time pseudoTime. From the associated TimeSeries object the LoadPattern will obtain a current load factor for the pseudo time. It will then invoke {applyLoad(load factor)} on the loads and {applyConstraint(load factor)} on the single-point constraints in the LoadPattern. If {setLoadConstant()} has been invoked, the saved load factor is used and no call is made to the TimeSeries object. If no TimeSeries is associated with the object a load factor of \(0.0\) is used.

◆ copyLoads()

void XC::LoadContainer::copyLoads	(	const Element *	fromElement,
		const Element *	toElement
	)

Copy the loads from the first element to the second one.

Parameters

fromElement	element to copy the loads from.
toElement	element to copy the loads to.

◆ getDbTagData()

XC::DbTagData & XC::LoadContainer::getDbTagData ( void ) const

protectedvirtual

Returns a vector to store the dbTags of the class members.

Reimplemented from XC::DistributedBase.

◆ removeElementalLoad()

bool XC::LoadContainer::removeElementalLoad ( int tag )

protectedvirtual

To remove the elemental load whose identifier is given by tag from the LoadPattern and set the loads associated Domain object to \(0\).

Returns a pointer to the load if successfully removed, otherwise \(0\) is returned.

◆ removeNodalLoad()

bool XC::LoadContainer::removeNodalLoad ( int tag )

protectedvirtual

To remove the nodal load whose identifier is given by tag from the LoadPattern and sets the loads associated Domain object to \(0\).

Returns a pointer to the load if successfully removed, otherwise

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

src/domain/load/pattern/LoadContainer.h
src/domain/load/pattern/LoadContainer.cc

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyLoad()

◆ copyLoads()

◆ getDbTagData()

◆ removeElementalLoad()

◆ removeNodalLoad()