40 #ifndef TPETRA_MAP_DECL_HPP
41 #define TPETRA_MAP_DECL_HPP
47 #include "Tpetra_ConfigDefs.hpp"
52 #include "Tpetra_KokkosCompat_DefaultNode.hpp"
53 #include "Kokkos_DualView.hpp"
54 #include "Teuchos_Array.hpp"
55 #include "Teuchos_Comm.hpp"
56 #include "Teuchos_Describable.hpp"
225 template <
class LocalOrdinal,
228 class Map :
public Teuchos::Describable {
328 const Teuchos::RCP<
const Teuchos::Comm<int> > &comm,
368 const size_t numLocalElements,
370 const Teuchos::RCP<
const Teuchos::Comm<int> > &comm);
414 const Kokkos::View<const global_ordinal_type*, device_type>& indexList,
416 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
463 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
507 const Teuchos::ArrayView<const global_ordinal_type>& indexList,
509 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
568 return numGlobalElements_;
577 return numLocalElements_;
610 return Tpetra::Details::OrdinalTraits<local_ordinal_type>::invalid ();
713 const Teuchos::ArrayView< int>& nodeIDList,
714 const Teuchos::ArrayView< local_ordinal_type>& LIDList)
const;
741 const Teuchos::ArrayView< int> & nodeIDList)
const;
757 Kokkos::HostSpace> global_indices_array_type;
949 Teuchos::RCP<const Teuchos::Comm<int> >
getComm ()
const;
981 describe (Teuchos::FancyOStream &out,
982 const Teuchos::EVerbosityLevel verbLevel =
983 Teuchos::Describable::verbLevel_default)
const;
1036 Teuchos::RCP<const Map<local_ordinal_type, global_ordinal_type, Node> >
1066 Teuchos::RCP<const Map<local_ordinal_type, global_ordinal_type, Node> >
1076 localDescribeToString (
const Teuchos::EVerbosityLevel vl)
const;
1085 void setupDirectory ()
const;
1101 bool checkIsDist()
const;
1111 initialNonuniformDebugCheck(
1112 const char errorMessagePrefix[],
1114 const size_t numLocalElements,
1116 const Teuchos::RCP<
const Teuchos::Comm<int>>& comm)
const;
1119 initWithNonownedHostIndexList(
1120 const char errorMessagePrefix[],
1125 Kokkos::MemoryUnmanaged>& entryList,
1127 const Teuchos::RCP<
const Teuchos::Comm<int>>& comm);
1130 void lazyPushToHost()
const;
1133 Teuchos::RCP<const Teuchos::Comm<int> > comm_;
1143 size_t numLocalElements_;
1245 Kokkos::HostSpace> lgMapHost_;
1264 global_to_local_table_type glMap_;
1267 typedef ::Tpetra::Details::FixedHashTable<
1269 global_to_local_table_host_type;
1276 mutable global_to_local_table_host_type glMapHost_;
1314 mutable Teuchos::RCP<
1334 template <
class LocalOrdinal,
class GlobalOrdinal>
1335 Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal> >
1337 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
1353 template <
class LocalOrdinal,
class GlobalOrdinal,
class Node>
1354 Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >
1356 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
1366 template <
class LocalOrdinal,
class GlobalOrdinal>
1367 Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal> >
1369 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
1377 template <
class LocalOrdinal,
class GlobalOrdinal,
class Node>
1378 Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >
1380 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
1389 template <
class LocalOrdinal,
class GlobalOrdinal>
1390 Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal> >
1392 const size_t localNumElements,
1393 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
1403 template <
class LocalOrdinal,
class GlobalOrdinal,
class Node>
1404 Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >
1406 const size_t localNumElements,
1407 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
1416 template <
class LocalOrdinal,
class GlobalOrdinal>
1417 Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal> >
1419 const Teuchos::RCP<
const Teuchos::Comm<int> >& comm);
1428 template <
class LocalOrdinal,
class GlobalOrdinal,
class Node>
1429 Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal,Node> >
1431 const Teuchos::RCP<
const Teuchos::Comm<int> > &comm);
1445 template<
class LocalOrdinal,
class GlobalOrdinal,
class Node>
1446 Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal,Node> >
1447 createOneToOne (
const Teuchos::RCP<
const Map<LocalOrdinal,GlobalOrdinal,Node> >& M);
1454 template<
class LocalOrdinal,
class GlobalOrdinal,
class Node>
1455 Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal,Node> >
1456 createOneToOne(
const Teuchos::RCP<
const Map<LocalOrdinal,GlobalOrdinal,Node> > &M,
1457 const ::Tpetra::Details::TieBreak<LocalOrdinal,GlobalOrdinal> & tie_break);
1461 #include "Tpetra_Directory_decl.hpp"
1465 template <
class LocalOrdinal,
class GlobalOrdinal,
class Node>
1472 template <
class LocalOrdinal,
class GlobalOrdinal,
class Node>
1478 #endif // TPETRA_MAP_DECL_HPP
global_ordinal_type getMaxGlobalIndex() const
The maximum global index owned by the calling process.
LO local_ordinal_type
The type of local indices.
virtual ~Map()
Destructor (virtual for memory safety of derived classes).
GO global_ordinal_type
The type of global indices.
bool isSameAs(const Map< local_ordinal_type, global_ordinal_type, Node > &map) const
True if and only if map is identical to this Map.
global_indices_array_type getMyGlobalIndices() const
Return a view of the global indices owned by this process.
bool isContiguous() const
True if this Map is distributed contiguously, else false.
LookupStatus
Return status of Map remote index lookup (getRemoteIndexList()).
size_t getLocalNumElements() const
The number of elements belonging to the calling process.
bool isLocallyFitted(const Map< local_ordinal_type, global_ordinal_type, Node > &map) const
True if and only if map is locally fitted to this Map.
bool isUniform() const
Whether the range of global indices is uniform.
Declaration and definition of the Tpetra::Map class, an implementation detail of Tpetra::Map.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createContigMapWithNode(const global_size_t numElements, const size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Nonmember constructor for a (potentially) nonuniformly distributed, contiguous Map for a user-specifi...
global_indices_array_device_type getMyGlobalIndicesDevice() const
Return a view of the global indices owned by this process on the Map's device.
bool isDistributed() const
Whether this Map is globally distributed or locally replicated.
Teuchos::RCP< const Map< local_ordinal_type, global_ordinal_type, Node > > removeEmptyProcesses() const
Advanced methods.
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Accessors for the Teuchos::Comm and Kokkos Node objects.
bool operator!=(const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map1, const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map2)
True if map1 is not the same as (in the sense of isSameAs()) map2, else false.
typename device_type::memory_space memory_space
The Kokkos memory space.
local_ordinal_type getMinLocalIndex() const
The minimum local index.
"Local" part of Map suitable for Kokkos kernels.
Teuchos::ArrayView< const global_ordinal_type > getLocalElementList() const
Return a NONOWNING view of the global indices owned by this process.
size_t global_size_t
Global size_t object.
bool isCompatible(const Map< local_ordinal_type, global_ordinal_type, Node > &map) const
True if and only if map is compatible with this Map.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createOneToOne(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &M)
Nonmember constructor for a contiguous Map with user-defined weights and a user-specified, possibly nondefault Kokkos Node type.
global_ordinal_type getIndexBase() const
The index base for this Map.
global_ordinal_type getGlobalElement(local_ordinal_type localIndex) const
The global index corresponding to the given local index.
Forward declaration of Tpetra::Directory.
local_ordinal_type getMaxLocalIndex() const
The maximum local index on the calling process.
bool isNodeLocalElement(local_ordinal_type localIndex) const
Whether the given local index is valid for this Map on the calling process.
Teuchos::RCP< const Map< local_ordinal_type, global_ordinal_type, Node > > replaceCommWithSubset(const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const
Replace this Map's communicator with a subset communicator.
bool isNodeGlobalElement(global_ordinal_type globalIndex) const
Whether the given global index is owned by this Map on the calling process.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal > > createUniformContigMap(const global_size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Non-member constructor for a uniformly distributed, contiguous Map with the default Kokkos Node...
bool operator==(const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map1, const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map2)
True if map1 is the same as (in the sense of isSameAs()) map2, else false.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal > > createContigMap(const global_size_t numElements, const size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Non-member constructor for a (potentially) non-uniformly distributed, contiguous Map using the defaul...
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal > > createLocalMap(const size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Nonmember constructor for a locally replicated Map with the default Kokkos Node.
local_map_type getLocalMap() const
Get the local Map for Kokkos kernels.
global_ordinal_type getMinGlobalIndex() const
The minimum global index owned by the calling process.
typename device_type::execution_space execution_space
The Kokkos execution space.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createUniformContigMapWithNode(const global_size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Non-member constructor for a uniformly distributed, contiguous Map with a user-specified Kokkos Node...
A parallel distribution of indices over processes.
global_ordinal_type getMaxAllGlobalIndex() const
The maximum global index over all processes in the communicator.
local_ordinal_type getLocalElement(global_ordinal_type globalIndex) const
The local index corresponding to the given global index.
Implement mapping from global ID to process ID and local ID.
bool isOneToOne() const
Whether the Map is one to one.
bool locallySameAs(const Map< local_ordinal_type, global_ordinal_type, node_type > &map) const
Is this Map locally the same as the input Map?
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createLocalMapWithNode(const size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Nonmember constructor for a locally replicated Map with a specified Kokkos Node.
Map & operator=(const Map< local_ordinal_type, global_ordinal_type, node_type > &)=default
Copy assigment (shallow copy).
typename node_type::device_type device_type
This class' Kokkos::Device specialization.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal > > createNonContigMap(const Teuchos::ArrayView< const GlobalOrdinal > &elementList, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Nonmember constructor for a non-contiguous Map using the default Kokkos::Device type.
LocalGlobal
Enum for local versus global allocation of Map entries.
::Tpetra::Details::LocalMap< local_ordinal_type, global_ordinal_type, device_type > local_map_type
Type of the "local" Map.
LookupStatus getRemoteIndexList(const Teuchos::ArrayView< const global_ordinal_type > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< local_ordinal_type > &LIDList) const
Return the process ranks and corresponding local indices for the given global indices.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Describe this object in a human-readable way to the given output stream.
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createNonContigMapWithNode(const Teuchos::ArrayView< const GlobalOrdinal > &elementList, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
Nonmember constructor for a noncontiguous Map with a user-specified, possibly nondefault Kokkos Node ...
node_type node_type
Legacy typedef that will go away at some point.
global_ordinal_type getMinAllGlobalIndex() const
The minimum global index over all processes in the communicator.
Forward declaration of Tpetra::Map.
global_size_t getGlobalNumElements() const
The number of elements in this Map.
Forward declaration for Tpetra::TieBreak.
std::string description() const
Implementation of Teuchos::Describable.
Map()
Default constructor (that does nothing).