class CTestNormDispIncr : public ConvergenceTest
Inheritance:
Public Methods-
 CTestNormDispIncr()
- CTestNormDispIncr(double tol, int maxNumIter, int printFlag)
- ~CTestNormDispIncr()
- 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)
Public Methods int getClassTag(void) const
- int getDbTag(void) const
- void setDbTag(int dbTag)
Documentation
A CTestNormDispIncr object is an object which can be used in an
algorithmic class to test if convergence has been achieved. The
CTestNormDispIncr class tests using the norm of the solution Vector of
a LinearSOE object and a user specified tolerance value.
- CTestNormDispIncr()
The integer CLASS_TAGS_CTestNormDispIncr, defined in
<classTags.h>, is passed to the ConvergenceTest constructor. Sets
the tolerance used in test() to be tol, the max number
of iterations to be performed to maxNumIter and the print
flag used to determine what, if anything, is printed on each test to
printFlag.
- CTestNormDispIncr(double tol, int maxNumIter, int printFlag)
To be used by the FEM_ObjectBroker object in parallel programs. The
integer CLASS_TAGS_CTestNormDispIncr, 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.
- ~CTestNormDispIncr()
Does nothing
- void setTolerance(double newTol)
Sets the tolerance used in test() to be newTol
- int setEquiSolnAlgo(EquiSolnAlgo &theAlgo)
It sets a pointer to theAlgo's LinearSOE object. Returns 0 if
successful, a -1 is returned and an error message printed if no
LinearSOE object has been set in theAlgo.
- int test(void)
Returns {currentNumIter} if if the two norm of the LinearSOE objects X
Vector is less than the tolerance tol. If no LinearSOE has been
set -2 is returned. If the currentNumIter >=
maxNumIter an error message is printed and -2 is returned. If none
of these conditions is met, the currentnumIter is incremented
and -1 is returned. If the print flag is 0 nothing is printed to
cerr during the method, if 1 the current iteration and norm are
printed to cerr, and if 2 the norm and number of iterations to convergence
are printed to cerr.
- 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
this page has been generated automatically by a slightly modified version of doc++ for OpenSees
|
