Xyce  6.1
N_NLS_NOX_PseudoTransientTest.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-2015 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_PseudoTransientTest.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.20 $
40 //
41 // Revision Date : $Date: 2015/04/08 19:18:29 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-------------------------------------------------------------------------
45 
46 #include <Xyce_config.h>
47 
48 
49 // ---------- Standard Includes ----------
50 
51 // ---------- Xyce Includes ----------
52 
53 #include <N_UTL_fwd.h>
54 
56 #include "NOX.H"
58 
59 // ---------- Namespaces ----------
60 
61 namespace Xyce {
62 namespace Nonlinear {
63 namespace N_NLS_NOX {
64 
65 // ---------- Code ----------
66 
68  double minNormF) :
69  status_(NOX::StatusTest::Unconverged),
70  maxStepSize_(maxStepSize),
71  currentStepSize_(0.0),
72  minNormF_(minNormF),
73  currentNormF_(1.0)
74 {
75 }
76 
78 {
79 }
80 
81 NOX::StatusTest::StatusType PseudoTransientTest::
82 checkStatus(const NOX::Solver::Generic& problem,
83  NOX::StatusTest::CheckType checkType)
84 {
85  status_ = NOX::StatusTest::Unconverged;
86 
87  const PseudoTransientBased* psts = 0;
88  psts = dynamic_cast<const PseudoTransientBased*>(&problem);
89 
90  if (psts == 0) {
91  dout() << "NOX::StatusTest::PseudoTransientTest::checkStatus - failed dynamic_cast solver to PseudoTransientBased!" << std::endl;
92  throw "NOX Error";
93  }
95 
96  currentNormF_ = problem.getSolutionGroup().getNormF();
97 
99  status_ = NOX::StatusTest::Converged;
100 
101  return status_;
102 }
103 
104 std::ostream& PseudoTransientTest::print(std::ostream& stream, int indent) const
105 {
106  for (int j = 0; j < indent; ++j )
107  stream << ' ';
108  stream << status_;
109  stream << "Pseudo Transient Step Size = "
110  << NOX::Utils::sciformat(currentStepSize_, 5)
111  << " >= " << NOX::Utils::sciformat(maxStepSize_, 5);
112  stream << std::endl;
113 
114  for (int j = 0; j < indent; ++j)
115  stream << ' ';
116  stream << status_;
117  stream << "Pseudo Transient Residual Reduction = "
118  << NOX::Utils::sciformat(currentNormF_, 5)
119  << " < " << NOX::Utils::sciformat(minNormF_, 5);
120  stream << std::endl;
121 
122  return stream;
123 }
124 
125 }}}
Pure virtual class to augment a linear system.
NOX::StatusTest::StatusType checkStatus(const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)
PseudoTransientTest(double maxStepSize, double minNormF)
std::ostream & print(std::ostream &stream, int indent=0) const
Definition: N_NLS_fwd.h:108
virtual double getPseudoTransientStepSize() const
Return the pseudo transient step size.