#include <NodalLoad.h>

Inheritance diagram for XC::NodalLoad:

Public Member Functions
	NodalLoad (int tag, int theClassTag=LOAD_TAG_NodalLoad)
	Constructor. More...

	NodalLoad (int tag, int node, int classTag)
	Constructor. More...

	NodalLoad (int tag, int node, const Vector &load, bool isLoadConstant=false)
	Constructor. More...

virtual void	setDomain (Domain *newDomain)
	To set the associated Domain object. More...

const Node *	getNode (void) const

virtual int	getNodeTag (void) const
	Returns the identifier of the loaded node.

virtual void	applyLoad (double loadFactor)
	Applies the load on the node. More...

const Vector &	getForce (void) const
	Returns the componentes of the force vector.

const Vector &	getMoment (void) const
	Returns the components of the moment.

virtual int	sendSelf (CommParameters &)
	Sends the object.

virtual int	recvSelf (const CommParameters &)
	Receives.

virtual void	Print (std::ostream &s, int flag=0)
	Print stuff.

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

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

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

const Vector &	getExternalForceSensitivity (int gradNumber)

Public Member Functions inherited from XC::Load
	Load (int tag, int classTag)
	Constructor. 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 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.

void	set_index (const size_t &i)
	Set the index for the object (see numera in Set). More...

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.

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)
	Sends object member through the communicator being passed as parameter. More...

int	recvData (const CommParameters &cp)
	Receives object member through the communicator being passed as parameter. More...

Protected Member Functions inherited from XC::Load
int	sendData (CommParameters &cp)
	Send data through the channel being passed as parameter.

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

Protected Member Functions inherited from XC::DomainComponent
	DomainComponent (int tag, int classTag)
	Constructor. More...

int	sendData (CommParameters &)
	Send object members through the channel being passed as parameter.

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

Protected Member Functions inherited from XC::TaggedObject
void	setTag (int newTag)
	Set tag. More...

Detailed Description

Load over a node.

NodalLoads are loads acting on Nodes. The public methods are all declared as virtual to allow subclasses to be introduced for the provision of time varying loads. Each NodalLoad object is associated with a single Node object and has a Vector object corresponding to the load acting on this Node object as a result of the NodalLoad.

Constructor & Destructor Documentation

§ NodalLoad() [1/3]

XC::NodalLoad::NodalLoad	(	int	tag,
		int	classTag = `LOAD_TAG_NodalLoad`
	)

Constructor.

Parameters

tag	nodal load identifier.
classTag	identifier of the class.

§ NodalLoad() [2/3]

XC::NodalLoad::NodalLoad	(	int	tag,
		int	nodeTag,
		int	classTag
	)

Constructor.

Parameters

tag	nodal load identifier.
nodeTag	identifier of the loaded node.
classTag	identifier of the class.

§ NodalLoad() [3/3]

XC::NodalLoad::NodalLoad	(	int	tag,
		int	nodeTag,
		const Vector &	theLoad,
		bool	isLoadConstant = `false`
	)

Constructor.

To create a NodalLoad object with tag tag acting on Node node with a reference load given by load. tag and {LOAD_TAG_NodalLoad} (defined in \(<\)classTags.h \(>\))are passed to the Load constructor. A new vector object is created using the vector load as the argument. (THIS MAY CHANGE - may associate the load Vector with load, allowing identical loads on diff nodes to be created without the need for each to have its own vector) If no enough memory is available an error message is printed and the program terminates. The boolean isLoadConstant is used to indicate whether the value of the load applies to the Node is independent of the load factor.

Parameters

tag	nodal load identifier.
nodeTag	identifier of the loaded node.
theLoad	load value.
isLoadConstant	true if load doesn't change with time.

Member Function Documentation

§ applyLoad()

void XC::NodalLoad::applyLoad ( double loadFactor )

virtual

Applies the load on the node.

To it's associated Node it invokes addUnbalancedLoad() with it's load and a factor of loadFactor if isLoadConstant was specified as false in the constructor or \(1.0\) if it was specified as true.

Implements XC::Load.

§ getDbTagData()

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

protectedvirtual

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

Reimplemented from XC::DistributedBase.

§ recvData()

int XC::NodalLoad::recvData ( const CommParameters & cp )

protected

Receives object member through the communicator being passed as parameter.

§ sendData()

int XC::NodalLoad::sendData ( CommParameters & cp )

protected

Sends object member through the communicator being passed as parameter.

§ setDomain()

void XC::NodalLoad::setDomain ( Domain * newDomain )

virtual

To set the associated Domain object.

Reimplemented from XC::DomainComponent.

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

src/domain/load/NodalLoad.h
src/domain/load/NodalLoad.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

§ NodalLoad() [1/3]

§ NodalLoad() [2/3]

§ NodalLoad() [3/3]

Member Function Documentation

§ applyLoad()

§ getDbTagData()

§ recvData()

§ sendData()

§ setDomain()