Xyce  6.1
N_TIA_TwoLevelError.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-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_TIA_TwoLevelError.h,v $
27 // Purpose :
28 // Special Notes :
29 //
30 // Creator : Eric Keiter
31 //
32 // Creation Date : 1/29/07
33 //
34 // Revision Information:
35 // ---------------------
36 //
37 // Revision Number: $Revision: 1.17 $
38 //
39 // Revision Date : $Date: 2015/04/08 19:18:30 $
40 //
41 // Current Owner : $Author: tvrusso $
42 //-----------------------------------------------------------------------------
43 
44 #ifndef Xyce_N_TIA_TWO_LEVEL_ERROR_H
45 #define Xyce_N_TIA_TWO_LEVEL_ERROR_H
46 
47 #include <iosfwd>
48 
49 namespace Xyce {
50 namespace TimeIntg {
51 
52 //-----------------------------------------------------------------------------
53 // Class : TwoLevelError
54 //
55 // Purpose : This class contains error information from an inner solve.
56 // Any wrms norm that is taken in the course of time integration
57 // needs to include information from the inner problems.
58 // This class contains that info for a single inner problem.
59 // There will generally be a class like this for each
60 // inner problem.
61 //
62 // Special Notes :
63 // Creator : Eric Keiter, SNL
64 // Creation Date : 1/29/07
65 //-----------------------------------------------------------------------------
67 {
68 public:
70  xErrorSum(0.0),
71  qErrorSum(0.0),
72  innerSize(0.0),
73  xErrorSum_m1(0.0),
74  xErrorSum_m2(0.0),
75  xErrorSum_p1(0.0),
76  q1HistorySum(0.0)
77  {}
78 
79  virtual ~TwoLevelError() {}
80 
81  double xErrorSum;
82  double qErrorSum;
83  double innerSize;
84 
85  double xErrorSum_m1;
86  double xErrorSum_m2;
87  double xErrorSum_p1;
88 
89  double q1HistorySum;
90 };
91 
92 //-----------------------------------------------------------------------------
93 // Function : operator<<
94 // Purpose : "<<" operator for two level error class.
95 // Special Notes :
96 // Scope : public
97 // Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
98 // Creation Date : 10/17/05
99 //-----------------------------------------------------------------------------
100 std::ostream & operator<<(std::ostream & os, const TwoLevelError & tlerror);
101 
102 } // namespace TimeIntg
103 } // namespace Xyce
104 
105 #endif // Xyce_N_TIA_TWO_LEVEL_ERROR_H
106 
Pure virtual class to augment a linear system.
std::ostream & operator<<(std::ostream &os, const StepErrorControl &sec)