MueLu_PermutingSmoother_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

/*
 * MueLu_PermutingSmoother_decl.hpp
 *
 *  Created on: Nov 28, 2012
 *      Author: wiesner
 */

#ifndef MUELU_PERMUTINGSMOOTHER_DECL_HPP
#define MUELU_PERMUTINGSMOOTHER_DECL_HPP

#include <Teuchos_ParameterList.hpp>
#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_Vector_fwd.hpp>
#include <Xpetra_VectorFactory_fwd.hpp>
#include <Xpetra_MultiVector_fwd.hpp>
#include <Xpetra_MultiVectorFactory_fwd.hpp>

#include "MueLu_ConfigDefs.hpp"

#include "MueLu_SmootherPrototype.hpp"
#include "MueLu_TrilinosSmoother_fwd.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_PermutationFactory_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 PermutingSmoother : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_PERMUTINGSMOOTHER_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  PermutingSmoother(std::string const& mapName, const RCP<const FactoryBase>& mapFact, std::string const& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList(), LO const& overlap = 0, RCP<FactoryBase> permFact = Teuchos::null);

  virtual ~PermutingSmoother();



  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 s_->getNodeSmootherComplexity(); }


 private:
  std::string type_;

  LO overlap_;

  RCP<FactoryBase> permFact_;

  RCP<Matrix> permQT_;

  RCP<Matrix> permP_;

  Teuchos::RCP<Matrix> diagScalingOp_;

  //
  // Underlying Smoother
  //

  RCP<SmootherPrototype> s_;  // TrilinosSmoother object

};  // class PermutingSmoother

}  // namespace MueLu

#define MUELU_PERMUTINGSMOOTHER_SHORT
#endif /* MUELU_PERMUTINGSMOOTHER_DECL_HPP */