DisplacementControl is an algorithmic class for performing a static analysis using the displacement control method. More...

#include <DisplacementControl.h>

Inheritance diagram for XC::DisplacementControl:

Public Member Functions
	~DisplacementControl (void)
	Destructor.

int	newStep (void)
	Performs a new analysis step.

int	commit (void)
	Commits model state.

int	update (const Vector &deltaU)
	When invoked causes the integrator object to update the DOF_Group responses with the appropriate values based on the computed solution to the system of equations object. More...

int	domainChanged (void)
	Make required changes when a change in the domain occurs. More...

void	setNodeTag (const int &tag)

int	getNodeTag (void) const

void	setDof (const int &dof)

int	getDof (void) const

void	setIncrement (const double &)

double	getIncrement (void) const

int	sendSelf (CommParameters &)
	Send the object. More...

int	recvSelf (const CommParameters &)
	Receive the object. More...

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

Public Member Functions inherited from XC::BaseControl
double	factor (void) const

Public Member Functions inherited from XC::StaticIntegrator
virtual int	formEleTangent (FE_Element *theEle)
	Asks the element being passed as parameter to build its tangent stiffness matrix. More...

virtual int	formEleResidual (FE_Element *theEle)
	To form the residual vector of the FE_Element. More...

virtual int	formNodTangent (DOF_Group *theDof)
	This should never be called in a static analysis. More...

virtual int	formNodUnbalance (DOF_Group *theDof)
	Form the unbalance vector for the DOF_Group. More...

Public Member Functions inherited from XC::IncrementalIntegrator
virtual int	formTangent (int statusFlag=CURRENT_TANGENT)
	Builds tangent stiffness matrix. More...

virtual int	formUnbalance (void)
	Builds the unbalanced load vector (right hand side of the equation). More...

virtual int	newStep (double deltaT)
	Invoked to inform the integrator that the transient analysis is proceeding to the next time step. More...

virtual int	revertToLastStep (void)

virtual int	initialize (void)

virtual int	revertToStart ()

virtual int	getLastResponse (Vector &result, const ID &id)
	Returns the response on the DOFs being passed as parameter. 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 (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	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
const Domain *	getDomainPtr (void) const
	Returns a pointer to the domain.

Domain *	getDomainPtr (void)
	Returns a pointer to the domain.

	DisplacementControl (AnalysisAggregation *)
	Constructor. More...

	DisplacementControl (AnalysisAggregation *, int nodeTag, int dof, double increment, int numIncrStep, double minIncrement, double maxIncrement)
	Constructor. More...

Integrator *	getCopy (void) const
	Virtual constructor.

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

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

	DispBase (AnalysisAggregation *, int classTag, const int &numIncr=1)
	Constructor. More...

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

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

void	setup_numIncr (const int &)

	BaseControl (AnalysisAggregation *, int classTag, int numIncr=1)
	Constructor. More...

Protected Member Functions inherited from XC::StaticIntegrator
	StaticIntegrator (AnalysisAggregation *, int classTag)
	Constructor. More...

Protected Member Functions inherited from XC::IncrementalIntegrator
LinearSOE *	getLinearSOEPtr (void)
	Returns a pointer to the linear system of equations. More...

const LinearSOE *	getLinearSOEPtr (void) const
	Returns a pointer to the linear system of equations. More...

virtual int	formNodalUnbalance (void)
	Builds the nodal unbalanced load vector. More...

	IncrementalIntegrator (AnalysisAggregation *, int classTag)
	Constructor. More...

virtual int	formElementResidual (void)
	Builds the unbalanced load vector of the elements. More...

Protected Member Functions inherited from XC::Integrator
AnalysisAggregation *	getAnalysisAggregation (void)
	Returns a pointer to the solution method that owns this object.

const AnalysisAggregation *	getAnalysisAggregation (void) const
	Returns a const pointer to the solution method that owns this object.

void	applyLoadModel (double newTime)

int	updateModel (void)

int	updateModel (double newTime, double dT)

int	commitModel (void)

double	getCurrentModelTime (void)

void	setCurrentModelTime (const double &t)

void	setRayleighDampingFactors (const RayleighDampingFactors &rF)

int	sendData (CommParameters &)
	Send object members through the channel being passed as parameter.

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

virtual AnalysisModel *	getAnalysisModelPtr (void)
	Returns a pointer to the analysis model. More...

virtual const AnalysisModel *	getAnalysisModelPtr (void) const
	Returns a pointer to the analysis model. More...

	Integrator (AnalysisAggregation *, int classTag)
	Constructor. More...

Protected Attributes
int	theNodeTag
	the node that is being followed

int	theDof
	the dof at the node being followed

int	theDofID
	the system level id of the dof being followed

double	theIncrement
	deltaU at step (i)

double	minIncrement

double	maxIncrement
	min/max values of deltaU at (i)

Protected Attributes inherited from XC::DispBase
IntegratorVectors	vectors

Protected Attributes inherited from XC::BaseControl
double	specNumIncrStep
	Jd factor relating load increment at subsequent time steps. (optional, default: 1.0)

double	numIncrLastStep
	J(i-1).

Protected Attributes inherited from XC::IncrementalIntegrator
int	statusFlag

Friends
class	AnalysisAggregation

Detailed Description

DisplacementControl is an algorithmic class for performing a static analysis using the displacement control method.

DisplacementControl is a subclass of StaticIntegrator, it is used to when performing a static analysis on the FE_Model using the displacement control method. In the displacement control method the displacement at a specified degree-of-freedom Uc is specified for each iteration. The following constraint equation is added to equation~staticFormTaylor} of the StaticIntegrator class:

