Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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-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_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.13 $
38 //
39 // Revision Date : $Date: 2014/02/24 23:49:27 $
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 //-----------------------------------------------------------------------------
50 // Class : N_TIA_TwoLevelError
51 //
52 // Purpose : This class contains error information from an inner solve.
53 // Any wrms norm that is taken in the course of time integration
54 // needs to include information from the inner problems.
55 // This class contains that info for a single inner problem.
56 // There will generally be a class like this for each
57 // inner problem.
58 //
59 // Special Notes :
60 // Creator : Eric Keiter, SNL
61 // Creation Date : 1/29/07
62 //-----------------------------------------------------------------------------
64 {
65 public:
67  xErrorSum(0.0),
68  qErrorSum(0.0),
69  innerSize(0.0),
70  xErrorSum_m1(0.0),
71  xErrorSum_m2(0.0),
72  xErrorSum_p1(0.0),
73  q1HistorySum(0.0)
74  { };
75 
76  virtual ~N_TIA_TwoLevelError() {};
77 
78  double xErrorSum;
79  double qErrorSum;
80  double innerSize;
81 
82  double xErrorSum_m1;
83  double xErrorSum_m2;
84  double xErrorSum_p1;
85 
86  double q1HistorySum;
87 };
88 
89 //-----------------------------------------------------------------------------
90 // Function : operator<<
91 // Purpose : "<<" operator for two level error class.
92 // Special Notes :
93 // Scope : public
94 // Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
95 // Creation Date : 10/17/05
96 //-----------------------------------------------------------------------------
97 std::ostream & operator<<(std::ostream & os, const N_TIA_TwoLevelError & tlerror);
98 
99 #endif // Xyce_N_TIA_TWO_LEVEL_ERROR_H
100