A LagrangeDOF_Group object is instantiated by a LagrangeConstraintHandler for every constrained node in the domain. More...

#include <LagrangeDOF_Group.h>

Inheritance diagram for XC::LagrangeDOF_Group:

[legend]

Collaboration diagram for XC::LagrangeDOF_Group:

[legend]

Public Member Functions
virtual const Matrix &	getTangent (Integrator *theIntegrator)
	Does nothing; the Lagrange FE_Elements provide coeffs to tangent.

virtual const Vector &	getUnbalance (Integrator *theIntegrator)
	Does nothing; the Lagrange FE_Elements provide residual.

virtual const Vector &	getCommittedDisp (void)
	To return the committed displacement at the associated node. More...

virtual const Vector &	getCommittedVel (void)
	Return the committed velocity at the associated node. More...

virtual const Vector &	getCommittedAccel (void)
	Return the committed acceleration at the associated node. More...

virtual void	setNodeDisp (const Vector &u)
	Does nothing. More...

virtual void	setNodeVel (const Vector &udot)
	Does nothing. More...

virtual void	setNodeAccel (const Vector &udotdot)
	Does nothing. More...

virtual void	incrNodeDisp (const Vector &u)
	Does nothing. More...

virtual void	incrNodeVel (const Vector &udot)
	Does nothing. More...

virtual void	incrNodeAccel (const Vector &udotdot)
	Does nothing. More...

virtual void	zeroTangent (void)
	To zero the tangent matrix. More...

virtual void	addMtoTang (double fact=1.0)
	To add `fact` times the nodal mass matrix to the tangent matrix. More...

virtual void	zeroUnbalance (void)
	To zero the unbalance vector. More...

virtual void	addPtoUnbalance (double fact=1.0)
	Adds the product of the unbalanced load at the node and `fact` to the unbalance vector. More...

virtual void	addPIncInertiaToUnbalance (double fact=1.0)

virtual void	addM_Force (const Vector &Udotdot, double fact=1.0)

virtual const Vector &	getTangForce (const Vector &x, double fact=1.0)

virtual const Vector &	getC_Force (const Vector &x, double fact=1.0)

virtual const Vector &	getM_Force (const Vector &x, double fact=1.0)

Public Member Functions inherited from XC::DOF_Group
virtual	~DOF_Group ()
	Destructor.

virtual void	setID (int dof, int value)
	to set the corresponding index of the ID to value. More...

virtual void	setID (const ID &values)
	Method to set the ID to be same as that given. More...

virtual const ID &	getID (void) const
	Method to return the current ID. More...

int	inicID (const int &value)

virtual int	getNodeTag (void) const
	Returns the tag of the associated node (-1 if there is no associated node). More...

virtual int	getNumDOF (void) const
	Returns the total number of DOFs in the DOF_Group.

virtual int	getNumFreeDOF (void) const
	Returns the total number of `free` DOFs. More...

virtual int	getNumConstrainedDOF (void) const
	Returns the total number of `constrained` DOFs. More...

virtual void	addCtoTang (double fact=1.0)

virtual const Vector &	getTrialDisp (void) const
	Return trial displacement.

virtual const Vector &	getTrialVel (void) const
	Return trial velocity.

virtual const Vector &	getTrialAccel (void) const
	Return trial acceleration.

virtual void	setEigenvector (int mode, const Vector &eigenvalue)

virtual Matrix *	getT (void)

virtual void	addM_ForceSensitivity (const Vector &Udotdot, double fact=1.0)

virtual void	addD_ForceSensitivity (const Vector &vel, double fact=1.0)

virtual void	addD_Force (const Vector &vel, double fact=1.0)

virtual const Vector &	getDispSensitivity (int gradNumber)

virtual const Vector &	getVelSensitivity (int gradNumber)

virtual const Vector &	getAccSensitivity (int gradNumber)

virtual int	saveSensitivity (Vector v, Vector vdot, Vector *vdotdot, int gradNum, int numGrads)

virtual void	Print (std::ostream &, int=0)

virtual void	resetNodePtr (void)

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.

virtual void	Print (std::ostream &, int flag=0) const
	Print stuff.

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

