XC Open source finite element analysis program
CTestFixedNumIter.h
1 //----------------------------------------------------------------------------
2 // XC program; finite element analysis code
3 // for structural analysis and design.
4 //
5 // Copyright (C) Luis Claudio Pérez Tato
6 //
7 // This program derives from OpenSees <http://opensees.berkeley.edu>
8 // developed by the «Pacific earthquake engineering research center».
9 //
10 // Except for the restrictions that may arise from the copyright
11 // of the original program (see copyright_opensees.txt)
12 // XC is free software: you can redistribute it and/or modify
13 // it under the terms of the GNU General Public License as published by
14 // the Free Software Foundation, either version 3 of the License, or
15 // (at your option) any later version.
16 //
17 // This software is distributed in the hope that it will be useful, but
18 // WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 // GNU General Public License for more details.
21 //
22 //
23 // You should have received a copy of the GNU General Public License
24 // along with this program.
25 // If not, see <http://www.gnu.org/licenses/>.
26 //----------------------------------------------------------------------------
27 /* ****************************************************************** **
28 ** OpenSees - Open System for Earthquake Engineering Simulation **
29 ** Pacific Earthquake Engineering Research Center **
30 ** **
31 ** **
32 ** (C) Copyright 1999, The Regents of the University of California **
33 ** All Rights Reserved. **
34 ** **
35 ** Commercial use of this program without express permission of the **
36 ** University of California, Berkeley, is strictly prohibited. See **
37 ** file 'COPYRIGHT' in main directory for information on usage and **
38 ** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
39 ** **
40 ** Developed by: **
41 ** Frank McKenna (fmckenna@ce.berkeley.edu) **
42 ** Gregory L. Fenves (fenves@ce.berkeley.edu) **
43 ** Filip C. Filippou (filippou@ce.berkeley.edu) **
44 ** **
45 ** ****************************************************************** */
46 
47 // $Revision: 1.1 $
48 // $Date: 2005/12/15 00:13:51 $
49 // $Source: /usr/local/cvs/OpenSees/SRC/analysis/convergenceTest/CTestFixedNumIter.h,v $
50 
51 // Written: Andreas Schellenberg (andreas.schellenberg@gmx.net)
52 // Created: 09/05
53 // Revision: A
54 
55 #ifndef CTestFixedNumIter_h
56 #define CTestFixedNumIter_h
57 
58 #include <solution/analysis/convergenceTest/ConvergenceTest.h>
59 
60 namespace XC {
61 
63 //
68  {
69  public:
70  // constructors
71  CTestFixedNumIter(EntCmd *owr);
72  CTestFixedNumIter(EntCmd *owr,int maxNumIter, int printFlag, int normType=2);
73 
74  ConvergenceTest *getCopy(void) const;
75 
76  virtual std::string getStatusMsg(const int &flag= 1) const;
77  std::string getEnergyProductMessage(void) const;
78  int test(void);
79  };
80 } // end of XC namespace
81 
82 #endif
ConvergenceTest * getCopy(void) const
Virtual constructor.
Definition: CTestFixedNumIter.cpp:75
int maxNumIter
max number of iterations
Definition: ConvergenceTest.h:81
convergence test.
Definition: ConvergenceTest.h:75
std::string getEnergyProductMessage(void) const
Display current energy product and tolerance.
Definition: CTestFixedNumIter.cpp:151
int test(void)
Check for convergence.
Definition: CTestFixedNumIter.cpp:93
This object performs a fixed number of iterations without testing for convergence. This test is useful for hybrid simulation where the residual error is corrected for.
Definition: CTestFixedNumIter.h:67
int printFlag
a flag indicating if to print on test
Definition: ConvergenceTest.h:82
virtual std::string getStatusMsg(const int &flag=1) const
Returns a message showing the values of the principal parameters.
Definition: CTestFixedNumIter.cpp:80
================================================================================
Definition: ContinuaReprComponent.h:34