MueLu_Zoltan2Interface_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_ZOLTAN2INTERFACE_DECL_HPP
#define MUELU_ZOLTAN2INTERFACE_DECL_HPP
 
#include "MueLu_ConfigDefs.hpp"
 
#if defined(HAVE_MUELU_ZOLTAN2) && defined(HAVE_MPI)
 
#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_VectorFactory_fwd.hpp>
 
#include "MueLu_SingleLevelFactoryBase.hpp"
#include "MueLu_Zoltan2Interface_fwd.hpp"
 
#include "MueLu_Level_fwd.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
 
#if defined(HAVE_MUELU_ZOLTAN)
#include "MueLu_ZoltanInterface.hpp"
#endif
 
namespace MueLu {

 
// FIXME: this class should not be templated
template <class Scalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class Zoltan2Interface : public SingleLevelFactoryBase {
#undef MUELU_ZOLTAN2INTERFACE_SHORT
#include "MueLu_UseShortNames.hpp"
 
 public:


  Zoltan2Interface();

  virtual ~Zoltan2Interface() {}
 
  RCP<const ParameterList> GetValidParameterList() const;


  void DeclareInput(Level& currentLevel) const;


  void Build(Level& currentLevel) const;

 
 private:
  RCP<ParameterList> defaultZoltan2Params;
 
};  // class Zoltan2Interface
 
template <class Scalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
struct Zoltan2Utilities {
#undef MUELU_ZOLTAN2INTERFACE_SHORT
#include "MueLu_UseShortNames.hpp"
 
  using real_type             = typename Teuchos::ScalarTraits<SC>::coordinateType;
  using RealValuedMultiVector = typename Xpetra::MultiVector<real_type, LO, GO, NO>;
 
  static RCP<GOVector>
  ComputeDecomposition(int numPartitions, RCP<Matrix>& A, RCP<RealValuedMultiVector> coords, Teuchos::ParameterList& Zoltan2Params, std::string debuggingFile = "");
};
 
}  // namespace MueLu
 
#define MUELU_ZOLTAN2INTERFACE_SHORT
#endif  // if defined(HAVE_MUELU_ZOLTAN2) && defined(HAVE_MPI)
 
#endif  // MUELU_ZOLTAN2INTERFACE_DECL_HPP