MueLu_StructuredRAPFactory_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_STRUCTUREDRAPFACTORY_DECL_HPP
#define MUELU_STRUCTUREDRAPFACTORY_DECL_HPP
 
#include <string>
#include <vector>
 
#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_MatrixFactory_fwd.hpp>
#include <Xpetra_MatrixUtils_fwd.hpp>
 
#include "MueLu_ConfigDefs.hpp"
 
#include "MueLu_StructuredRAPFactory_fwd.hpp"
#include "MueLu_RAPFactory_fwd.hpp"
 
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_Level_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 StructuredRAPFactory : public TwoLevelFactoryBase {
#undef MUELU_STRUCTUREDRAPFACTORY_SHORT
#include "MueLu_UseShortNames.hpp"
 
 public:

 
  StructuredRAPFactory();
 
  virtual ~StructuredRAPFactory() = default;



 
  RCP<const ParameterList> GetValidParameterList() const;
 
  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;



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


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

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

 
  // These implementation details must be public because CUDA extended lambdas
  // cannot be enclosed by a private member function or capture a private type.
  struct StencilOffset {
    int x;
    int y;
    int z;
  };
 
  struct FineStencilEntry {
    StencilOffset offset;
    LocalOrdinal rowDof;
    LocalOrdinal columnDof;
    LocalOrdinal entryOrdinal;
  };
 
  struct FineStencilSpec {
    int numDimensions;
    LocalOrdinal dofsPerNode;
    std::vector<StencilOffset> stencilOffsets;
    std::vector<FineStencilEntry> entries;
  };
 
  struct StructuredGraphSpec {
    int numDimensions;
    LocalOrdinal dofsPerNode;
    std::vector<StencilOffset> stencilOffsets;
    std::string description;
  };
 
  void GetStructuredGraph(RCP<Matrix>& Ac, const RCP<Matrix> P,
                          const Teuchos::Array<LocalOrdinal>& lCoarseNodesPerDim,
                          const StructuredGraphSpec& graphSpec) const;
 
  FineStencilSpec DetectFineStencil(
      const Matrix& A, int numDimensions,
      const Teuchos::Array<LocalOrdinal>& lFineNodesPerDim) const;
 
  StructuredGraphSpec DeriveCoarseRAPStencil(
      const FineStencilSpec& fineStencil,
      int interpolationOrder) const;
 
 private:
 
  mutable bool hasDeclaredInput_;



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


 
  StructuredGraphSpec GetStructuredGraphSpec(
      const Matrix& A, const Matrix& P, int numDimensions,
      const Teuchos::Array<LocalOrdinal>& lFineNodesPerDim,
      int interpolationOrder) const;
 
  void ConfigureRAPFactoryDelegate() const;
 
  RCP<const FactoryBase> GetStructuredMetadataFactory(const std::string& varName) const;
 
  mutable RCP<MueLu::RAPFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>> rapFactoryDelegate_;
 
  //}
 
};  // class StructuredRAPFactory
 
}  // namespace MueLu
 
#define MUELU_STRUCTUREDRAPFACTORY_SHORT
#endif  // MUELU_STRUCTUREDRAPFACTORY_DECL_HPP