Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_NLS_NOX_UpdateTooSmallTest.C
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.C,v $
27 //
28 // Purpose : Status test.
29 //
30 // Special Notes :
31 //
32 // Creator : Roger Pawlowski, SNL 9233
33 //
34 // Creation Date : 04/15/03
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.9 $
40 //
41 // Revision Date : $Date: 2014/02/24 23:49:25 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-------------------------------------------------------------------------
45 
46 #include <Xyce_config.h>
47 
48 
49 // ---------- Standard Includes ----------
50 
51 // ---------- Xyce Includes ----------
52 
55 #include "NOX.H"
56 
57 // ---------- Namespaces ----------
58 
59 using namespace N_NLS_NOX;
60 
61 // ---------- Code ----------
62 
64  double tol) :
65  test_(t),
66  tol_(tol)
67 {
68  result_ = 0.0;
69  status_ = NOX::StatusTest::Unconverged;
70 }
71 
73 {
74 }
75 
76 
77 NOX::StatusTest::StatusType UpdateTooSmallTest::checkStatus(const NOX::Solver::Generic& problem)
78 {
79  status_ = NOX::StatusTest::Unconverged;
80 
81  if (problem.getNumIterations() < 1)
82  return status_;
83 
85 
86  if (result_ < tol_)
87  status_ = NOX::StatusTest::Converged;
88 
89  return status_;
90 }
91 
92 std::ostream& UpdateTooSmallTest::print(std::ostream& stream, int indent) const
93 {
94  for (int j = 0; j < indent; ++j )
95  stream << ' ';
96  stream << status_;
97  stream << "Weighted Update Too Small = "
98  << NOX::Utils::sciformat(result_, 3)
99  << " < " << NOX::Utils::sciformat(tol_, 3);
100  stream << std::endl;
101 
102  return stream;
103 }
104