BelosStatusTest.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                 Belos: Block Linear Solvers Package
//
// Copyright 2004-2016 NTESS and the Belos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
//

#ifndef BELOS_STATUS_TEST_HPP
#define BELOS_STATUS_TEST_HPP

#include "BelosTypes.hpp"
#include "BelosIteration.hpp"
#include "BelosConfigDefs.hpp"
#include "Teuchos_Describable.hpp"

namespace Belos {



  class StatusTestError : public BelosError 
  {public: StatusTestError(const std::string& what_arg) : BelosError(what_arg) {}};

  class StatusTestNaNError : public StatusTestError
  {public: StatusTestNaNError(const std::string& what_arg) : StatusTestError(what_arg) {}};


template <class ScalarType, class MV, class OP>
class StatusTest : public Teuchos::Describable {

 public:


  StatusTest() {};

  virtual ~StatusTest() {};



  virtual StatusType checkStatus( Iteration<ScalarType,MV,OP>* iSolver ) = 0;

  virtual StatusType getStatus() const = 0;



  virtual void reset() = 0;



  virtual void print(std::ostream& os, int indent = 0) const = 0;
 
  virtual void printStatus(std::ostream& os, StatusType type) const {
    os << std::left << std::setw(13) << std::setfill('.');
    switch (type) {
    case  Passed:
      os << "Passed";
      break;
    case  Failed:
      os << "Failed";
      break;
    case  Undefined:  
    default:
      os << "**";
      break;
    }
    os << std::left << std::setfill(' ');
    return;
  };

};

} // end of Belos namespace

#endif /* BELOS_STATUS_TEST_HPP */