BelosGmresIteration.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_GMRES_ITERATION_HPP
#define BELOS_GMRES_ITERATION_HPP

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

namespace Belos {


  
  template <class ScalarType, class MV>
  struct GmresIterationState {
    int curDim;

    Teuchos::RCP<const MV> V;

    Teuchos::RCP<const MV> Z;

    Teuchos::RCP<const Teuchos::SerialDenseMatrix<int,ScalarType> > H;
    Teuchos::RCP<const Teuchos::SerialDenseMatrix<int,ScalarType> > R;
    Teuchos::RCP<const Teuchos::SerialDenseMatrix<int,ScalarType> > z;
    

    GmresIterationState() : curDim(0), V(Teuchos::null), Z(Teuchos::null),
          H(Teuchos::null), R(Teuchos::null), 
          z(Teuchos::null)
    {}
  };



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

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

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


template<class ScalarType, class MV, class OP>
class GmresIteration : virtual public Iteration<ScalarType,MV,OP> {

  public:



  virtual void initializeGmres(GmresIterationState<ScalarType,MV>& newstate) = 0;

  virtual GmresIterationState<ScalarType,MV> getState() const = 0;




  virtual void updateLSQR( int dim = -1 ) = 0;

  virtual int getCurSubspaceDim() const = 0; 

  virtual int getMaxSubspaceDim() const = 0;




  virtual void setSize(int blockSize, int numBlocks) = 0;


};

} // end Belos namespace

#endif /* BELOS_GMRES_ITERATION_HPP */