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:
Inheritance graph
[legend]
Collaboration diagram for XC::LoadPath:
Collaboration graph
[legend]

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 (Communicator &)
 Send object through the communicator argument.
 
int recvSelf (const Communicator &)
 Receives object members through the communicator argument.
 
- 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 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...
 
virtual double getCFactor (void)
 Function related to modal damping (not implemented yet).
 
- Public Member Functions inherited from XC::Integrator
virtual int domainChanged (void)
 Make required changes when a change in the domain occurs. More...
 
double getCurrentModelTime (void) const
 
void setCurrentModelTime (const double &t)
 
virtual void Print (std::ostream &s, int flag=0) const
 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 (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

int sendData (Communicator &)
 Send object members through the communicator argument.
 
int recvData (const Communicator &)
 Receives object members through the communicator argument.
 
 LoadPath (SolutionStrategy *)
 Constructor. More...
 
 LoadPath (SolutionStrategy *, const Vector &theLoadPath)
 Constructor. More...
 
IntegratorgetCopy (void) const
 Virtual constructor.
 
- 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
 

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)
 
- Protected Attributes inherited from XC::IncrementalIntegrator
double iFactor
 
double cFactor
 
int statusFlag
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

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 ( SolutionStrategy 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 ( SolutionStrategy 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.

◆ 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: