Xpetra_TpetraMap_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//             Xpetra: A linear algebra interface package
//
// Copyright 2012 NTESS and the Xpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef XPETRA_TPETRAMAP_DECL_HPP
#define XPETRA_TPETRAMAP_DECL_HPP

/* this file is automatically generated - do not edit (see script/tpetra.py) */

#include "Xpetra_TpetraConfigDefs.hpp"

#include <Tpetra_Map.hpp>

#include "Xpetra_Map_decl.hpp"
#include "Xpetra_Utils.hpp"

#include "Xpetra_Exceptions.hpp"

namespace Xpetra {

template <class LocalOrdinal, class GlobalOrdinal, class Node>
const RCP<Map<LocalOrdinal, GlobalOrdinal, Node> > toXpetraNonConst(const RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > &map);

template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class TpetraMap
  : public virtual Map<LocalOrdinal, GlobalOrdinal, Node> {
 public:
  typedef typename Map<LocalOrdinal, GlobalOrdinal, Node>::global_indices_array_device_type global_indices_array_device_type;




  TpetraMap(global_size_t numGlobalElements,
            GlobalOrdinal indexBase,
            const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
            LocalGlobal lg = GloballyDistributed);


  TpetraMap(global_size_t numGlobalElements,
            size_t numLocalElements,
            GlobalOrdinal indexBase,
            const Teuchos::RCP<const Teuchos::Comm<int> > &comm);


  TpetraMap(global_size_t numGlobalElements,
            const Teuchos::ArrayView<const GlobalOrdinal> &elementList,
            GlobalOrdinal indexBase,
            const Teuchos::RCP<const Teuchos::Comm<int> > &comm);

#ifdef HAVE_XPETRA_TPETRA
  TpetraMap(global_size_t numGlobalElements,
            const Kokkos::View<const GlobalOrdinal *, typename Node::device_type> &indexList,
            GlobalOrdinal indexBase,
            const Teuchos::RCP<const Teuchos::Comm<int> > &comm);
#endif

  ~TpetraMap();



  global_size_t getGlobalNumElements() const;

  size_t getLocalNumElements() const;

  GlobalOrdinal getIndexBase() const;

  LocalOrdinal getMinLocalIndex() const;

  LocalOrdinal getMaxLocalIndex() const;

  GlobalOrdinal getMinGlobalIndex() const;

  GlobalOrdinal getMaxGlobalIndex() const;

  GlobalOrdinal getMinAllGlobalIndex() const;

  GlobalOrdinal getMaxAllGlobalIndex() const;

  LocalOrdinal getLocalElement(GlobalOrdinal globalIndex) const;

  GlobalOrdinal getGlobalElement(LocalOrdinal localIndex) const;

  LookupStatus getRemoteIndexList(const Teuchos::ArrayView<const GlobalOrdinal> &GIDList, const Teuchos::ArrayView<int> &nodeIDList, const Teuchos::ArrayView<LocalOrdinal> &LIDList) const;

  LookupStatus getRemoteIndexList(const Teuchos::ArrayView<const GlobalOrdinal> &GIDList, const Teuchos::ArrayView<int> &nodeIDList) const;

  Teuchos::ArrayView<const GlobalOrdinal> getLocalElementList() const;

  global_indices_array_device_type getMyGlobalIndicesDevice() const;




  bool isNodeLocalElement(LocalOrdinal localIndex) const;

  bool isNodeGlobalElement(GlobalOrdinal globalIndex) const;

  bool isContiguous() const;

  bool isDistributed() const;

  bool isCompatible(const Map<LocalOrdinal, GlobalOrdinal, Node> &map) const;

  bool isSameAs(const Map<LocalOrdinal, GlobalOrdinal, Node> &map) const;




  Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;




  std::string description() const;

  void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default) const;

  RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > removeEmptyProcesses() const;
  RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > replaceCommWithSubset(const Teuchos::RCP<const Teuchos::Comm<int> > &newComm) const;




  TpetraMap(const Teuchos::RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > &map);

  UnderlyingLib lib() const;

  RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > getTpetra_Map() const;

#ifdef HAVE_XPETRA_TPETRA
  using local_map_type = typename Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type;
  local_map_type getLocalMap() const;
#endif


 protected:
  RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > map_;

};  // TpetraMap class

template <class LocalOrdinal, class GlobalOrdinal, class Node>
const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> &toTpetra(const Map<LocalOrdinal, GlobalOrdinal, Node> &map) {
  // TODO: throw exception
  const TpetraMap<LocalOrdinal, GlobalOrdinal, Node> &tpetraMap = dynamic_cast<const TpetraMap<LocalOrdinal, GlobalOrdinal, Node> &>(*map.getMap());
  return *tpetraMap.getTpetra_Map();
}

template <class LocalOrdinal, class GlobalOrdinal, class Node>
const RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > toTpetra(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &map) {
  typedef TpetraMap<LocalOrdinal, GlobalOrdinal, Node> TpetraMapClass;
  if (map != Teuchos::null) {
    XPETRA_RCP_DYNAMIC_CAST(const TpetraMapClass, map->getMap(), tpetraMap, "toTpetra");
    return tpetraMap->getTpetra_Map();
  }
  return Teuchos::null;
}

// In some cases (for instance, in MueLu adapter to Tpetra operator), we need to return a reference. This is only possible if
// we assume that the map argument is nonzero
template <class LocalOrdinal, class GlobalOrdinal, class Node>
const RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > toTpetraNonZero(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &map) {
  TEUCHOS_TEST_FOR_EXCEPTION(map.is_null(), std::invalid_argument, "map must be nonzero");
  typedef TpetraMap<LocalOrdinal, GlobalOrdinal, Node> TpetraMapClass;
  XPETRA_RCP_DYNAMIC_CAST(const TpetraMapClass, map->getMap(), tpetraMap, "toTpetra");
  return tpetraMap->getTpetra_Map();
}

template <class LocalOrdinal, class GlobalOrdinal, class Node>
const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > toXpetra(const RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > &map) {
  if (!map.is_null())
    return rcp(new TpetraMap<LocalOrdinal, GlobalOrdinal, Node>(map));

  return Teuchos::null;
}

template <class LocalOrdinal, class GlobalOrdinal, class Node>
const RCP<Map<LocalOrdinal, GlobalOrdinal, Node> > toXpetraNonConst(const RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > &map) {
  if (!map.is_null())
    return rcp(new TpetraMap<LocalOrdinal, GlobalOrdinal, Node>(map));

  return Teuchos::null;
}

namespace useTpetra {

template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<const TpetraMap<LocalOrdinal, GlobalOrdinal, Node> >
createLocalMapWithNode(size_t numElements, const Teuchos::RCP<const Teuchos::Comm<int> > &comm) {
  XPETRA_MONITOR("useTpetra::createLocalMapWithNode");

  return rcp(new TpetraMap<LocalOrdinal, GlobalOrdinal, Node>(Tpetra::createLocalMapWithNode<LocalOrdinal, GlobalOrdinal, Node>(numElements, comm)));
}

template <class LocalOrdinal, class GlobalOrdinal>
Teuchos::RCP<const TpetraMap<LocalOrdinal, GlobalOrdinal, typename Tpetra::Map<>::node_type> >
createContigMap(global_size_t numElements, size_t localNumElements, const Teuchos::RCP<const Teuchos::Comm<int> > &comm) {
  XPETRA_MONITOR("useTpetra::createContigMap");

  return rcp(new TpetraMap<LocalOrdinal, GlobalOrdinal, typename Tpetra::Map<>::node_type>(Tpetra::createContigMap<LocalOrdinal, GlobalOrdinal, typename Tpetra::Map<>::node_type>(numElements, localNumElements, comm)));
}

template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<const TpetraMap<LocalOrdinal, GlobalOrdinal, Node> >
createContigMapWithNode(global_size_t numElements, size_t localNumElements,
                        const Teuchos::RCP<const Teuchos::Comm<int> > &comm) {
  XPETRA_MONITOR("useTpetra::createContigMap");
  return rcp(new TpetraMap<LocalOrdinal, GlobalOrdinal, Node>(Tpetra::createContigMapWithNode<LocalOrdinal, GlobalOrdinal, Node>(numElements, localNumElements, comm)));
}
}  // namespace useTpetra

#define XPETRA_TPETRAMAP_SHORT
}  // namespace Xpetra
#endif  // XPETRA_TPETRAMAP_DECL_HPP