Xyce  6.1
N_NLS_NOX.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_NLS_NOX.h,v $
27 //
28 // Purpose : Error-handling for N_NLS_NOX
29 //
30 // Special Notes :
31 //
32 // Creator : Tammy Kolda, NLS, 8950
33 //
34 // Creation Date : 01/31/02
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.14.2.1 $
40 //
41 // Revision Date : $Date: 2015/04/02 18:20:17 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-------------------------------------------------------------------------
45 
46 #ifndef Xyce_N_NLS_NOX_h
47 #define Xyce_N_NLS_NOX_h
48 
49 // ---------- Standard Includes ----------
50 
51 #include <string>
52 
53 // ---------- Xyce Includes ----------
54 
55 // ---------- NOX Includes ----------
56 
57 // ---------- Forward Declarations ----------
58 
59 // ---------- Namespace Declarations ----------
60 
61 // ---------- Function Declarations ----------
62 
63 namespace Xyce {
64 namespace Nonlinear {
65 namespace N_NLS_NOX {
66 
67  //---------------------------------------------------------------------------
68  // Function : error
69  // Purpose : This is a wrapper for
70  // N_ERH_ErrorMsg::report(N_ERH_ErrorMsg::USR_ERROR_0, msg).
71  // It throws "N_NLS_NOX Error" after calling report.
72  //---------------------------------------------------------------------------
73  void error(const std::string &msg);
74 
75  //---------------------------------------------------------------------------
76  // Function : error
77  // Purpose : This is simply a wrapper for
78  // N_ERH_ErrorMsg::report(N_ERH_ErrorMsg::USR_WARNING_0, msg)
79  //---------------------------------------------------------------------------
80  void warning(const std::string &msg);
81 
82  //---------------------------------------------------------------------------
83  // Function : error
84  // Purpose : This is simply a wrapper for
85  // lout() << msg)
86  //---------------------------------------------------------------------------
87  void info(const std::string &msg);
88 
89 }} // namespace N_NLS_NOX
90 } // namespace Xyce
91 
92 #endif
93 
Pure virtual class to augment a linear system.
void info(const std::string &msg)
Definition: N_NLS_NOX.C:71
void error(const std::string &msg)
Definition: N_NLS_NOX.C:61
void warning(const std::string &msg)
Definition: N_NLS_NOX.C:66