Belos  Version of the Day
BelosTypes.hpp
Go to the documentation of this file.
1 //@HEADER
2 // ************************************************************************
3 //
4 // Belos: Block Linear Solvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 //@HEADER
41 
42 #ifndef BELOS_TYPES_HPP
43 #define BELOS_TYPES_HPP
44 
50 #include "BelosConfigDefs.hpp"
51 #include "Teuchos_Assert.hpp"
52 
53 namespace Belos {
54 
56 
57 
60  class BelosError : public std::logic_error {
61  public:
62  BelosError (const std::string& what_arg) : std::logic_error(what_arg) {}
63  };
64 
66 
67 
81  enum ETrans { NOTRANS = 0,
82  TRANS = 1,
83  CONJTRANS = 2
84  };
85 
97  enum NormType { OneNorm,
100  };
101 
128  };
129 
143  };
144 
154  enum ReturnType {
157  };
158 
160  std::string
161  convertReturnTypeToString (const ReturnType result);
162 
188  enum StatusType { Passed = 0x1,
189  Failed = 0x2,
190  Undefined = 0x4
191  };
192 
205  enum ResetType { Problem = 0x1,
207  };
208 
214  BELOS_DEPRECATED const char*
215  toString (const StatusType status);
216 
218  std::string
219  convertStatusTypeToString (const StatusType status);
220 
222  StatusType
223  convertStringToStatusType (const std::string& status);
224 
226  ScaleType
227  convertStringToScaleType (const std::string& scaleType);
228 
230  std::string
231  convertScaleTypeToString (const ScaleType scaleType);
232 
241  enum ConjType {
244  };
245 
257  enum MsgType {
258  Errors= 0,
259  Warnings = 0x1,
261  OrthoDetails = 0x4,
262  FinalSummary = 0x8,
263  TimingDetails = 0x10,
265  Debug = 0x40
266  };
267 
278  std::string
279  convertMsgTypeToString (const MsgType msgType);
280 
294  static constexpr double convTol = 1.0e-8;
295 
297  static constexpr double polyTol = 1.0e-12;
298 
300  static constexpr double orthoKappa = -1.0;
301 
303  static constexpr double resScaleFactor = 1.0;
304 
306  static constexpr double impTolScale = 10.0;
307  };
308 
309 
310 } // end Belos namespace
311 
312 #endif /* BELOS_TYPES_HPP */
ScaleType convertStringToScaleType(const std::string &scaleType)
Convert the given string to its ScaleType enum value.
Definition: BelosTypes.cpp:88
static constexpr double impTolScale
"Implicit Tolerance Scale Factor"
Definition: BelosTypes.hpp:306
ScaleType
The type of scaling to use on the residual norm value.
Definition: BelosTypes.hpp:119
static constexpr double orthoKappa
DGKS orthogonalization constant.
Definition: BelosTypes.hpp:300
MsgType
Available message types recognized by the linear solvers.
Definition: BelosTypes.hpp:257
StatusType
Whether the StatusTest wants iteration to stop.
Definition: BelosTypes.hpp:188
std::string convertStatusTypeToString(const StatusType status)
The string name corresponding to the given StatusType enum value.
Definition: BelosTypes.cpp:66
std::string convertScaleTypeToString(const ScaleType scaleType)
Convert the given ScaleType enum value to its corresponding string.
Definition: BelosTypes.cpp:108
ETrans
Whether to apply the (conjugate) transpose of an operator.
Definition: BelosTypes.hpp:81
ConjType
Whether or not to conjugate the transpose for block inner products.
Definition: BelosTypes.hpp:241
ResetType
How to reset the solver.
Definition: BelosTypes.hpp:205
static constexpr double convTol
Default convergence tolerance.
Definition: BelosTypes.hpp:294
static constexpr double resScaleFactor
User-defined residual scaling factor.
Definition: BelosTypes.hpp:303
static constexpr double polyTol
Relative residual tolerance for matrix polynomial construction.
Definition: BelosTypes.hpp:297
std::string convertMsgTypeToString(const MsgType msgType)
Show MsgType as a comma-delimited list of names.
Definition: BelosTypes.cpp:128
BelosError(const std::string &what_arg)
Definition: BelosTypes.hpp:62
ReturnType
Whether the Belos solve converged for all linear systems.
Definition: BelosTypes.hpp:154
NormType
The type of vector norm to compute.
Definition: BelosTypes.hpp:97
std::string convertReturnTypeToString(const ReturnType result)
Convert the given ReturnType enum value to its corresponding string.
Definition: BelosTypes.cpp:179
StatusType convertStringToStatusType(const std::string &status)
The StatusType enum value corresponding to the given string name.
Definition: BelosTypes.cpp:72
BELOS_DEPRECATED const char * toString(const StatusType status)
The string name corresponding to the given StatusType enum value.
Parent class to all Belos exceptions.
Definition: BelosTypes.hpp:60
Default parameters common to most Belos solvers.
Definition: BelosTypes.hpp:286
Belos header file which uses auto-configuration information to include necessary C++ headers...
OutputType
Style of output used to display status test information.
Definition: BelosTypes.hpp:140

Generated for Belos by doxygen 1.8.14