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

LoadPath is an algorithmic class for performing a static analysis using a user defined load path (a user specified lambda path). More...

#include <LoadPath.h>

Inheritance diagram for XC::LoadPath:
XC::StaticIntegrator XC::IncrementalIntegrator XC::Integrator XC::MovableObject XC::DistributedBase

Public Member Functions

int newStep (void)
 The object obtains the current value of \(\lambda\) from the path vector using the current index. More...
 
int update (const Vector &deltaU)
 Invoked this causes the object to first increment the DOF_Group displacements with \(\Delta U\), by invoking {incrDisp( \(\Delta U)\)}! on the AnalysisModel, and then to update the domain, by invoking {updateDomain()} on the AnalysisModel. More...
 
int sendSelf (CommParameters &)
 Places the size if path and the index in an ID of size 5 and send this ID. More...
 
int recvSelf (const CommParameters &)
 Receives in a ID of size 2 the size of the vector and current index. More...
 
- 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 commit (void)
 Invoked by the SolutionAlgorithm to inform the Integrator that current state of domain is on solution path. 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::Integrator
virtual int domainChanged (void)
 Make required changes when a change in the domain occurs. More...
 
virtual void Print (std::ostream &s, int flag=0)
 The Integrator is to send information to the stream based on the integer flag. 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.
 
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 (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 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.
 

Protected Member Functions

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. More...
 
 LoadPath (AnalysisAggregation *)
 Constructor. More...
 
 LoadPath (AnalysisAggregation *, const Vector &theLoadPath)
 Constructor. More...
 
IntegratorgetCopy (void) const
 Virtual constructor.
 
- Protected Member Functions inherited from XC::StaticIntegrator
 StaticIntegrator (AnalysisAggregation *, 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 (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
AnalysisAggregationgetAnalysisAggregation (void)
 Returns a pointer to the solution method that owns this object.
 
const AnalysisAggregationgetAnalysisAggregation (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 AnalysisModelgetAnalysisModelPtr (void)
 Returns a pointer to the analysis model. More...
 
virtual const AnalysisModelgetAnalysisModelPtr (void) const
 Returns a pointer to the analysis model. More...
 
 Integrator (AnalysisAggregation *, int classTag)
 Constructor. More...
 

Friends

class AnalysisAggregation
 

Additional Inherited Members

- Protected Attributes inherited from XC::IncrementalIntegrator
int statusFlag
 

Detailed Description

LoadPath is an algorithmic class for performing a static analysis using a user defined load path (a user specified lambda path).

LoadPath is a subclass of StaticIntegrator, it is used to when performing a static analysis on the FE_Model using a user specified load path. The load path is specified in a Vector, {path}, to the objects constructor and at each step in the analysis: [ ^{(i)} - {n-1} = path(n) - path(n-1) ]

Knowing \(\lambda_n^{(i)} = path(n)\) prior to each iteration, the \(N+1\) unknowns in equation~staticFormTaylor}, is reduced to \(N\) unknowns and results in the following equation:

{equation} (U_{n}) = ^{(i)} P

Constructor & Destructor Documentation

§ LoadPath() [1/2]

XC::LoadPath::LoadPath ( AnalysisAggregation owr)
protected

Constructor.

The integer INTEGRATOR_TAGS_LoadPath (defined in \(<\)classTags.h \(>\)) is passed to the StaticIntegrator classes constructor. No vector object is created. Provided for the FEM_ObjectBroker to create a blank object, recvSelf() should be invoked on this object.

§ LoadPath() [2/2]

XC::LoadPath::LoadPath ( AnalysisAggregation owr,
const Vector theLoadPath 
)
protected

Constructor.

The integer INTEGRATOR_TAGS_LoadPath (defined in \(<\)classTags.h \(>\)) is passed to the StaticIntegrator classes constructor. A vector object path is created which is a copy of loadPath and an index into this vector is set to \(0\).

Member Function Documentation

§ newStep()

int XC::LoadPath::newStep ( void  )
virtual

The object obtains the current value of \(\lambda\) from the path vector using the current index.

The index is then incremented by \(1\). If the index is greater than the size of path, \(\lambda\) is set to \(0\) and an error message is printed. It will then invoke {applyLoadDomain(0.0, \(\lambda\))} on the AnalysisModel object. Returns \(0\) if successful. A warning message is printed and a \(-1\) is returned if no AnalysisModel is associated with the object.

Implements XC::StaticIntegrator.

§ recvData()

int XC::LoadPath::recvData ( const CommParameters cp)
protected

Receives object members through the channel being passed as parameter.

§ recvSelf()

int XC::LoadPath::recvSelf ( const CommParameters cp)
virtual

Receives in a ID of size 2 the size of the vector and current index.

Creates a new Vector and receives the Vector from the Channel. Returns \(0\) if successful, a warning message is printed and a \(-1\) is returned if theChannel fails to receive the Vector or the ID.

Implements XC::MovableObject.

§ sendSelf()

int XC::LoadPath::sendSelf ( CommParameters cp)
virtual

Places the size if path and the index in an ID of size 5 and send this ID.

Then sends the Vector path. Returns \(0\) if successful, a warning message is printed and a \(-1\) is returned if theChannel fails to send the ID or the Vector.

Implements XC::MovableObject.

§ update()

int XC::LoadPath::update ( const Vector deltaU)
virtual

Invoked this causes the object to first increment the DOF_Group displacements with \(\Delta U\), by invoking {incrDisp( \(\Delta U)\)}! on the AnalysisModel, and then to update the domain, by invoking {updateDomain()} on the AnalysisModel.

Returns \(0\) if successful, a warning message and a \(-1\) is returned if no AnalysisModel is associated with the object.

Implements XC::IncrementalIntegrator.


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