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, class DM = DefaultDenseMatrix<int,ScalarType>>
  struct GmresIterationState {
    int curDim;

    Teuchos::RCP<const MV> V;

    Teuchos::RCP<const MV> Z;

 
    Teuchos::RCP<const DM> H;
 
    Teuchos::RCP<const DM> R;
 
    Teuchos::RCP<const DM> z;
    
 
    GmresIterationState() : curDim(0), V(Teuchos::null), Z(Teuchos::null),
          H(Teuchos::null), R(Teuchos::null), 
          z(Teuchos::null)
    {}
  };



  template <class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>
  struct PseudoBlockGmresIterState {
 
    typedef Teuchos::ScalarTraits<ScalarType> SCT;
    typedef typename SCT::magnitudeType MagnitudeType;

    int curDim;
    std::vector<Teuchos::RCP<const MV> > V;
    std::vector<Teuchos::RCP<const DM> > H;
    std::vector<Teuchos::RCP<const DM> > R;
    std::vector<Teuchos::RCP<const DM> > Z;
    std::vector<Teuchos::RCP<const std::vector<ScalarType> > > sn;
    std::vector<Teuchos::RCP<const std::vector<MagnitudeType> > > cs;
 
    PseudoBlockGmresIterState() : curDim(0), V(0),
                                  H(0), R(0), Z(0),
                                  sn(0), cs(0)
    {}
  };



  
  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)
    {}};
  


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

 
template<class ScalarType, class MV, class OP, class DM = DefaultDenseMatrix<int,ScalarType>>
class GmresIteration : virtual public Iteration<ScalarType,MV,OP,DM> {
 
  public:



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

  virtual GmresIterationState<ScalarType,MV,DM> 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 */