BelosFixedPointIteration.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_FIXEDPOINT_ITERATION_HPP
#define BELOS_FIXEDPOINT_ITERATION_HPP

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

namespace Belos {


  
  template <class ScalarType, class MV>
  struct FixedPointIterationState {

    Teuchos::RCP<const MV> R;

    Teuchos::RCP<const MV> Z;
    
    FixedPointIterationState() : R(Teuchos::null), Z(Teuchos::null)
    {}
  };

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

  public:



  virtual void initializeFixedPoint(FixedPointIterationState<ScalarType,MV>& newstate) = 0;

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

};

} // end Belos namespace

#endif /* BELOS_FIXEDPOINT_ITERATION_HPP */