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

 
#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
 
#include "Teuchos_Array.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_ScalarTraits.hpp"
 
 
namespace Belos {
 
template <class ScalarType, class MV, class OP, class DM>
class LinearProblem;
 
template <class ScalarType>
class OutputManager;
 
template <class ScalarType, class MV, class OP, class DM>
class StatusTest;
 
template <class ScalarType, class MV, class OP, class DM>
class MatOrthoManager;
 
template<class ScalarType, class MV, class OP, class DM = DefaultDenseMatrix<int, ScalarType>>
class Iteration {
 
  public:



  Iteration() {};

  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,DM>& 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 */