BelosIteration.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_ITERATION_HPP
#define BELOS_ITERATION_HPP

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

#include "Teuchos_ParameterList.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_Array.hpp"

namespace Belos {

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

template <class ScalarType>
class OutputManager;

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

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

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

  public:



  Iteration() {};


  Iteration( const Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > &problem, 
       const Teuchos::RCP<OutputManager<ScalarType> > &printer,
       const Teuchos::RCP<StatusTest<ScalarType,MV,OP> > &tester,
       const Teuchos::RCP<MatOrthoManager<ScalarType,MV,OP> > &ortho,
       Teuchos::ParameterList &params );

  virtual ~Iteration() {};



  
  virtual void iterate() = 0;

  virtual void initialize() = 0;


  


  virtual int getNumIters() const = 0;
  
  virtual void resetNumIters( int iter = 0 ) = 0;

  virtual Teuchos::RCP<const MV> getNativeResiduals( std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> *norms ) const = 0;


  virtual Teuchos::RCP<MV> getCurrentUpdate() const = 0;



  


  virtual const LinearProblem<ScalarType,MV,OP>& getProblem() const = 0;

  virtual int getBlockSize() const = 0;
  
  virtual void setBlockSize(int blockSize) = 0;

  virtual bool isInitialized() = 0;


};

} // end Belos namespace

#endif /* BELOS_ITERATION_HPP */

---