XC::UniformExcitation Class Reference

Load pattern for a earthquake with a similar excitation for all supports. More...

#include <UniformExcitation.h>

Inheritance diagram for XC::UniformExcitation:

Collaboration diagram for XC::UniformExcitation:

Public Member Functions
	UniformExcitation (int tag=0)
	Constructor.
	UniformExcitation (GroundMotion &theMotion, int dof, int tag, double vel0=0.0, const double &fact=1.0)
	Constructor.
GroundMotion &	getGroundMotionRecord (void)
	Return the ground motion record.
void	setDomain (Domain *theDomain)
	Assigns a domain to this load.
void	applyLoad (double time)
	Applies the load. More...
void	Print (std::ostream &s, int flag=0) const
	Prints stuff.
void	setDof (const int &dof)
	set the affected dof.
int	getDof (void) const
	return the affected dof.
void	setInitialVelocity (const double &v0)
	set initial velocity.
double	getInitialVelocity (void) const
	return initial velocity.
void	setFactor (const double &f)
	set multiplication factor.
double	getFactor (void) const
	return multiplication factor.
int	sendSelf (Communicator &)
	Sends object through the communicator argument.
int	recvSelf (const Communicator &)
	Receives object through the communicator argument.
void	applyLoadSensitivity (double time)
	Applies load sensitivity.
Public Member Functions inherited from XC::EarthquakePattern
	EarthquakePattern (int tag, int classTag)
virtual bool	addSFreedom_Constraint (SFreedom_Constraint *)
	Adds the constraint 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 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.
Public Member Functions inherited from XC::EQBasePattern
	EQBasePattern (int tag, int classTag)
size_t	getNumMotions (void) const
void	clear (void)
Public Member Functions inherited from XC::LoadPattern
	LoadPattern (int tag=0)
	Constructor.
	LoadPattern (int tag, int classTag)
	Constructor. More...
virtual	~LoadPattern (void)
	Destructor.
const TimeSeries *	getTimeSeries (void) const
	Return the time series pointer (const version).
TimeSeries *	getTimeSeries (void)
	Return the time series pointer.
virtual void	setTimeSeries (TimeSeries *theSeries)
	Set the time series for the pattern.
bool	addToDomain (void)
	Apply load.
void	removeFromDomain (void)
	Removes load.
virtual bool	isActive (void) const
	Return true if the load pattern is already added to the domain. More...
NodalLoad *	newNodalLoad (const int &, const Vector &)
	Creates a nodal load. More...
bool	newElementalLoad (ElementalLoad *)
	Appends the elemental load being passed as parameter.
ElementalLoad *	newElementalLoad (const std::string &)
	Creates a new load over elements. More...
LoadContainer &	getLoads (void)
	Return the load container.
const LoadContainer &	getLoads (void) const
	Return the load container.
int	getNumNodalLoads (void) const
	Return the number of nodal loads.
int	getNumElementalLoads (void) const
	Return the number of elemental loads.
int	getNumLoads (void) const
	Return the number of loads.
virtual void	clearAll (void)
	Deletes all loads, constraints AND pointer to time series.
virtual void	clearLoads (void)
	Deletes all loads.
virtual bool	removeNodalLoad (int tag)
	Remove the nodal load which tag is being passed as parameter.
virtual bool	removeElementalLoad (int tag)
	Remove the load over element which tag is being passed as parameter.
bool	actsOn (const Node *) const
	Return true if the load pattern acts on the given node.
void	removeLoadsOn (const Node *)
	Removes the given node from all the load patterns.
void	copyLoads (const Node *, const Node *)
	Copy the loads from the first node to the second one. More...
bool	actsOn (const Element *) const
	Return true if the load pattern acts on the given element.
void	removeLoadsOn (const Element *)
	Removes the given element from all the load patterns.
void	copyLoads (const Element *, const Element *)
	Copy the loads from the first element to the second one. More...
virtual void	setLoadConstant (void)
	Marks the LoadPattern as being constant. More...
void	setIsConstant (const bool &b)
bool	getIsConstant (void) const
const MapLoadPatterns *	getMapLoadPatterns (void) const
	Returns a const pointer to the container of the load pattern.
MapLoadPatterns *	getMapLoadPatterns (void)
	Returns a pointer to the container of the load pattern.
const std::string &	getName (void) const
	Returns the name of this load pattern.
std::string	getFactoredName (void) const
	Returns the name of this load pattern multiplied by its partial safety factor. More...
const std::string &	getDescription (void) const
void	setDescription (const std::string &d)
virtual const double &	getLoadFactor (void) const
	Returns the weighting factor obtained from the TimeSeries object.
const double &	GammaF (void) const
	Returns the partial safety factor according to the load combination.
double &	GammaF (void)
	Returns the partial safety factor according to the load combination.
void	setGammaF (const double &)
	Sets the partial safety factor according to the load combination.
