CTestEnergyIncr

class CTestEnergyIncr : public ConvergenceTest

Inheritance:

Public Methods
CTestEnergyIncr()
CTestEnergyIncr(double tol, int maxNumIter, int printFlag)
~CTestEnergyIncr()
void setTolerance(double newTol)
int setEquiSolnAlgo(EquiSolnAlgo &theAlgo)
int test(void)
int start(void)
int sendSelf(int commitTag, Channel &theChannel)
int recvSelf(int commitTag, Channel &theChannel, FEM_ObjectBroker &theBroker)

Inherited from ConvergenceTest:

Inherited from MovableObject:

Public Methods
int getClassTag(void) const
int getDbTag(void) const
void setDbTag(int dbTag)

Documentation

A CTestEnergyIncr object is an object which can be used in an algorithmic class to test if convergence has been achieved. The CTestEnergyIncr class tests using the energy increment, 0.5 times the absolute value of the dot product of the LinearSOE objects solution and rhs Vectors, and a user specified tolerance value.

CTestEnergyIncr()

The integer CLASS_TAGS_CTestEnergyIncr, defined in <classTags.h>, is passed to the ConvergenceTest constructor. Sets the tolerance used in test() to be tol and the max number of iterations to be performed to maxNumIter.

CTestEnergyIncr(double tol, int maxNumIter, int printFlag)

To be used by the FEM_ObjectBroker object in parallel programs. The integer CLASS_TAGS_CTestEnergyIncr, defined in <classTags.h>, is passed to the ConvergenceTest constructor. Sets the tolerance used in test() to be 0.0 and maxNumIter to be 0. These will be set when recvSelf() is invoked on the object.

~CTestEnergyIncr()

void setTolerance(double newTol)

int setEquiSolnAlgo(EquiSolnAlgo &theAlgo)

int test(void)

int start(void)

int sendSelf(int commitTag, Channel &theChannel)

int recvSelf(int commitTag, Channel &theChannel, FEM_ObjectBroker &theBroker)

This class has no child classes.

alphabetic index Contents