XC Open source finite element analysis program
CTestRelativeEnergyIncr.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.2 $
48 // $Date: 2005/12/15 00:19:28 $
49 // $Source: /usr/local/cvs/OpenSees/SRC/analysis/convergenceTest/CTestRelativeEnergyIncr.h,v $
50 
51 // Written: fmk
52 // Date: 02/02
53 // Modified: 05/05 ahs
54 //
55 // Purpose: This file contains the class definition for CTestRelativeEnergyIncr.
56 // A CTestRelativeNormEnergyIncr object tests for convergence using the ratio of the
57 // current norm to the initial norm (the norm when start is invoked) of the
58 // which is 0.5 times the absolute value of the product of the rhs and
59 // the solution vector of the LinearSOE.
60 
61 #ifndef CTestRelativeEnergyIncr_h
62 #define CTestRelativeEnergyIncr_h
63 
64 #include <solution/analysis/convergenceTest/ConvergenceTestNorm.h>
65 
66 namespace XC {
67 
69 //
75  {
76  public:
77  // constructors
78  CTestRelativeEnergyIncr(EntCmd *owr);
79  CTestRelativeEnergyIncr(EntCmd *owr,double tol, int maxNumIter, int printFlag, int normType=2);
80 
81  ConvergenceTest *getCopy(void) const;
82 
83  virtual std::string getStatusMsg(const int &flag= 1) const;
84  int test(void);
85  };
86 } // end of XC namespace
87 
88 #endif
int maxNumIter
max number of iterations
Definition: ConvergenceTest.h:81
virtual std::string getStatusMsg(const int &flag=1) const
Returns a message showing the values of the principal parameters.
Definition: CTestRelativeEnergyIncr.cpp:74
Tests for convergence using the ratio of the current norm to the initial norm (the norm when start is...
Definition: CTestRelativeEnergyIncr.h:74
convergence test.
Definition: ConvergenceTest.h:75
CTestRelativeEnergyIncr(EntCmd *owr)
Constructor.
Definition: CTestRelativeEnergyIncr.cpp:60
int test(void)
Comprueba si se ha producido la convergencia.
Definition: CTestRelativeEnergyIncr.cpp:87
int printFlag
a flag indicating if to print on test
Definition: ConvergenceTest.h:82
================================================================================
Definition: ContinuaReprComponent.h:34
Convergence test that uses vector norm value (solution vector,...).
Definition: ConvergenceTestNorm.h:40
double tol
the tol on the energy used to test for convergence
Definition: ConvergenceTestTol.h:46