BelosMinresIteration.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_MINRES_ITERATION_HPP
#define BELOS_MINRES_ITERATION_HPP

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

namespace Belos {


  
  template <class ScalarType, class MV>
  struct MinresIterationState {

    Teuchos::RCP<const MV> Y;

    Teuchos::RCP<const MV> R1;

    Teuchos::RCP<const MV> R2;

    Teuchos::RCP<const MV> W;

    Teuchos::RCP<const MV> W1;

    Teuchos::RCP<const MV> W2;

    MinresIterationState() : Y(Teuchos::null),
                             R1(Teuchos::null),
                             R2(Teuchos::null),
                             W(Teuchos::null),
                             W1(Teuchos::null),
                             W2(Teuchos::null)
    {}
  };


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


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

  public:



  virtual void initializeMinres(const MinresIterationState<ScalarType,MV> & newstate) = 0;

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

};

} // end Belos namespace

#endif /* BELOS_MINRES_ITERATION_HPP */