Belos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BelosStatusTest.hpp
Go to the documentation of this file.
1 
2 //@HEADER
3 // ************************************************************************
4 //
5 // Belos: Block Linear Solvers Package
6 // Copyright 2004 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ************************************************************************
41 //@HEADER
42 //
43 
44 #ifndef BELOS_STATUS_TEST_HPP
45 #define BELOS_STATUS_TEST_HPP
46 
52 #include "BelosTypes.hpp"
53 #include "BelosIteration.hpp"
54 #include "BelosConfigDefs.hpp"
55 #include "Teuchos_Describable.hpp"
56 
66 namespace Belos {
67 
69 
70 
73  class StatusTestError : public BelosError
74  {public: StatusTestError(const std::string& what_arg) : BelosError(what_arg) {}};
75 
77  {public: StatusTestNaNError(const std::string& what_arg) : StatusTestError(what_arg) {}};
78 
80 
81 template <class ScalarType, class MV, class OP>
82 class StatusTest : public Teuchos::Describable {
83 
84  public:
86 
87 
89  StatusTest() {};
90 
92  virtual ~StatusTest() {};
94 
96 
97 
106  virtual StatusType checkStatus( Iteration<ScalarType,MV,OP>* iSolver ) = 0;
107 
109  virtual StatusType getStatus() const = 0;
111 
113 
114 
120  virtual void reset() = 0;
122 
124 
125 
127  virtual void print(std::ostream& os, int indent = 0) const = 0;
128 
130  virtual void printStatus(std::ostream& os, StatusType type) const {
131  os << std::left << std::setw(13) << std::setfill('.');
132  switch (type) {
133  case Passed:
134  os << "Passed";
135  break;
136  case Failed:
137  os << "Failed";
138  break;
139  case Undefined:
140  default:
141  os << "**";
142  break;
143  }
144  os << std::left << std::setfill(' ');
145  return;
146  };
148 
149 };
150 
151 } // end of Belos namespace
152 
153 #endif /* BELOS_STATUS_TEST_HPP */
Collection of types and exceptions used within the Belos solvers.
Exception thrown to signal error in a status test during Belos::StatusTest::checkStatus().
StatusTest()
Constructor.
Pure virtual base class which describes the basic interface to the linear solver iteration.
virtual StatusType checkStatus(Iteration< ScalarType, MV, OP > *iSolver)=0
Check convergence status: Unconverged, Converged, Failed.
A pure virtual class for defining the status tests for the Belos iterative solvers.
StatusType
Whether the StatusTest wants iteration to stop.
Definition: BelosTypes.hpp:189
virtual void print(std::ostream &os, int indent=0) const =0
Output formatted description of stopping test to output stream.
virtual ~StatusTest()
Destructor.
StatusTestNaNError(const std::string &what_arg)
BelosError(const std::string &what_arg)
Definition: BelosTypes.hpp:62
StatusTestError(const std::string &what_arg)
virtual void reset()=0
Informs the convergence test that it should reset its internal configuration to the initialized state...
Parent class to all Belos exceptions.
Definition: BelosTypes.hpp:60
virtual StatusType getStatus() const =0
Return the result of the most recent CheckStatus call.
virtual void printStatus(std::ostream &os, StatusType type) const
Output the result of the most recent CheckStatus call.
Belos header file which uses auto-configuration information to include necessary C++ headers...