Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_NLS_NOX_LargeUpdateTest.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_LargeUpdateTest.C,v $
27 //
28 // Purpose : Status test.
29 //
30 // Special Notes :
31 //
32 // Creator : Roger Pawlowski, SNL 9233
33 //
34 // Creation Date : 04/02/2003
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.12 $
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 
54 #include "N_NLS_NOX_Vector.h"
55 #include "N_LAS_Vector.h"
56 #include "NOX.H"
57 #include "NOX_Solver_LineSearchBased.H"
58 
59 // ---------- Namespaces ----------
60 
61 using namespace N_NLS_NOX;
62 
63 // ---------- Code ----------
64 
65 LargeUpdateTest::LargeUpdateTest(double maxConvRate) :
66 
67  maxConvRate_(maxConvRate),
68  currentConvRate_(1.0),
69  status_(NOX::StatusTest::Unconverged)
70 {
71 
72 }
73 
75 {
76 
77 }
78 
79 
80 NOX::StatusTest::StatusType LargeUpdateTest::checkStatus(const NOX::Solver::Generic& problem)
81 {
82  status_ = NOX::StatusTest::Unconverged;
83 
84  if (problem.getNumIterations() < 1) {
85  currentConvRate_ = 1.0;
86  return status_;
87  }
88 
89  // ||F(x_current)|| / ||F(x_previous)||
90  currentConvRate_ = (problem.getSolutionGroup().getNormF()) /
91  (problem.getPreviousSolutionGroup().getNormF());
92 
94  status_ = NOX::StatusTest::Failed;
95  }
96 
97  return status_;
98 }
99 
100 std::ostream& LargeUpdateTest::print(std::ostream& stream, int indent) const
101 {
102  for (int j = 0; j < indent; ++j )
103  stream << ' ';
104 
105  stream << status_;
106 
107  stream << "Update Too Big = " << currentConvRate_ << " > " << maxConvRate_
108  << std::endl;
109 
110  return stream;
111 }
112