class ConvergenceTest : public MovableObject


Inheritance:


Public Methods

ConvergenceTest(int classTag)
virtual ~ConvergenceTest()
virtual int setEquiSolnAlgo(EquiSolnAlgo &theAlgorithm)
virtual int start(void)
virtual int test(void)

Inherited from MovableObject:

Public Methods

int getClassTag(void) const
int getDbTag(void) const
void setDbTag(int dbTag)
virtual int sendSelf(int commitTag, Channel &theChannel)
virtual int recvSelf(int commitTag, Channel &theChannel, FEM_ObjectBroker &theBroker)

Documentation

A ConvergenceTest object is an object which can be used in an algorithmic class to test if convergence has been achieved for an iteration. The ConvergenceTest class is an abstract class, defining the interface that all subclasses must provide.

ConvergenceTest(int classTag)

The integer classTag is passed to the MovableObject constructor

virtual ~ConvergenceTest()

Does nothing

virtual int setEquiSolnAlgo(EquiSolnAlgo &theAlgorithm)

To set the corresponding EquiSolnAlgo class

virtual int start(void)

This is invoked at the start of each iteration. To return 0 if sucessfull, i.e that testing can proceed, a negative number if not.

virtual int test(void)


Direct child classes:
CTestNormUnbalance
CTestNormDispIncr
CTestEnergyIncr

alphabetic index Contents

this page has been generated automatically by a slightly modified version of doc++ for OpenSees

Copyright Contact Us