BelosIterativeSolver.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_ITERATIVE_SOLVER_HPP
#define BELOS_ITERATIVE_SOLVER_HPP

#include "Teuchos_ParameterList.hpp"
#include "Teuchos_ScalarTraits.hpp"
#include "Teuchos_Describable.hpp"

using Teuchos::RefCountPtr;
using Teuchos::ParameterList;


namespace Belos {

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

template <class ScalarType, class MV, class OP>
class LinearProblem;

template <class ScalarType, class MV, class OP>
class IterativeSolver : virtual public Teuchos::Describable {
 
  typedef Teuchos::ScalarTraits<ScalarType> SCT;
  typedef typename SCT::magnitudeType MagnitudeType;
  
  public:


  IterativeSolver(void) {};

  virtual ~IterativeSolver(void) {};

  

  virtual int GetNumIters() const = 0;


  virtual int GetNumRestarts() const = 0;


  virtual RefCountPtr<const MV> GetNativeResiduals( std::vector<MagnitudeType> *normvec ) const = 0;


  virtual RefCountPtr<MV> GetCurrentSoln() = 0;

  virtual RefCountPtr<LinearProblem<ScalarType,MV,OP> > GetLinearProblem() const = 0;

  virtual RefCountPtr<StatusTest<ScalarType,MV,OP> > GetStatusTest() const = 0;


  
  virtual int Reset( const RefCountPtr<ParameterList>& pl = Teuchos::null ) { return 0; }
    

 
  virtual void Solve() = 0;

};

} // end Belos namespace

#endif /* BELOS_ITERATIVE_SOLVER_HPP */

---