Single freedom constraints that make part of a load pattern. More...

#include <NodeLocker.h>

Inheritance diagram for XC::NodeLocker:

Collaboration diagram for XC::NodeLocker:

Public Member Functions
virtual	~NodeLocker (void)
	Destructor.

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

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.

virtual void	clearAll (void)
	Deletes all constraints.

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

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
	Imprime el load pattern.

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.

virtual bool	operator== (const EntityWithProperties &) const
	Comparison operator.

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

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

virtual bool	addSFreedom_Constraint (SFreedom_Constraint *theSp)
	Adds the single freedom constraint being passed as parameter.

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

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

Protected Attributes
int	nextTag
	Default tag for next node locker.

int	currentGeoTag

int	lastGeoSendTag

TaggedObjectStorage *	theSPs
	Constraint container.

SingleDomSFreedom_Iter *	theSpIter
	Constraint iterator.

Friends
class	NodeLockers

class	FEM_ObjectBroker

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

Single freedom constraints that make part of a load pattern.

Member Function Documentation

◆ applyLoad()

void XC::NodeLocker::applyLoad	(	const double &	pseudoTime = `0.0`,
		const double &	factor = `1.0`
	)

virtual

Applies the single freedom constraints.

Parameters

pseudoTime	ignored (single freedom constraints doesn't depend on it).
factor	factor that weights the prescribed values.

◆ getDbTagData()

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

protectedvirtual

Returns a vector to store the dbTags de los miembros of the clase.

Reimplemented from XC::DistributedBase.

◆ getTagsSPsNode() [1/2]

std::deque< int > XC::NodeLocker::getTagsSPsNode	(	int	theNode,
		int	theDOF
	)		const

Returns the constraint that affect the node and DOF being passed as parameter.

Parameters

theNode	node identifier.
theDOF	identifier or the degree of freedom.

◆ getTagsSPsNode() [2/2]

std::deque< int > XC::NodeLocker::getTagsSPsNode ( int theNode ) const

Returns the constraint that affect the node being passed as parameter.

Parameters

theNode node identifier.

◆ hasSPWithTag()

bool XC::NodeLocker::hasSPWithTag ( const int & tag ) const

Returns true if it contains a single freedom constraint with the identifier passes as parameter.

◆ newSPConstraint()

XC::SFreedom_Constraint * XC::NodeLocker::newSPConstraint	(	const int &	tag_nod,
		const int &	dofId,
		const double &	value
	)

Creates a single freedom constraint.

Parameters

tag_nod	identifier of the constrained node.
dofId	identifier of the degree of freedom.
value	value of the prescribed displacement.

◆ nodeAffectedBySPs()

bool XC::NodeLocker::nodeAffectedBySPs ( int nodeTag ) const

Returns true if the single freedom constraints affect the node which identifier is being passed as parameter.

◆ removeSFreedom_Constraint()

bool XC::NodeLocker::removeSFreedom_Constraint ( int tag )

virtual

Erases the single freedom constraint identified by the argument.

Parameters

tag	single freedom constraint identifier.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyLoad()

◆ getDbTagData()

◆ getTagsSPsNode() [1/2]

◆ getTagsSPsNode() [2/2]

◆ hasSPWithTag()

◆ newSPConstraint()

◆ nodeAffectedBySPs()

◆ removeSFreedom_Constraint()