BelosCGIteration.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_CG_ITERATION_HPP
#define BELOS_CG_ITERATION_HPP

 
#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
#include "BelosIteration.hpp"
#include "BelosMultiVecTraits.hpp"
#include "Teuchos_Assert.hpp"
 
namespace Belos {



  template <class ScalarType, class MV>
  class CGIterationStateBase {
 
  public:
    virtual void initialize(Teuchos::RCP<const MV> tmp, int _numVectors) {
      TEUCHOS_ASSERT(!R.is_null());
      TEUCHOS_ASSERT(!Z.is_null());
      TEUCHOS_ASSERT(!P.is_null());
      TEUCHOS_ASSERT(!AP.is_null());
      isInitialized_ = true;
      numVectors_ = _numVectors;
    }
 
    virtual ~CGIterationStateBase() = default;
 
    bool isInitialized() const { return isInitialized_; }
 
    int numVectors() const { return numVectors_; }
 
    virtual bool matches(Teuchos::RCP<const MV> tmp, int _numVectors=1) const {
      using MVT = MultiVecTraits<ScalarType, MV>;
      return (isInitialized() &&
              !R.is_null() &&
              !Z.is_null() &&
              !P.is_null() &&
              !AP.is_null() &&
              (numVectors() == _numVectors) &&
              (MVT::GetGlobalLength(*tmp) == MVT::GetGlobalLength(*R)));
    }

    Teuchos::RCP<MV> R;

    Teuchos::RCP<MV> Z;

    Teuchos::RCP<MV> P;

    Teuchos::RCP<MV> AP;
 
  private:
 
    bool isInitialized_;
    int numVectors_;
 
  };



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

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

  class CGPositiveDefiniteFailure : public CGIterateFailure {public:
    CGPositiveDefiniteFailure(const std::string& what_arg) : CGIterateFailure(what_arg)
    {}};

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

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

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



  virtual void initializeCG(Teuchos::RCP<CGIterationStateBase<ScalarType,MV> > newstate, Teuchos::RCP<MV> R_0) = 0;

  virtual Teuchos::RCP<CGIterationStateBase<ScalarType,MV> > getState() const = 0;
 
  virtual void setState(Teuchos::RCP<CGIterationStateBase<ScalarType,MV> > state) = 0;
 

  virtual void setDoCondEst(bool val) = 0;

  virtual Teuchos::ArrayView<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> getDiag() = 0;

  virtual Teuchos::ArrayView<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> getOffDiag() = 0;
 
};
 
} // end Belos namespace
 
#endif /* BELOS_CG_ITERATION_HPP */