BelosStatusTestMaxRestarts.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_MAXRESTARTS_HPP
#define BELOS_STATUS_TEST_MAXRESTARTS_HPP

#include "BelosStatusTest.hpp"

namespace Belos {

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

 public:



  StatusTestMaxRestarts(int maxIters);

  virtual ~StatusTestMaxRestarts() {};




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

  StatusType GetStatus() const {return(status_);};



  
  void Reset();




  int GetMaxRestarts() const { return(maxRestarts_); };

  int GetNumRestarts() const { return(nRestarts_); };




  bool ResidualVectorRequired() const { return(false); } ;



  ostream& Print(ostream& os, int indent = 0) const;

  

private:



  int maxRestarts_;

  int nRestarts_;

  StatusType status_;

};

  template <class ScalarType, class MV, class OP> 
  StatusTestMaxRestarts<ScalarType,MV,OP>::StatusTestMaxRestarts(int maxRestarts)
  {
    if (maxRestarts < 1)
      maxRestarts_ = 1;
    else
      maxRestarts_ = maxRestarts;
    
    nRestarts_ = 0;
    status_ = Unchecked;
  }
  
  template <class ScalarType, class MV, class OP>
  StatusType StatusTestMaxRestarts<ScalarType,MV,OP>::CheckStatus(IterativeSolver<ScalarType,MV,OP> *iSolver )
  {
    status_ = Unconverged;
    nRestarts_ = iSolver->GetNumRestarts();
    if (nRestarts_ >= maxRestarts_)
      status_ = Failed;
    return status_;
  }
  
  template <class ScalarType, class MV, class OP>
  void StatusTestMaxRestarts<ScalarType,MV,OP>::Reset()
  {
    status_ = Unchecked;
    nRestarts_ = 0;
  }

  template <class ScalarType, class MV, class OP>
  ostream& StatusTestMaxRestarts<ScalarType,MV,OP>::Print(ostream& os, int indent) const
  {
    for (int j = 0; j < indent; j ++)
      os << ' ';
    this->PrintStatus(os, status_);
    os << "Number of Restarts = ";
    os << nRestarts_;
    os << ((nRestarts_ < maxRestarts_) ? " < " : ((nRestarts_ == maxRestarts_) ? " == " : " > "));
    os << maxRestarts_;
    os << endl;
    return os;
  }
  
} // end Belos namespace

#endif /* BELOS_STATUS_TEST_MAXRESTARTS_HPP */

---