Protected Member Functions
	LagrangeDOF_Group (int tag, SFreedom_Constraint &)
	Constructor. More...

	LagrangeDOF_Group (int tag, MFreedom_Constraint &)
	Constructor. More...

	LagrangeDOF_Group (int tag, MRMFreedom_Constraint &)
	Constructor. More...

Protected Member Functions inherited from XC::DOF_Group
void	addLocalM_Force (const Vector &Udotdot, double fact=1.0)

	DOF_Group (int tag, Node *myNode)
	Constructor that take the corresponding model node. More...

	DOF_Group (int tag, int ndof)
	Constructor. More...

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

Friends
class	AnalysisModel

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::DOF_Group
UnbalAndTangent	unbalAndTangent

Node *	myNode

Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

A LagrangeDOF_Group object is instantiated by a LagrangeConstraintHandler for every constrained node in the domain.

It is used to introduce the lagrange multipliers associated with single and multi-point constraints into the system of equation.

Constructor & Destructor Documentation

◆ LagrangeDOF_Group() [1/3]

XC::LagrangeDOF_Group::LagrangeDOF_Group	(	int	tag,
		SFreedom_Constraint &	spPtr
	)

protected

Constructor.

Parameters

tag	object identifier.
spPtr	pointer to a single DOF constraint.

◆ LagrangeDOF_Group() [2/3]

XC::LagrangeDOF_Group::LagrangeDOF_Group	(	int	tag,
		MFreedom_Constraint &	mpPtr
	)

protected

Constructor.

Parameters

tag	object identifier.
spPtr	pointer to a multiple DOF constraint.

◆ LagrangeDOF_Group() [3/3]

XC::LagrangeDOF_Group::LagrangeDOF_Group	(	int	tag,
		MRMFreedom_Constraint &	mrmpPtr
	)

protected

Constructor.

Parameters

tag	object identifier.
spPtr	pointer to a multiple row multiple DOF constraint.

Member Function Documentation

◆ addMtoTang()

void XC::LagrangeDOF_Group::addMtoTang ( double fact = 1.0 )

virtual

To add fact times the nodal mass matrix to the tangent matrix.

To add fact times the nodal mass matrix to the tangent matrix. In this base class, if a Matrix to store the tangent has not yet been created, one of size (numDOF,numDOF) is now created; if construction of this matrix fails an error is printed and an error Matrix is returned. Invokes {addMatrix(theNode- \(>\)getMass,fact)} on the Matrix, printing a warining message if this method returns a \(negative\) value. If no Node is associated with the DOF_Group an error message is printed and nothing is done.

Reimplemented from XC::DOF_Group.

◆ addPtoUnbalance()

void XC::LagrangeDOF_Group::addPtoUnbalance ( double fact = 1.0 )

virtual

Adds the product of the unbalanced load at the node and fact to the unbalance vector.

Adds the product of the unbalanced load at the node and fact to the unbalance vector. A warning message is printed and nothing is done if no node is associated with the DOF_Group, otherwise {addVector(theNode- \(>\)getUnbalancedLoad(),fact)} is invoked on the unbalance vector and a warning message is printed if this method returns a negative value.

Reimplemented from XC::DOF_Group.

◆ getCommittedAccel()

const XC::Vector & XC::LagrangeDOF_Group::getCommittedAccel ( void )

virtual

Return the committed acceleration at the associated node.

Return the committed acceleration at the associated node. Returns result of invoking getAccel() on the Node. If there is no associated node object, an error message is printed and an error Vector is returned.

Reimplemented from XC::DOF_Group.

◆ getCommittedDisp()

const XC::Vector & XC::LagrangeDOF_Group::getCommittedDisp ( void )

virtual

To return the committed displacement at the associated node.

To return the committed displacement at the associated node. Returns the result of invoking getDisp() on the node. If there is no associated node object, an error message is printed and an error Vector is returned.

Reimplemented from XC::DOF_Group.

◆ getCommittedVel()

const XC::Vector & XC::LagrangeDOF_Group::getCommittedVel ( void )

virtual

Return the committed velocity at the associated node.

To return the committed velocity at the associated node. Returns the result of invoking getVel() on the node. If there is no associated node object, an error message is printed and an error Vector is returned.

Reimplemented from XC::DOF_Group.