[ Uc_n^{(i)} - Uc_{n-1} = Uc_n ]

where \(\delta Uc_n\) depends on \(\delta Uc_{n-1}\), the displacement increment at the previous time step, \(J_{n-1}\), the number of iterations required to achieve convergence in the previos load step, and \(Jd\), the desired number of iteraions. \(\delta //! Uc_n\) is bounded by \(\delta Uc_{min}\) and \(\delta Uc_{max}\).

\[ 
\delta Ucn = max \left( \delta Uc{min}, min \left(
\frac{Jd}{J_{n-1}} \delta Uc{n-1}, \delta Uc{max} \right) \right)
\]

Constructor & Destructor Documentation

§ DisplacementControl() [1/2]

XC::DisplacementControl::DisplacementControl ( AnalysisAggregation * owr )

protected

Constructor.

Parameters

owr	set of objects used to perform the analysis.

§ DisplacementControl() [2/2]

XC::DisplacementControl::DisplacementControl	(	AnalysisAggregation *	owr,
		int	nodeTag,
		int	dof,
		double	increment,
		int	numIncr,
		double	min,
		double	max
	)

protected

Constructor.

Parameters

owr	set of objects used to perform the analysis.
nodeTag	the tag of the node to follow.
dof	the id of the DOF (of the previous node) to follow.
increment	deltaU at i-th step.
numIncr	number of increments.
min	minimum value of deltaU at i-th step.
max	maximum value of deltaU at i-th step.

Member Function Documentation

§ domainChanged()

int XC::DisplacementControl::domainChanged ( void )

virtual

Make required changes when a change in the domain occurs.

Is called by the Analysis object. Refer to the Analysis classes to see when it is invoked. To return \(0\) if successful, a negative number if not. This base class returns \(0\).

Reimplemented from XC::Integrator.

Reimplemented in XC::DistributedDisplacementControl.

§ recvSelf()

int XC::DisplacementControl::recvSelf ( const CommParameters & cp )

virtual

Receive the object.

Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through cp. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using #theBroker. To return 0 if successful or a -1 if not.

Implements XC::MovableObject.

Reimplemented in XC::DistributedDisplacementControl.

§ sendSelf()

int XC::DisplacementControl::sendSelf ( CommParameters & cp )

virtual

Send the object.

Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by cp object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a receiveSelf() to receive the data. Returns 0 if successful (successful in that the data got to the channel), or a - if no data was sent.

Implements XC::MovableObject.

Reimplemented in XC::DistributedDisplacementControl.

§ update()

int XC::DisplacementControl::update ( const Vector & deltaU )

virtual

When invoked causes the integrator object to update the DOF_Group responses with the appropriate values based on the computed solution to the system of equations object.

Implements XC::IncrementalIntegrator.

Reimplemented in XC::DistributedDisplacementControl.

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

src/solution/analysis/integrator/static/DisplacementControl.h
src/solution/analysis/integrator/static/DisplacementControl.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

§ DisplacementControl() [1/2]

§ DisplacementControl() [2/2]

Member Function Documentation

§ domainChanged()

§ recvSelf()

§ sendSelf()

§ update()