LoadPattern &	operator*= (const double &fact)
	Multiplies the partial safety factor.
LoadPattern &	operator/= (const double &fact)
	Divides the partial safety factor.
virtual LoadPattern *	getCopy (void)
	Virtual constructor.
virtual int	addMotion (GroundMotion &theMotion, int tag)
virtual GroundMotion *	getMotion (int tag)
virtual const Vector &	getExternalForceSensitivity (int gradNumber)
Public Member Functions inherited from XC::NodeLocker
virtual	~NodeLocker (void)
	Destructor.
virtual SFreedom_Constraint *	addSFreedom_Constraint (const int &nodeTag, const int &dofId, const double &)
	Adds the single freedom constraint being passed as parameter.
virtual SFreedom_ConstraintIter &	getSPs (void)
	Returns an iterator to the single freedom constraints.
int	getNumSPs (void) const
	Returns the number of single freedom constraints.
bool	hasSPWithTag (const int &) const
	Returns true if it contains a single freedom constraint with the identifier passes as parameter. More...
const SFreedom_Constraint *	getSFreedomConstraint (const int &) const
	Return the constraint identified by the tag argument.
SFreedom_Constraint *	newSPConstraint (const int &, const int &, const double &)
	Creates a single freedom constraint. More...
virtual bool	removeSFreedom_Constraint (int tag)
	Erases the single freedom constraint identified by the argument. More...
virtual void	applyLoad (const double &pseudoTime=0.0, const double &factor=1.0)
	Applies the single freedom constraints. More...
std::deque< int >	getTagsSPsNode (int theNode, int theDOF) const
	Returns the constraint that affect the node and DOF being passed as parameter. More...
std::deque< int >	getTagsSPsNode (int theNode) const
	Returns the constraint that affect the node being passed as parameter. More...
bool	nodeAffectedBySPs (int nodeTag) const
	Returns true if the single freedom constraints affect the node which identifier is being passed as parameter. More...
Public Member Functions inherited from XC::ForceReprComponent
	ForceReprComponent (int classTag)
	ForceReprComponent (int tag, int classTag)
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.
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.
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	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
int	sendData (Communicator &)
	Send object members through the communicator argument.
int	recvData (const Communicator &)
	Receives object members through the communicator argument.
Protected Member Functions inherited from XC::EarthquakePattern
void	copy (const Vector *, const Vector *)
int	addMotion (GroundMotion &)
	Adds the GroundMotion, theMotion to the list of GroundMotion objects. More...
int	sendData (Communicator &)
	Send object members through the communicator argument.
int	recvData (const Communicator &)
	Receives object members through the communicator argument.
Protected Member Functions inherited from XC::EQBasePattern
int	addMotion (GroundMotion &theMotion)
int	sendData (Communicator &)
	Send members through the communicator argument.
int	recvData (const Communicator &)
	Receives members through the communicator argument.
Protected Member Functions inherited from XC::LoadPattern
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.
Protected Member Functions inherited from XC::NodeLocker
DbTagData &	getDbTagData (void) const
	Returns a vector to store the dbTags de los miembros of the clase. More...
int	sendData (Communicator &comm)
	Send members through the communicator argument.
int	recvData (const Communicator &comm)
	Receives members through the communicator argument.
	NodeLocker (void)
	Default constructor.
	NodeLocker (int tag)
	Constructor.
	NodeLocker (int tag, int classTag)
	Constructor.
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.

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)
Protected Attributes inherited from XC::EQBasePattern
DqGroundMotions	theMotions
Protected Attributes inherited from XC::LoadPattern
bool	isConstant
	to indicate whether setConstant has been called
Protected Attributes inherited from XC::NodeLocker
int	nextTag
	Default tag for next node locker.
int	currentGeoTag
int	lastGeoSendTag
TaggedObjectStorage *	theSPs
	Constraint container.
SingleDomSFreedom_Iter *	theSpIter
	Constraint iterator.
Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

Load pattern for a earthquake with a similar excitation for all supports.

A UniformExcitation is an object which adds the loads imposed by a single ground excitation to the model. For a UniformExcitation this means that the R matrix at each node will have \(1\) column and all entries but those corresponding to the degree of freedom direction will be set to \(0\), the value for the degree of freedom direction will be set to \(1\).

Member Function Documentation

applyLoad()

void XC::UniformExcitation::applyLoad ( double  time )

virtual

Applies the load.

Parameters

time	instant to calculate the value of the load.

Checks to see if the number of nodes in the domain has changed, if there has been a change it invokes {setNumColR(1)} and then {setR(theDof, 0, 1.0)} on each Node. It then invokes the base classes applyLoad() method. THIS SHOULD BE CHANGED TO USE LATEST domainChanged().

Reimplemented from XC::EarthquakePattern.

---

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

• src/domain/load/pattern/load_patterns/UniformExcitation.h
• src/domain/load/pattern/load_patterns/UniformExcitation.cpp