xc
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members

Algorithmic class for performing a static analysis using the displacement control method. More...

#include <DisplacementControl.h>

Inheritance diagram for XC::DisplacementControl:
Inheritance graph
[legend]
Collaboration diagram for XC::DisplacementControl:
Collaboration graph
[legend]

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 &)
 Set displacement increment.
 
double getIncrement (void) const
 
void setMinIncrement (const double &)
 Set the min stepsize the user will allow.
 
double getMinIncrement (void) const
 
void setMaxIncrement (const double &)
 Set the max stepsize the user will allow.
 
double getMaxIncrement (void) const
 
int sendSelf (Communicator &)
 Send the object. More...
 
int recvSelf (const Communicator &)
 Receive the object. More...
 
void Print (std::ostream &s, int flag=0) const
 Print stuff.
 
- Public Member Functions inherited from XC::BaseControl
void setNumIncr (const int &d)
 
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 formTangent (int statusFlag, const double &iFactor, const double &cFactor)
 
virtual int formUnbalance (void)
 Builds the unbalanced load vector (right hand side of the equation). More...
 
int getTangFlag (void) const
 Get the value of the flag to compute the tangent stiffness: CURRENT_TANGENT: 0; INITIAL_TANGENT: 1; CURRENT_SECANT: 2; INITIAL_THEN_CURRENT_TANGENT: 3; NO_TANGENT: 4; SECOND_TANGENT: 5; HALL_TANGENT: 6.
 
void setTangFlag (const int &)
 Set the value of the flag to compute the tangent stiffness: CURRENT_TANGENT: 0; INITIAL_TANGENT: 1; CURRENT_SECANT: 2; INITIAL_THEN_CURRENT_TANGENT: 3; NO_TANGENT: 4; SECOND_TANGENT: 5; HALL_TANGENT: 6.
 
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...
 
virtual double getCFactor (void)
 Function related to modal damping (not implemented yet).
 
- Public Member Functions inherited from XC::Integrator
double getCurrentModelTime (void) const
 
void setCurrentModelTime (const double &t)
 
- 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.
 
MovableObjectoperator= (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 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 DbTagDatagetDbTagData (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.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (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.
 
EntityWithOwneroperator= (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.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Protected Member Functions

const DomaingetDomainPtr (void) const
 Returns a pointer to the domain.
 
DomaingetDomainPtr (void)
 Returns a pointer to the domain.
 
 DisplacementControl (SolutionStrategy *)
 Constructor. More...
 
 DisplacementControl (SolutionStrategy *, int nodeTag, int dof, double increment, int numIncrStep, double minIncrement, double maxIncrement)
 Constructor. More...
 
IntegratorgetCopy (void) const
 Virtual constructor.
 
- Protected Member Functions inherited from XC::DispBase
int sendData (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receives object members through the communicator argument.
 
 DispBase (SolutionStrategy *, int classTag, const int &numIncr=1)
 Constructor. More...
 
- Protected Member Functions inherited from XC::BaseControl
int sendData (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receives object members through the communicator argument.
 
void setup_numIncr (const int &)
 
 BaseControl (SolutionStrategy *, int classTag, int numIncr=1)
 Constructor. More...
 
- Protected Member Functions inherited from XC::StaticIntegrator
 StaticIntegrator (SolutionStrategy *, int classTag)
 Constructor. More...
 
- Protected Member Functions inherited from XC::IncrementalIntegrator
LinearSOEgetLinearSOEPtr (void)
 Returns a pointer to the linear system of equations. More...
 
const LinearSOEgetLinearSOEPtr (void) const
 Returns a pointer to the linear system of equations. More...
 
virtual int formNodalUnbalance (void)
 Builds the nodal unbalanced load vector. More...
 
 IncrementalIntegrator (SolutionStrategy *, int classTag)
 Constructor. More...
 
virtual int formElementResidual (void)
 Builds the unbalanced load vector of the elements. More...
 
- Protected Member Functions inherited from XC::Integrator
SolutionStrategygetSolutionStrategy (void)
 Returns a pointer to the solution method that owns this object.
 
const SolutionStrategygetSolutionStrategy (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)
 
void setRayleighDampingFactors (const RayleighDampingFactors &rF)
 
int sendData (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receives object members through the communicator argument.
 
virtual AnalysisModelgetAnalysisModelPtr (void)
 Returns a pointer to the analysis model. More...
 
virtual const AnalysisModelgetAnalysisModelPtr (void) const
 Returns a pointer to the analysis model. More...
 
 Integrator (SolutionStrategy *, int classTag)
 Constructor. More...
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) const
 

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
double iFactor
 
double cFactor
 
int statusFlag
 

Friends

class SolutionStrategy
 

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 CommandEntityentcmd_cast (boost::any &data)
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

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 previous 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 ( SolutionStrategy owr)
protected

Constructor.

Parameters
owrset of objects used to perform the analysis.

◆ DisplacementControl() [2/2]

XC::DisplacementControl::DisplacementControl ( SolutionStrategy owr,
int  nodeTag,
int  dof,
double  increment,
int  numIncr,
double  min,
double  max 
)
protected

Constructor.

Parameters
owrset of objects used to perform the analysis.
nodeTagthe tag of the node to follow.
dofthe id of the DOF (of the previous node) to follow.
incrementdeltaU at i-th step.
numIncrnumber of increments.
minminimum value of deltaU at i-th step.
maxmaximum 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 Communicator comm)
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 ( Communicator comm)
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: