Base class for mult-freedom constraints. More...

#include <MFreedom_ConstraintBase.h>

Inheritance diagram for XC::MFreedom_ConstraintBase:

Public Member Functions
	MFreedom_ConstraintBase (int tag, int classTag)
	Constructor. More...

	MFreedom_ConstraintBase (int tag, int nodeConstr, int classTag)
	Constructor to be called from subclasses. More...

	MFreedom_ConstraintBase (int tag, int nodeConstr, const ID &, int classTag)
	Constructor to be called from subclasses. More...

	MFreedom_ConstraintBase (int tag, int nodeConstr, const Matrix &, const ID &, int classTag)
	Constructor. More...

virtual const int &	getNodeConstrained (void) const
	Return the identifier of the constrained node.

virtual int &	getNodeConstrained (void)
	Return the identifier of the constrained node.

virtual const ID &	getRetainedDOFs (void) const =0

virtual const ID &	getConstrainedDOFs (void) const
	Returns the identifiers of the constrained degrees of fredom.

virtual const Matrix &	getConstraint (void) const
	Returns the constraint matrix. More...

virtual size_t	getNumRetainedNodes (void) const =0

virtual std::vector< XC::Node * >	getPointersToRetainedNodes (void) const =0

bool	isTimeVarying (void) const
	Returns true if the constraint varies with time.

bool	affectsNode (int) const
	Returns true if the constraints affects the node identified by the tag being passed as parameter. More...

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

int	addResistingForceToNodalReaction (bool inclInertia)
	Add reactions to nodes.

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

Public Member Functions inherited from XC::Constraint
	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

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

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

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
void	set_constraint (const Matrix &c)
	Set the constraint matrix.

void	set_constrained_dofs (const ID &)
	Set the constrained degrees of freedom. More...

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::Constraint
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
Matrix	constraintMatrix
	Constraint matrix.

ID	constrDOF
	ID of constrained DOF at constrained node.

Protected Attributes inherited from XC::Constraint
int	constrNodeTag
	constrained node tag

Detailed Description

Base class for mult-freedom constraints.

Constructor & Destructor Documentation

§ MFreedom_ConstraintBase() [1/4]

XC::MFreedom_ConstraintBase::MFreedom_ConstraintBase	(	int	tag,
		int	classTag
	)

Constructor.

Parameters

tag	tag for the constraint.
classTag	tag of the object class.

§ MFreedom_ConstraintBase() [2/4]

XC::MFreedom_ConstraintBase::MFreedom_ConstraintBase	(	int	tag,
		int	nodeConstr,
		int	classTag
	)

Constructor to be called from subclasses.

Parameters

tag	tag for the constraint.
nodeConstr	identifier of the constrained node.
classTag	tag of the object class.

§ MFreedom_ConstraintBase() [3/4]

XC::MFreedom_ConstraintBase::MFreedom_ConstraintBase	(	int	tag,
		int	nodeConstr,
		const ID &	constrainedDOF,
		int	classTag
	)

Constructor to be called from subclasses.

Parameters

tag	tag for the constraint.
nodeConstr	identifier of the constrained node.
constrainedDOF	constrained degrees of freedom.
classTag	tag of the object class.

§ MFreedom_ConstraintBase() [4/4]

XC::MFreedom_ConstraintBase::MFreedom_ConstraintBase	(	int	tag,
		int	nodeConstr,
		const Matrix &	constr,
		const ID &	constrainedDOF,
		int	classTag
	)

Constructor.

Parameters

tag	tag for the constraint.
nodeConstr	identifier of the constrained node.
constr	constraint matrix.
constrainedDOF	constrained degrees of freedom.
classTag	tag of the object class.

Member Function Documentation

§ affectsNode()

bool XC::MFreedom_ConstraintBase::affectsNode ( int nodeTag ) const

virtual

Returns true if the constraints affects the node identified by the tag being passed as parameter.

Reimplemented from XC::Constraint.

Reimplemented in XC::MRMFreedom_Constraint.

§ getConstraint()

const XC::Matrix & XC::MFreedom_ConstraintBase::getConstraint ( void ) const

virtual

Returns the constraint matrix.

Returns the current constraint Matrix, that determined in the last call to applyConstraint(). For the MFreedom_Constraint class, \(C_{cr}\) determined in the constructor is returned.

Reimplemented in XC::MFreedom_Joint2D.

§ Print()

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

virtual

Printing.

Prints out the MFreedom_Constraints tag, then the tags of the constrained and retained nodes, then the two ID's and finally the constraint Matrix.

Reimplemented from XC::Constraint.

Reimplemented in XC::MFreedom_Constraint, XC::MRMFreedom_Constraint, XC::MFreedom_Joint3D, XC::MFreedom_Joint2D, and XC::MFreedom_Joint.

§ set_constrained_dofs()

void XC::MFreedom_ConstraintBase::set_constrained_dofs ( const ID & constrainedDOF )

protected

Set the constrained degrees of freedom.

Parameters

constrainedDOF constrained degrees of freedom.

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

src/domain/constraints/MFreedom_ConstraintBase.h
src/domain/constraints/MFreedom_ConstraintBase.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

§ MFreedom_ConstraintBase() [1/4]

§ MFreedom_ConstraintBase() [2/4]

§ MFreedom_ConstraintBase() [3/4]

§ MFreedom_ConstraintBase() [4/4]

Member Function Documentation

§ affectsNode()

§ getConstraint()

§ Print()

§ set_constrained_dofs()