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

LineSearch is an abstract base class, i.e. More...

#include <LineSearch.h>

Inheritance diagram for XC::LineSearch:
XC::MovableObject XC::DistributedBase XC::BisectionLineSearch XC::InitialInterpolatedLineSearch XC::RegulaFalsiLineSearch XC::SecantLineSearch

Public Member Functions

virtual int newStep (LinearSOE &theSOE)
 
virtual int search (double s0, double s1, LinearSOE &theSOE, IncrementalIntegrator &theIntegrator)=0
 
int sendSelf (CommParameters &)
 Send the object. More...
 
int recvSelf (const CommParameters &)
 Receive the object. More...
 
void Print (std::ostream &s, int flag=0)
 
- 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

 LineSearch (int classTag, const double &tol=0.8, const int &mi=10, const double &mneta=0.1, const double &mxeta=10, const int &flag=1)
 
virtual LineSearchgetCopy (void) const =0
 
int updateAndUnbalance (IncrementalIntegrator &)
 

Protected Attributes

Vector x
 
double tolerance
 
int maxIter
 
double minEta
 
double maxEta
 
int printFlag
 

Friends

class NewtonLineSearch
 

Detailed Description

LineSearch is an abstract base class, i.e.

no objects of it's type can be created. Its subclasses seek to find a better solution to R(U)=0 than the solution Ui-1 + delta Ui would give, typically Ui = Ui-1 + factor * delta Ui.

Member Function Documentation

§ recvSelf()

int XC::LineSearch::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.

§ sendSelf()

int XC::LineSearch::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.


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