MueLu_RefMaxwellSmoother_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_REFMAXWELLSMOOTHER_DECL_HPP
#define MUELU_REFMAXWELLSMOOTHER_DECL_HPP

#include <Teuchos_ParameterList.hpp>

#include <Xpetra_Matrix_fwd.hpp>

#include "MueLu_ConfigDefs.hpp"

#include "MueLu_RefMaxwellSmoother_fwd.hpp"

#include "MueLu_Level_fwd.hpp"
#include "MueLu_SmootherPrototype.hpp"
#include "MueLu_RefMaxwell.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 RefMaxwellSmoother : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_REFMAXWELLSMOOTHER_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  RefMaxwellSmoother(const std::string type, const Teuchos::ParameterList& paramList);

  virtual ~RefMaxwellSmoother() = 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;


  size_t getNodeSmootherComplexity() const;

 private:
  void SetupRefMaxwell(Level& currentLevel);

 private:
  std::string type_;
  std::string cachedDescription_;

  RCP<Operator> op_;

};  // class RefMaxwellSmoother

}  // namespace MueLu

#define MUELU_REFMAXWELLSMOOTHER_SHORT
#endif  // MUELU_REFMAXWELLSMOOTHER_DECL_HPP