Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_NLS_NOX_UpdateTooSmallTest.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_UpdateTooSmallTest.h,v $
27 //
28 // Purpose : Particular Status Test Based on the Weighed Norm of the
29 // Update
30 //
31 // Special Notes :
32 //
33 // Creator : Roger Pawlowski, SNL 9233
34 //
35 // Creation Date : 04/15/03
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.7 $
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_UpdateTooSmallTest_h
48 #define Xyce_N_NLS_NOX_UPDATETooSmallTest_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 namespace N_NLS_NOX {
63  class WeightedUpdateTest;
64 }
65 
66 // ---------- Namespace Declarations ----------
67 
68 // N_NLS namespace is for the Xyce Nonlinear Solver Package
69 namespace N_NLS_NOX {
70 
71 //-----------------------------------------------------------------------------
72 // Class : N_NLS_NOX::WeightedUpdateTest
73 //
74 // Purpose :
75 //
76 // NOX Vector Interface for Xyce vectors.
77 //
78 // Creator : Tammy Kolda, SNL, 8950
79 //
80 // Creation Date : 2/1/02
81 //-----------------------------------------------------------------------------
82 
83 class UpdateTooSmallTest : public NOX::StatusTest::Generic {
84 
85 public:
86 
87  //---------------------------------------------------------------------------
88  // Function : UpdateTooSmallTest (constructor)
89  //
90  // Purpose : Constructs a NOX-compatiable status test based
91  // the weighted norm of the update.
92  //
93  //---------------------------------------------------------------------------
94  UpdateTooSmallTest(const N_NLS_NOX::WeightedUpdateTest& test, double tol);
95 
96  //---------------------------------------------------------------------------
97  // Function : Destructor
98  //---------------------------------------------------------------------------
100 
101  //---------------------------------------------------------------------------
102  // Purpose : Test stopping criterion given the current
103  // nonlinear problem
104  //---------------------------------------------------------------------------
105  NOX::StatusTest::StatusType checkStatus(const NOX::Solver::Generic& problem);
106 
107  //---------------------------------------------------------------------------
108  // Purpose : Test stopping criterion given the current
109  // nonlinear problem
110  //---------------------------------------------------------------------------
111  NOX::StatusTest::StatusType getStatus() const { return status_; };
112 
113  //---------------------------------------------------------------------------
114  // Purpose : Output formatted description of stopping test to
115  // output stream.
116  //---------------------------------------------------------------------------
117  std::ostream& print(std::ostream& stream, int indent = 0) const;
118 
119 private:
120 
121  NOX::StatusTest::StatusType status_;
123  const double tol_;
124  double result_;
125 
126 };
127 } // namespace N_NLS_NOX
128 
129 #endif
130