ConstraintHandlers enforce the single and multi freedom constraints that exist in the domain by creating the appropriate FE_Element and DOF_Group objects. More...

#include <ConstraintHandler.h>

Inheritance diagram for XC::ConstraintHandler:

[legend]

Collaboration diagram for XC::ConstraintHandler:

[legend]

Public Member Functions
virtual int	handle (const ID *nodesNumberedLast=0)=0
	Invoked to handle the constraints imposed on the domain by the constraints. More...

virtual int	update (void)
	Update the state of the constraints.

virtual int	applyLoad (void)
	??

virtual int	doneNumberingDOF (void)
	Numbering of degrees of freedom.

virtual void	clearAll (void)
	Reset the DOF_Group pointers to nullptr for all the nodes. More...

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.

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.

boost::python::dict	getPyDict (void) const
	Return a Python dictionary containing 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 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
const Domain *	getDomainPtr (void) const
	Return a const pointer to the domain object associated with the ConstraintHandler.

const AnalysisModel *	getAnalysisModelPtr (void) const
	Return a const pointer to the analysis model object associated with the ConstraintHandler.

const Integrator *	getIntegratorPtr (void) const
	Return a pointer to the Integrator object associated with the ConstraintHandler.

Domain *	getDomainPtr (void)
	Return a pointer to the Domain object associated with the ConstraintHandler.

AnalysisModel *	getAnalysisModelPtr (void)
	Returns a pointer to the AnalysisModel object associated with the ConstraintHandler.

Integrator *	getIntegratorPtr (void)
	Returns a pointer to the Integrator object associated with the ConstraintHandler.

int	sendData (Communicator &)
	Send object members through the communicator argument.

int	recvData (const Communicator &)
	Receive object members through the communicator argument.

	ConstraintHandler (ModelWrapper *, int classTag)
	Constructor. More...

virtual ConstraintHandler *	getCopy (void) const =0

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

Friends
class	ModelWrapper

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

ConstraintHandlers enforce the single and multi freedom constraints that exist in the domain by creating the appropriate FE_Element and DOF_Group objects.

A constraint handler is responsible for:

creating the FE_Element and DOF_Group objects and adding them to the AnalysisModel;
setting the initial DOF equation numbers to -1, -2 or -3. A -1 indicates to the DOF_Numberer object that no equation number is to be allocated for this DOF, a -3 that this DOF is to be among the last group of dof to be numbered.
deleting the DOF_Group and FE_Element objects that it created.

Constructor & Destructor Documentation

◆ ConstraintHandler()

XC::ConstraintHandler::ConstraintHandler	(	ModelWrapper *	owr,
		int	classTag
	)

protected

Constructor.

Parameters

owr	pointer to the model wrapper that owns the handler.
classTag	identifier of the class.

Member Function Documentation

◆ clearAll()

void XC::ConstraintHandler::clearAll ( void )

virtual

Reset the DOF_Group pointers to nullptr for all the nodes.

Invoked to inform the ConstraintHandler object that the FE_Elements and DOF_Groups it constructed are no longer part of the AnalysisModel. The ConstraintHandler can delete these objects if necessary; or the ConstraintHandler can store them and use them in subsequent calls to handle().

Reimplemented in XC::TransformationConstraintHandler.

◆ handle()

virtual int XC::ConstraintHandler::handle ( const ID * nodesNumberedLast = 0 )

pure virtual

Invoked to handle the constraints imposed on the domain by the constraints.

Invoked to handle the constraints imposed on the domain by the constraints. The ConstraintHandler object does this by instantiating the appropriate FE_ELement and DOF_Group objects and adding them to the AnalysisModel. For all the dofs in each DOF_Group the ConstraintHandler sets initial equation numbers as either \(-1\), \(-2\) or \(-3\): A \(-1\) indicates to the DOF_Numberer object that no equation number is to be allocated for this dof, a \(-2\) that an equation number is to be given for the dof, and a \(-3\) that an equation number is to be allocated and that this dof is to be among the last group of dof to be numbered,i.e. all dof initially assigned a \(-3\) are to be given a higher equation number than those given a \(-2\). Those dof with a \(-3\) should include all those dof associated with the nodes whose tags are in {nodesToBeNumberedLast}. Returns a positive number if successfully, a negative integer if not; the positive number is to be set at the number of dof assigned a value \(-3\) (this will be the number of external dof for a subdomain), the negative value of which depends on the type of ConstraintHandler. For subdomains the constraint handler is responsible for setting the FE_Element by calling {setFE_elementPtr}.

Implemented in XC::TransformationConstraintHandler, XC::LagrangeConstraintHandler, XC::PenaltyConstraintHandler, and XC::PlainHandler.

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

src/solution/analysis/handler/ConstraintHandler.h
src/solution/analysis/handler/ConstraintHandler.cpp

Public Member Functions

Protected Member Functions