Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_NLS_NOX_NearConvergenceTest.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // Copyright Notice
3 //
4 // Copyright 2002 Sandia Corporation. Under the terms
5 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
6 // Government retains certain rights in this software.
7 //
8 // Xyce(TM) Parallel Electrical Simulator
9 // Copyright (C) 2002-2014 Sandia Corporation
10 //
11 // This program is free software: you can redistribute it and/or modify
12 // it under the terms of the GNU General Public License as published by
13 // the Free Software Foundation, either version 3 of the License, or
14 // (at your option) any later version.
15 //
16 // This program is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU General Public License
22 // along with this program. If not, see <http://www.gnu.org/licenses/>.
23 //-----------------------------------------------------------------------------
24 
25 //-------------------------------------------------------------------------
26 // Filename : $RCSfile: N_NLS_NOX_NearConvergenceTest.h,v $
27 //
28 // Purpose : Particular Status Test Based on the Weighed Norm of the
29 // Update
30 //
31 // Special Notes :
32 //
33 // Creator : Tammy Kolda, NLS, 8950
34 //
35 // Creation Date : 01/31/02
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.8 $
41 //
42 // Revision Date : $Date: 2014/02/24 23:49:24 $
43 //
44 // Current Owner : $Author: tvrusso $
45 //-------------------------------------------------------------------------
46 
47 #ifndef Xyce_N_NLS_NOX_NearConvergenceTest_h
48 #define Xyce_N_NLS_NOX_NearConvergenceTest_h
49 
50 // ---------- Standard Includes ----------
51 
52 // ---------- Xyce Includes ----------
53 
54 // ---------- NOX Includes ----------
55 
56 #include "NOX_StatusTest_Generic.H" // base class
57 
58 // ---------- Forward Declarations ----------
59 
60 class N_LAS_Vector;
61 class N_LAS_System;
62 
63 // ---------- Namespace Declarations ----------
64 
65 // N_NLS namespace is for the Xyce Nonlinear Solver Package
66 namespace N_NLS_NOX {
67 
68 //-----------------------------------------------------------------------------
69 // Class : N_NLS_NOX::WeightedUpdateTest
70 //
71 // Purpose :
72 //
73 // NOX Vector Interface for Xyce vectors.
74 //
75 // Creator : Roger Pawlowski, SNL 9233
76 //
77 // Creation Date : 4/2/2003
78 //-----------------------------------------------------------------------------
79 
80 class NearConvergenceTest : public NOX::StatusTest::Generic {
81 
82 public:
83 
84  //---------------------------------------------------------------------------
85  // Function : NearConvergenceTest (constructor)
86  //
87  // Purpose : Constructs a NOX-compatiable status test based
88  // the weighted norm of the update.
89  //
90  //---------------------------------------------------------------------------
91  NearConvergenceTest(int maxIters, double convRate,
92  double relativeConvRate = 1.0);
93 
94  //---------------------------------------------------------------------------
95  // Function : Destructor
96  //---------------------------------------------------------------------------
98 
99  //---------------------------------------------------------------------------
100  // Purpose : Test stopping criterion given the current
101  // nonlinear problem
102  //---------------------------------------------------------------------------
103  NOX::StatusTest::StatusType checkStatus(const NOX::Solver::Generic& problem);
104 
105  //---------------------------------------------------------------------------
106  // Purpose : Test stopping criterion given the current
107  // nonlinear problem
108  //---------------------------------------------------------------------------
109  NOX::StatusTest::StatusType getStatus() const { return status_; };
110 
111  //---------------------------------------------------------------------------
112  // Purpose : Output formatted description of stopping test to
113  // output stream.
114  //---------------------------------------------------------------------------
115  std::ostream& print(std::ostream& stream, int indent = 0) const;
116 
117 private:
118 
119  // Maximum number of nonlinear iterations allowed
121  int nIters_;
122 
123  // ||F(x_current)|| / ||F(x_previous)||
126 
127  // ||F(x)|| / ||F(x_init)||
130 
131  // Initial norm of the RHS used to calculate ratio
133 
134  NOX::StatusTest::StatusType status_;
135 
136 }; // class NearConvergenceTest
137 } // namespace N_NLS_NOX
138 
139 #endif // Xyce_N_NLS_NOX_NearConvergenceTest
140