MueLu_SmootherFactory_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_SMOOTHERFACTORY_DECL_HPP
#define MUELU_SMOOTHERFACTORY_DECL_HPP

#include "MueLu_ConfigDefs.hpp"
#include "MueLu_SmootherFactory_fwd.hpp"

#include "MueLu_SmootherFactoryBase.hpp"

#include "MueLu_Level_fwd.hpp"
#include "MueLu_SmootherPrototype_fwd.hpp"
#include "MueLu_SmootherBase_fwd.hpp"

namespace MueLu {

template <class Scalar        = double,
          class LocalOrdinal  = int,
          class GlobalOrdinal = LocalOrdinal,
          class Node          = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class SmootherFactory : public SmootherFactoryBase {
 public:
  typedef Scalar scalar_type;
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;

 private:
#undef MUELU_SMOOTHERFACTORY_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  // Note: Teuchos::null as parameter allowed (= no smoother)
  // Note: precondition: input smoother must not be Setup()
  SmootherFactory(RCP<SmootherPrototype> preAndPostSmootherPrototype = Teuchos::null);

  SmootherFactory(RCP<SmootherPrototype> preSmootherPrototype, RCP<SmootherPrototype> postSmootherPrototype);

  virtual ~SmootherFactory();



  void SetSmootherPrototypes(RCP<SmootherPrototype> preAndPostSmootherPrototype);

  void SetSmootherPrototypes(RCP<SmootherPrototype> preSmootherPrototype, RCP<SmootherPrototype> postSmootherPrototype);

  void GetSmootherPrototypes(RCP<SmootherPrototype>& preSmootherPrototype, RCP<SmootherPrototype>& postSmootherPrototype) const;



  RCP<const ParameterList> GetValidParameterList() const;

  void DeclareInput(Level& currentLevel) const;




  void Build(Level& currentLevel) const;

  void BuildSmoother(Level& currentLevel, const PreOrPost preOrPost = BOTH) const;  // Build()




  std::string description() const;

  using MueLu::Describable::describe;  // overloading, not hiding
  void describe(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;


 private:
  RCP<SmootherPrototype> preSmootherPrototype_;
  RCP<SmootherPrototype> postSmootherPrototype_;

  void CheckPrototypes() const;


};  // class SmootherFactory

}  // namespace MueLu

// TODO: doc: setup done twice if PostSmoother object != PreSmoother object and no adv. reused capability
#define MUELU_SMOOTHERFACTORY_SHORT
#endif  // MUELU_SMOOTHERFACTORY_DECL_HPP