BelosStatusTest.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                 Belos: Block Linear Solvers Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
//

#ifndef BELOS_STATUS_TEST_HPP
#define BELOS_STATUS_TEST_HPP

#include "BelosTypes.hpp"
#include "BelosIterativeSolver.hpp"
#include "BelosConfigDefs.hpp"

namespace Belos {

template <class ScalarType, class MV, class OP>
class StatusTest {

 public:


  StatusTest() {};

  virtual ~StatusTest() {};




  virtual StatusType CheckStatus( IterativeSolver<ScalarType,MV,OP>* iSolver ) = 0;

  virtual StatusType GetStatus() const = 0;




  virtual void Reset() = 0;




  virtual bool ResidualVectorRequired() const = 0;



  virtual ostream& Print(ostream& os, int indent = 0) const = 0;
 
  virtual void PrintStatus(ostream& os, StatusType type) const {
    os << setiosflags(ios::left) << setw(13) << setfill('.');
    switch (type) {
    case  Failed:
      os << "Failed";
      break;
    case  NaN:  
      os << "NaN";
      break;
    case  Converged:
      os << "Converged";
      break;
    case  Unconverged:
    default:
      os << "**";
      break;
    }
    os << setiosflags(ios::left) << setfill(' ');
    return;
  };

};

} // end of Belos namespace

#endif /* BELOS_STATUS_TEST_HPP */

---