XC::ElementalLoad Class Reference

Base class for loads over elements. More...

#include <ElementalLoad.h>

Inheritance diagram for XC::ElementalLoad:

Collaboration diagram for XC::ElementalLoad:

Public Member Functions
	ElementalLoad (int tag=0, int classTag=0)
	Constructor. More...
	ElementalLoad (int tag, int classTag, const ID &)
	Constructor. More...
bool	actsOnElement (const int &) const
	Return true if the load acts on the element identified by the given tag. More...
bool	actsOn (const Element *) const
	Return true if the load acts on the given element.
void	removeLoadOn (const Element *)
	Remove the load on the given element.
void	addLoadOn (const Element *)
	Extend the load to the given element.
virtual std::string	Category (void) const
	Return the category of the load. More...
int	numElements (void) const
	Return the number of loaded elements.
int	setElementTags (const ID &)
	Sets the identifiers of the loaded elements.
int	setElementTagsFromSet (const SetBase &)
	Sets the identifiers of the loaded elements.
virtual const ID &	getElementTags (void) const
	Return the identifiers of the loaded elements.
virtual const Vector &	getData (int &type, const double &loadFactor) const =0
virtual const Vector &	getSensitivityData (const int &gradIndex) const
Public Member Functions inherited from XC::Load
	Load (int tag, int classTag)
	Constructor. More...
virtual void	applyLoad (double loadfactor)=0
	The load object is to add loadFactor times the load to the corresponding residual value at its associated element(s) or node(s). More...
virtual void	setLoadPatternTag (int loadPaternTag)
	Sets the identifier of the pattern to which the load belongs.
virtual int	getLoadPatternTag (void) const
	Return the identifier of the pattern to which the load belongs. More...
Public Member Functions inherited from XC::DomainComponent
	~DomainComponent (void)
	Destructor.
size_t	getIdx (void) const
	Returns the index of the object (to be used in VTK arrays).
virtual void	setDomain (Domain *theDomain)
	Sets the pointer to the domain. More...
virtual Domain *	getDomain (void) const
	Returns a pointer to the enclosing domain. More...
const Preprocessor *	getPreprocessor (void) const
	Returns (if possible) a pointer to the preprocessor.
Preprocessor *	getPreprocessor (void)
	Return (if possible) a pointer to the preprocessor.
const LoadPattern *	getCurrentLoadPattern (void) const
	Return the current load pattern.
LoadPattern *	getCurrentLoadPattern (void)
	Return the current load pattern.
void	set_index (const size_t &i)
	Set the index for the object (see numera in Set). More...
boost::python::dict	getPyDict (void) const
	Return a Python dictionary with 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 XC::TaggedObject
	TaggedObject (int tag, CommandEntity *owr=nullptr)
	Constructor. More...
virtual TaggedObject *	getCopy (void) const
	Virtual constructor.
void	assignTag (int newTag)
	Set tag (to be called from Python interface).
int	getTag (void) const
	Returns the tag associated with the object.
virtual void	Print (std::ostream &, int flag=0) const
	Print stuff.
boost::python::dict	getPyDict (void) const
	Return a Python dictionary with 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 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.
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	sendSelf (Communicator &comm)=0
	Send the object. More...
virtual int	recvSelf (const Communicator &comm)=0
	Receive the object. 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.

Protected Member Functions
int	sendData (Communicator &comm)
	Send data through the communicator argument.
int	recvData (const Communicator &comm)
	Receive data through the communicator argument.
Protected Member Functions inherited from XC::Load
int	sendData (Communicator &comm)
	Send data through the communicator argument.
int	recvData (const Communicator &comm)
	Receive data through the communicator argument.
Protected Member Functions inherited from XC::DomainComponent
	DomainComponent (int tag, int classTag)
	Constructor. More...
int	sendData (Communicator &)
	Send object members through the communicator argument.
int	recvData (const Communicator &)
	Receive object members through the communicator argument.
Protected Member Functions inherited from XC::TaggedObject
void	setTag (int newTag)
	Set tag. More...
bool	isEqual (const TaggedObject &) const
	Return true if both objects are equal.
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.

Protected Attributes
ID	elemTags
	Tags of loaded elements.

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

Base class for loads over elements.

The ElementalLoad class provides the interface that all ElementalLoad writers must provide when introducing new ElementalLoad classes.

Constructor & Destructor Documentation

ElementalLoad() [1/2]

XC::ElementalLoad::ElementalLoad	(	int	tag = 0,
		int	classTag = 0
	)

Constructor.

Parameters

tag	elemental load identifier.
classTag	identifier of the class.

ElementalLoad() [2/2]

XC::ElementalLoad::ElementalLoad	(	int	tag,
		int	classTag,
		const ID &	tags_elems
	)

Constructor.

Parameters

tag	elemental load identifier.
classTag	identifier of the class.
tags_elems	identifiers of the loaded elements.

Member Function Documentation

actsOnElement()

bool XC::ElementalLoad::actsOnElement

(

const int &

eTag

)

const

Return true if the load acts on the element identified by the given tag.

Category()

std::string XC::ElementalLoad::Category ( void  ) const

virtual

Return the category of the load.

Return a string like 'uniform', 'punctual',...

Reimplemented in XC::SurfaceLoad, XC::ShellUniformLoad, XC::BeamPointLoad, XC::QuadRawLoad, XC::ShellRawLoad, XC::BrickRawLoad, XC::BeamLoad, XC::BidimLoad, XC::ThreedimLoad, and XC::BeamUniformLoad.

---

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

• src/domain/load/ElementalLoad.h
• src/domain/load/ElementalLoad.cpp