Quick Links Home Download Documentation Message Board Source Code Class Interface Bugs Tasks Search

ConvergenceTest Class Reference #include <ConvergenceTest.h> Inheritance diagram for ConvergenceTest:: List of all members. Public Methods   ConvergenceTest (int classTag)   constructors and destructor. More... virtual  ~ConvergenceTest () virtual ConvergenceTest*  getCopy (int iterations)=0 virtual int  setEquiSolnAlgo (EquiSolnAlgo &theAlgorithm)=0 virtual int  start (void)=0 virtual int  test (void)=0 virtual int  getNumTests (void)=0 virtual int  getMaxNumTests (void)=0 virtual double  getRatioNumToMax (void)=0 virtual const Vector&  getNorms (void)=0 Detailed Description 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. \ Definition at line 55 of file ConvergenceTest.h. Constructor & Destructor Documentation ConvergenceTest::ConvergenceTest ( int classTag )   constructors and destructor. Definition at line 38 of file ConvergenceTest.cpp. ConvergenceTest::~ConvergenceTest ( ) [virtual]   The integer {classTag} is passed to the MovableObject constructor. Definition at line 44 of file ConvergenceTest.cpp. Member Function Documentation ConvergenceTest * ConvergenceTest::getCopy ( int interations ) [pure virtual]   Reimplemented in CTestEnergyIncr, CTestNormDispIncr, and CTestNormUnbalance. Referenced by BFGS::BFGS(), Broyden::Broyden(), Broyden::setTest(), and BFGS::setTest(). int ConvergenceTest::getMaxNumTests ( void ) [pure virtual]   Reimplemented in CTestEnergyIncr, CTestNormDispIncr, and CTestNormUnbalance. Referenced by KrylovNewton::solveCurrentStep(). const Vector & ConvergenceTest::getNorms ( void ) [pure virtual]   Reimplemented in CTestEnergyIncr, CTestNormDispIncr, and CTestNormUnbalance. int ConvergenceTest::getNumTests ( void ) [pure virtual]   Reimplemented in CTestEnergyIncr, CTestNormDispIncr, and CTestNormUnbalance. double ConvergenceTest::getRatioNumToMax ( void ) [pure virtual]   Reimplemented in CTestEnergyIncr, CTestNormDispIncr, and CTestNormUnbalance. Referenced by VariableTimeStepDirectIntegrationAnalysis::determineDt(). int ConvergenceTest::setEquiSolnAlgo ( EquiSolnAlgo & theAlgo ) [pure virtual]   Reimplemented in CTestEnergyIncr, CTestNormDispIncr, and CTestNormUnbalance. Referenced by NewtonRaphson::solveCurrentStep(), NewtonLineSearch::solveCurrentStep(), ModifiedNewton::solveCurrentStep(), KrylovNewton::solveCurrentStep(), Broyden::solveCurrentStep(), and BFGS::solveCurrentStep(). int ConvergenceTest::start ( void ) [pure virtual]   Reimplemented in CTestEnergyIncr, CTestNormDispIncr, and CTestNormUnbalance. Referenced by NewtonRaphson::solveCurrentStep(), NewtonLineSearch::solveCurrentStep(), ModifiedNewton::solveCurrentStep(), KrylovNewton::solveCurrentStep(), Broyden::solveCurrentStep(), and BFGS::solveCurrentStep(). int ConvergenceTest::test ( void ) [pure virtual]   Reimplemented in CTestEnergyIncr, CTestNormDispIncr, and CTestNormUnbalance. Referenced by NewtonRaphson::solveCurrentStep(), NewtonLineSearch::solveCurrentStep(), ModifiedNewton::solveCurrentStep(), KrylovNewton::solveCurrentStep(), Broyden::solveCurrentStep(), and BFGS::solveCurrentStep(). The documentation for this class was generated from the following files: ConvergenceTest.h ConvergenceTest.cpp

Copyright

Contact Us