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

#include <LoadContainer.h>

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

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 (CommParameters &)
	Sends object through the channel being passed as parameter.

virtual int	recvSelf (const CommParameters &)
	Receives object through the channel being passed as parameter.

virtual void	Print (std::ostream &s, int flag=0)
	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 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	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.

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 (CommParameters &cp)
	Send members through the channel being passed as parameter.

int	recvData (const CommParameters &cp)
	Receives members through the channel being passed as parameter.

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

Friends
class	LoadPattern

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.

§ 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 succesfully 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 laods associated Domain object to \(0\).

Returns a pointer to the load if succesfully 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

Detailed Description

Member Function Documentation

§ applyLoad()

§ getDbTagData()

§ removeElementalLoad()

§ removeNodalLoad()