MueLu_StratimikosSmoother_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef MUELU_STRATIMIKOSSMOOTHER_DECL_HPP
#define MUELU_STRATIMIKOSSMOOTHER_DECL_HPP
 
#include <Teuchos_ParameterList.hpp>
 
#include <Xpetra_CrsMatrixWrap_fwd.hpp>
#include <Xpetra_Matrix_fwd.hpp>
 
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_StratimikosSmoother_fwd.hpp"
 
#if defined(HAVE_MUELU_STRATIMIKOS) && defined(HAVE_MUELU_THYRA)
 
#include <Tpetra_CrsMatrix.hpp>
 
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_Level_fwd.hpp"
#include "MueLu_SmootherPrototype.hpp"
#include "MueLu_Utilities_fwd.hpp"
 
#include <Thyra_LinearOpWithSolveBase.hpp>
 
namespace MueLu {
 
template <class Scalar        = SmootherPrototype<>::scalar_type,
          class LocalOrdinal  = typename SmootherPrototype<Scalar>::local_ordinal_type,
          class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type,
          class Node          = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class StratimikosSmoother : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_STRATIMIKOSSMOOTHER_SHORT
#include "MueLu_UseShortNames.hpp"
 
 public:
 
  // TODO: update doc for Stratimikos.
#ifndef _MSC_VER
  // Avoid error C3772: invalid friend template declaration
  template <class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>
  friend class StratimikosSmoother;
#endif
 
  StratimikosSmoother(const std::string type, const Teuchos::ParameterList& paramList = Teuchos::ParameterList()){
      TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "Stratimikos only works for Scalar=double.")};
 
  virtual ~StratimikosSmoother() = default;
 
 
  void SetParameterList(const Teuchos::ParameterList& paramList){};
 
 
 
  void DeclareInput(Level& currentLevel) const {};
 
 
 
 
  void Setup(Level& currentLevel){};
 
  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const {};
 
 
 
 
  RCP<SmootherPrototype> Copy() const { return Teuchos::null; };
 
 
 
 
  std::string description() const { return std::string(""); };
 
  // using MueLu::Describable::describe; // overloading, not hiding
  // void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const
  void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const {};
 
 
  // RCP<Ifpack2::Preconditioner<Scalar,LocalOrdinal,GlobalOrdinal,Node> > getPreconditioner(){return prec_;}
 
  size_t getNodeSmootherComplexity() const { return Teuchos::OrdinalTraits<size_t>::invalid(); };
 
};  // class StratimikosSmoother
 
template <class LocalOrdinal, class GlobalOrdinal, class Node>
struct StratimikosSmoother<double, LocalOrdinal, GlobalOrdinal, Node> : public SmootherPrototype<double, LocalOrdinal, GlobalOrdinal, Node> {
  typedef double Scalar;
#undef MUELU_STRATIMIKOSSMOOTHER_SHORT
#include "MueLu_UseShortNames.hpp"
 
  StratimikosSmoother(const std::string type, const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
 
  virtual ~StratimikosSmoother() = default;
 
 
  void SetParameterList(const Teuchos::ParameterList& paramList);
 
 
 
  void DeclareInput(Level& currentLevel) const;
 
 
 
 
  void Setup(Level& currentLevel);
 
  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
 
 
 
 
  RCP<SmootherPrototype> Copy() const;
 
 
 
 
  std::string description() const;
 
  // using MueLu::Describable::describe; // overloading, not hiding
  // void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const
  void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
 
 
  // RCP<Ifpack2::Preconditioner<Scalar,LocalOrdinal,GlobalOrdinal,Node> > getPreconditioner(){return prec_;}
 
  size_t getNodeSmootherComplexity() const;
 
 private:
  void SetupStratimikos(Level& currentLevel);
  void ExperimentalDropVertConnections(RCP<Matrix>& filteredA, Level& currentLevel);
 
 
  std::string type_;
 
  Teuchos::RCP<Thyra::LinearOpWithSolveBase<Scalar> > solver_;
 
  RCP<Matrix> A_;
 
  bool recurMgOnFilteredA_ = false;
};  // class StratimikosSmoother
 
}  // namespace MueLu
 
#define MUELU_STRATIMIKOSSMOOTHER_SHORT
#endif  // HAVE_MUELU_STRATIMIKOS
#endif  // MUELU_STRATIMIKOSSMOOTHER_DECL_HPP