Base class for model constraints. More...

#include <Constraint.h>

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

virtual void	Print (std::ostream &s, int flag=0)
	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

virtual const bool	isAlive (void) const

virtual void	kill (void)

virtual void	alive (void)

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	sendSelf (CommParameters &cp)=0
	Send the object. More...

virtual int	recvSelf (const CommParameters &cp)=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 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 (CommParameters &)
	Send members through the channel being passed as parameter. More...

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

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

int	recvData (const CommParameters &)
	Receives members 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...

Protected Attributes
int	constrNodeTag
	constrained node tag

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`
	)

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 CommParameters & cp )

protected

Receives members through the channel being passed as parameter.

Parameters

cp	definition of the communication parameters.

§ sendData()

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

protected

Send members through the channel being passed as parameter.

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 wich the constraint is created.

Reimplemented from XC::DomainComponent.

Reimplemented in XC::MFreedom_Joint3D, 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

Detailed Description

Constructor & Destructor Documentation

§ Constraint() [1/2]

§ Constraint() [2/2]

Member Function Documentation

§ Print()

§ recvData()

§ sendData()

§ setDomain()

§ setNodeTag()