MueLu_BlockedRAPFactory_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_BLOCKEDRAPFACTORY_DECL_HPP
#define MUELU_BLOCKEDRAPFACTORY_DECL_HPP

#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_CrsMatrix_fwd.hpp>
#include <Xpetra_BlockedCrsMatrix_fwd.hpp>
#include <Xpetra_MatrixFactory_fwd.hpp>

#include "MueLu_ConfigDefs.hpp"
#include "MueLu_RAPFactory_fwd.hpp"

#include "MueLu_Level_fwd.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_PerfUtils_fwd.hpp"
#include "MueLu_TwoLevelFactoryBase.hpp"

namespace MueLu {
template <class Scalar        = DefaultScalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class BlockedRAPFactory : public TwoLevelFactoryBase {
#undef MUELU_BLOCKEDRAPFACTORY_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  BlockedRAPFactory();

  virtual ~BlockedRAPFactory() = default;



  RCP<const ParameterList> GetValidParameterList() const override;

  void DeclareInput(Level &fineLevel, Level &coarseLevel) const override;



  void Build(Level &fineLevel, Level &coarseLevel) const override;



  void SetRepairZeroDiagonal(bool const &repair) {
    repairZeroDiagonals_ = repair;
    if (repair) checkAc_ = true;  // make sure that plausibility check is performed. Otherwise SetRepairZeroDiagonal(true) has no effect.
  }

  void SetPlausibilityCheck(bool const &check) {
    checkAc_ = check;
  }


  void AddTransferFactory(const RCP<const FactoryBase> &factory);

  // TODO add a function to remove a specific transfer factory?

  size_t NumTransferFactories() const { return transferFacts_.size(); }


 private:
  static void CheckMainDiagonal(RCP<BlockedCrsMatrix> &bAc, bool repairZeroDiagonals = false);

  bool checkAc_;

  bool repairZeroDiagonals_;


  std::vector<RCP<const FactoryBase> > transferFacts_;


};  // class BlockedRAPFactory

}  // namespace MueLu

#define MUELU_BLOCKEDRAPFACTORY_SHORT
#endif  // MUELU_BLOCKEDRAPFACTORY_DECL_HPP