MueLu_ProjectorSmoother_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_PROJECTORSMOOTHER_DECL_HPP
#define MUELU_PROJECTORSMOOTHER_DECL_HPP

#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_MultiVector_fwd.hpp>

#include "MueLu_ConfigDefs.hpp"

#include "MueLu_SmootherPrototype.hpp"
#include "MueLu_Utilities_fwd.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 ProjectorSmoother : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_PROJECTORSMOOTHER_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  ProjectorSmoother(RCP<SmootherPrototype> coarseSolver);

  virtual ~ProjectorSmoother();



  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 print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;

  size_t getNodeSmootherComplexity() const { return coarseSolver_->getNodeSmootherComplexity(); }


 private:
  RCP<MultiVector> Borth_;
  RCP<SmootherPrototype> coarseSolver_;

};  // class ProjectorSmoother

}  // namespace MueLu

#define MUELU_PROJECTORSMOOTHER_SHORT
#endif  // MUELU_PROJECTORSMOOTHER_DECL_HPP