Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

CTestNormDispIncr.h

Go to the documentation of this file.
00001 /* ****************************************************************** **
00002 **    OpenSees - Open System for Earthquake Engineering Simulation    **
00003 **          Pacific Earthquake Engineering Research Center            **
00004 **                                                                    **
00005 **                                                                    **
00006 ** (C) Copyright 1999, The Regents of the University of California    **
00007 ** All Rights Reserved.                                               **
00008 **                                                                    **
00009 ** Commercial use of this program without express permission of the   **
00010 ** University of California, Berkeley, is strictly prohibited.  See   **
00011 ** file 'COPYRIGHT'  in main directory for information on usage and   **
00012 ** redistribution,  and for a DISCLAIMER OF ALL WARRANTIES.           **
00013 **                                                                    **
00014 ** Developed by:                                                      **
00015 **   Frank McKenna (fmckenna@ce.berkeley.edu)                         **
00016 **   Gregory L. Fenves (fenves@ce.berkeley.edu)                       **
00017 **   Filip C. Filippou (filippou@ce.berkeley.edu)                     **
00018 **                                                                    **
00019 ** ****************************************************************** */
00020                                                                         
00021 // $Revision: 1.3 $
00022 // $Date: 2001/06/14 05:26:47 $
00023 // $Source: /usr/local/cvs/OpenSees/SRC/convergenceTest/CTestNormDispIncr.h,v $
00024                                                                         
00025                                                                         
00026 #ifndef CTestNormDispIncr_h
00027 #define CTestNormDispIncr_h
00028 
00029 // File: ~/convergenceTest/CTestNormDispIncr.h
00030 //
00031 // Written: fmk 
00032 // Date: 09/98
00033 // Revised:
00034 //
00035 // Purpose: This file contains the class definition for CTestNormDispIncr.
00036 // A CTestNormDispIncr object tests for convergence using the norm of the 
00037 // solution vector of the LinearSOE object passed in the constructor
00038 // and a tolerance, set in the constructor
00039 
00040 #include <ConvergenceTest.h>
00041 #include <bool.h>
00042 #include <EquiSolnAlgo.h>
00043 #include <LinearSOE.h>
00044 
00045 
00056 class CTestNormDispIncr: public ConvergenceTest
00057 {
00058   public:
00060     CTestNormDispIncr();      
00069     CTestNormDispIncr(double tol, int maxNumIter, int printFlag); 
00070 
00078     ~CTestNormDispIncr();
00079 
00080 
00082     ConvergenceTest *getCopy( int iterations ) ;
00083 
00084 
00086     void setTolerance(double newTol);
00088     int setEquiSolnAlgo(EquiSolnAlgo &theAlgo);
00089     
00091     int test(void);
00093     int start(void);
00094 
00096     int getNumTests(void);
00098     int getMaxNumTests(void);        
00100     double getRatioNumToMax(void);                
00102     const Vector &getNorms(void);    
00103     
00105     int sendSelf(int commitTag, Channel &theChannel);  
00107     int recvSelf(int commitTag, Channel &theChannel, 
00108    FEM_ObjectBroker &theBroker);    
00109 
00110   protected:
00111 
00112   private:
00114     LinearSOE *theSOE;
00116     double tol;         
00117 
00118     int maxNumIter;     
00119     int currentIter;    
00120     int printFlag;      
00121     
00122     Vector norms;       // vector to hold the norms
00123 };
00124 
00125 #endif
Copyright Contact Us