Base class for model constraints. More...

#include <Constraint.h>

Inheritance diagram for XC::Constraint:

Collaboration diagram for XC::Constraint:

Public Member Functions
	Constraint (int classTag)
	Default constructor; receives the tag of the class as a paramenter. More...

	Constraint (int spTag, int nodeTag, int classTag)
	Constructor. More...

	~Constraint (void)
	Destructor.

void	setNodeTag (const int &nt)
	Sets the identifier of the node that will be constrained. More...

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

virtual const Node *	getNode (void) const
	Returns a pointer to the constrained node.

virtual int	getNodeIdx (void) const
	Returns an index for the node (used for VTK arrays).

virtual int	applyConstraint (double loadFactor)=0

virtual bool	affectsNode (int) const
	Returns true ifafecta to the node cuyo tag being passed as parameter.

virtual bool	affectsNodeAndDOF (int, int) const
	Returns true if the constraint affects the node and DOF arguments.

void	setDomain (Domain *)
	Sets the domain for the constraint. More...

virtual int	getVtkCellType (void) const
	returns the VTK cell type.

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.

virtual void	Print (std::ostream &s, int flag=0) const
	Prints some information about the constraint. More...

Public Member Functions inherited from XC::ContinuaReprComponent
	ContinuaReprComponent (int classTag)

	ContinuaReprComponent (int tag, int classTag)

virtual const bool	isDead (void) const
	Return true if the component is not active.

virtual const bool	isAlive (void) const
	Return true if the component is active.

virtual void	kill (void)
	Deactivates the component.

virtual void	alive (void)
	Activates the component.

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

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	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 &)
	Send members through the communicator argument. More...

int	recvData (const Communicator &)
	Receives members through the communicator argument. More...

Protected Member Functions inherited from XC::ContinuaReprComponent
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::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
int	constrNodeTag
	constrained node tag

bool	initialized
	a flag to avoid recomputing the intial value in setDomain if already initialized

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

Constructor & Destructor Documentation

◆ Constraint() [1/2]

XC::Constraint::Constraint ( int classTag )

Default constructor; receives the tag of the class as a paramenter.

Parameters

classTag identifier for the object class (see classTags.h).

◆ Constraint() [2/2]

XC::Constraint::Constraint	(	int	tag,
		int	node,
		int	classTag
	)

Constructor.

Parameters

classTag	identifier for the object class (see classTags.h).
tag	identifier for the constraint.
node	identifier for the node that will be constrained.

Member Function Documentation

◆ Print()

void XC::Constraint::Print	(	std::ostream &	s,
		int	flag = `0`
	)		const

virtual

Prints some information about the constraint.

Parameters

s	output stream.
flag	indicates the amount of information to be printed.

Reimplemented from XC::TaggedObject.

Reimplemented in XC::MFreedom_Constraint, XC::SFreedom_Constraint, XC::MRMFreedom_Constraint, XC::MFreedom_Joint3D, XC::MFreedom_ConstraintBase, XC::MFreedom_Joint2D, XC::MFreedom_Joint, XC::ImposedMotionSP1, and XC::ImposedMotionSP.

◆ recvData()

int XC::Constraint::recvData ( const Communicator & comm )

protected

Receives members through the communicator argument.

Parameters

cp	definition of the communication parameters.

◆ sendData()

int XC::Constraint::sendData ( Communicator & comm )

protected

Send members through the communicator argument.

Parameters

cp	definition of the communication parameters.

◆ setDomain()

void XC::Constraint::setDomain ( Domain * model )

virtual

Sets the domain for the constraint.

Parameters

model domain in which the constraint is created.

Reimplemented from XC::DomainComponent.

Reimplemented in XC::MFreedom_Constraint, XC::SFreedom_Constraint, XC::MRMFreedom_Constraint, XC::MFreedom_Joint3D, XC::MFreedom_ConstraintBase, XC::MFreedom_Joint, XC::ImposedMotionBase, and XC::RigidBase.

◆ setNodeTag()

void XC::Constraint::setNodeTag ( const int & nt )

Sets the identifier of the node that will be constrained.

Parameters

nt node tag.

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

src/domain/constraints/Constraint.h
src/domain/constraints/Constraint.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Constraint() [1/2]

◆ Constraint() [2/2]

Member Function Documentation

◆ Print()

◆ recvData()

◆ sendData()

◆ setDomain()

◆ setNodeTag()