MueLu_BlockedJacobiSmoother_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_BLOCKEDJACOBISMOOTHER_DECL_HPP_
#define MUELU_BLOCKEDJACOBISMOOTHER_DECL_HPP_

#include "MueLu_ConfigDefs.hpp"

#include <Teuchos_ParameterList.hpp>

#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_BlockedCrsMatrix_fwd.hpp>
#include <Xpetra_ReorderedBlockedCrsMatrix_fwd.hpp>
#include <Xpetra_MultiVectorFactory_fwd.hpp>
#include <Xpetra_MapExtractor_fwd.hpp>

#include "MueLu_BlockedJacobiSmoother_fwd.hpp"

#include "MueLu_SmootherPrototype.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_FactoryManagerBase_fwd.hpp"
#include "MueLu_SmootherBase_fwd.hpp"

namespace MueLu {

// ToDo (mayr) Inherit from common base class with BlockedGaussSeidelSmoother
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 BlockedJacobiSmoother : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
  typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MapExtractorClass;

#undef MUELU_BLOCKEDJACOBISMOOTHER_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  BlockedJacobiSmoother();

  virtual ~BlockedJacobiSmoother();


  RCP<const ParameterList> GetValidParameterList() const;

  void DeclareInput(Level &currentLevel) const;

  // void AddFactoryManager(RCP<const FactoryManagerBase> FactManager);

  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos);




  void Setup(Level &currentLevel);

  void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero = false) const;

  RCP<SmootherPrototype> Copy() const;



  std::string description() const;

  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;

  size_t getNodeSmootherComplexity() const;


 private:
  std::string type_;

  std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;

  std::vector<Teuchos::RCP<const SmootherBase> > Inverse_;

  std::vector<bool> bIsBlockedOperator_;

  RCP<FactoryBase> AFact_;

  RCP<Matrix> A_;

  RCP<const MapExtractorClass> rangeMapExtractor_;

  RCP<const MapExtractorClass> domainMapExtractor_;
};  // class BlockedJacobiSmoother

}  // namespace MueLu

#define MUELU_BLOCKEDJACOBISMOOTHER_SHORT

#endif /* MUELU_BLOCKEDJACOBISMOOTHER_DECL_HPP_ */