Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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-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_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.17 $
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 
53 #include <N_UTL_fwd.h>
54 
57 #include "NOX.H"
59 
60 // ---------- Namespaces ----------
61 
62 using namespace N_NLS_NOX;
63 
64 // ---------- Code ----------
65 
67  double minNormF) :
68  status_(NOX::StatusTest::Unconverged),
69  maxStepSize_(maxStepSize),
70  currentStepSize_(0.0),
71  minNormF_(minNormF),
72  currentNormF_(1.0)
73 {
74 }
75 
77 {
78 }
79 
80 NOX::StatusTest::StatusType PseudoTransientTest::
81 checkStatus(const NOX::Solver::Generic& problem,
82  NOX::StatusTest::CheckType checkType)
83 {
84  status_ = NOX::StatusTest::Unconverged;
85 
86  const N_NLS_NOX::PseudoTransientBased* psts = 0;
87  psts = dynamic_cast<const N_NLS_NOX::PseudoTransientBased*>(&problem);
88 
89  if (psts == 0) {
90  Xyce::dout() << "NOX::StatusTest::PseudoTransientTest::checkStatus - failed dynamic_cast solver to PseudoTransientBased!" << std::endl;
91  throw "NOX Error";
92  }
94 
95  currentNormF_ = problem.getSolutionGroup().getNormF();
96 
98  status_ = NOX::StatusTest::Converged;
99 
100  return status_;
101 }
102 
103 std::ostream& PseudoTransientTest::print(std::ostream& stream, int indent) const
104 {
105  for (int j = 0; j < indent; ++j )
106  stream << ' ';
107  stream << status_;
108  stream << "Pseudo Transient Step Size = "
109  << NOX::Utils::sciformat(currentStepSize_, 5)
110  << " >= " << NOX::Utils::sciformat(maxStepSize_, 5);
111  stream << std::endl;
112 
113  for (int j = 0; j < indent; ++j)
114  stream << ' ';
115  stream << status_;
116  stream << "Pseudo Transient Residual Reduction = "
117  << NOX::Utils::sciformat(currentNormF_, 5)
118  << " < " << NOX::Utils::sciformat(minNormF_, 5);
119  stream << std::endl;
120 
121  return stream;
122 }