Belos Version of the Day
BelosStatusTest.hpp
Go to the documentation of this file.
00001 
00002 //@HEADER
00003 // ************************************************************************
00004 //
00005 //                 Belos: Block Linear Solvers Package
00006 //                  Copyright 2004 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00039 //
00040 // ************************************************************************
00041 //@HEADER
00042 //
00043 
00044 #ifndef BELOS_STATUS_TEST_HPP
00045 #define BELOS_STATUS_TEST_HPP
00046 
00052 #include "BelosTypes.hpp"
00053 #include "BelosIteration.hpp"
00054 #include "BelosConfigDefs.hpp"
00055 #include "Teuchos_Describable.hpp"
00056 
00066 namespace Belos {
00067 
00069 
00070 
00073   class StatusTestError : public BelosError 
00074   {public: StatusTestError(const std::string& what_arg) : BelosError(what_arg) {}};
00075 
00077 
00078 template <class ScalarType, class MV, class OP>
00079 class StatusTest : public Teuchos::Describable {
00080 
00081  public:
00083 
00084 
00086   StatusTest() {};
00087 
00089   virtual ~StatusTest() {};
00091 
00093 
00094 
00095 
00103   virtual StatusType checkStatus( Iteration<ScalarType,MV,OP>* iSolver ) = 0;
00104 
00106   virtual StatusType getStatus() const = 0;
00108 
00110 
00111 
00112 
00117   virtual void reset() = 0;
00119 
00121 
00122 
00124   virtual void print(std::ostream& os, int indent = 0) const = 0;
00125  
00127   virtual void printStatus(std::ostream& os, StatusType type) const {
00128     os << std::left << std::setw(13) << std::setfill('.');
00129     switch (type) {
00130     case  Passed:
00131       os << "Passed";
00132       break;
00133     case  Failed:
00134       os << "Failed";
00135       break;
00136     case  Undefined:  
00137     default:
00138       os << "**";
00139       break;
00140     }
00141     os << std::left << std::setfill(' ');
00142     return;
00143   };
00145 
00146 };
00147 
00148 } // end of Belos namespace
00149 
00150 #endif /* BELOS_STATUS_TEST_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines