|
Tpetra Matrix/Vector Services Version of the Day
|
A class for partitioning distributed objects. More...
#include <Tpetra_Map_decl.hpp>
Inherits Describable.
Public Member Functions | |
Constructor/Destructor Methods | |
| Map (global_size_t numGlobalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=GloballyDistributed, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode()) | |
| Map constructor with Tpetra-defined contiguous uniform distribution. The elements are distributed among nodes so that the subsets of global elements are non-overlapping and contiguous and as evenly distributed across the nodes as possible. | |
| Map (global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode()) | |
| Map constructor with a user-defined contiguous distribution. The elements are distributed among the nodes so that the subsets of global elements are non-overlapping and contiguous. | |
| Map (global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode()) | |
| Map constructor with user-defined non-contiguous (arbitrary) distribution. | |
| ~Map () | |
| Map destructor. | |
Map Attribute Methods | |
| global_size_t | getGlobalNumElements () const |
| Returns the number of elements in this Map. | |
| size_t | getNodeNumElements () const |
| Returns the number of elements belonging to the calling node. | |
| GlobalOrdinal | getIndexBase () const |
| Returns the index base for this Map. | |
| LocalOrdinal | getMinLocalIndex () const |
| Returns minimum local index. | |
| LocalOrdinal | getMaxLocalIndex () const |
| Returns maximum local index. | |
| GlobalOrdinal | getMinGlobalIndex () const |
| Returns minimum global index owned by this node. | |
| GlobalOrdinal | getMaxGlobalIndex () const |
| Returns maximum global index owned by this node. | |
| GlobalOrdinal | getMinAllGlobalIndex () const |
| Return the minimum global index over all nodes. | |
| GlobalOrdinal | getMaxAllGlobalIndex () const |
| Return the maximum global index over all nodes. | |
| LocalOrdinal | getLocalElement (GlobalOrdinal globalIndex) const |
| Return the local index for a given global index. | |
| GlobalOrdinal | getGlobalElement (LocalOrdinal localIndex) const |
| Return the global index for a given local index. | |
| LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const |
| Returns the node IDs and corresponding local indices for a given list of global indices. | |
| LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const |
| Returns the node IDs for a given list of global indices. | |
| Teuchos::ArrayView< const GlobalOrdinal > | getNodeElementList () const |
| Return a list of the global indices owned by this node. | |
| bool | isNodeLocalElement (LocalOrdinal localIndex) const |
| Returns true if the local index is valid for this Map on this node; returns false if it isn't. | |
| bool | isNodeGlobalElement (GlobalOrdinal globalIndex) const |
| Returns true if the global index is found in this Map on this node; returns false if it isn't. | |
| bool | isContiguous () const |
| Returns true if this Map is distributed contiguously; returns false otherwise. | |
| bool | isDistributed () const |
| Returns true if this Map is distributed across more than one node; returns false otherwise. | |
Boolean Tests | |
| bool | isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const |
Returns true if map is compatible with this Map. | |
| bool | isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const |
Returns true if map is identical to this Map. | |
| const Teuchos::RCP< const Teuchos::Comm< int > > & | getComm () const |
| Get the Comm object for this Map. | |
| const Teuchos::RCP< Node > & | getNode () const |
| Get the Node object for this Map. | |
| std::string | description () const |
| Return a simple one-line description of this object. | |
| void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=verbLevel_default) const |
Print the object with some verbosity level to a FancyOStream object. | |
Related Functions | |
(Note that these are not member functions.) | |
| template<class LocalOrdinal , class GlobalOrdinal > | |
| Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Kokkos::DefaultNode::DefaultNodeType > > | createLocalMap (size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm) |
| Non-member function to create a locally replicated Map with the default node. | |
| template<class LocalOrdinal , class GlobalOrdinal , class Node > | |
| Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | createLocalMapWithNode (size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node) |
| Non-member function to create a locally replicated Map with a specified node. | |
| template<class LocalOrdinal , class GlobalOrdinal , class Node > | |
| Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | createUniformContigMapWithNode (global_size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node) |
| Non-member function to create a uniform, contiguous Map with a user-specified node. | |
| template<class LocalOrdinal , class GlobalOrdinal > | |
| Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Kokkos::DefaultNode::DefaultNodeType > > | createUniformContigMap (global_size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm) |
| Non-member function to create a uniform, contiguous Map with the default node. | |
| template<class LocalOrdinal , class GlobalOrdinal > | |
| Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Kokkos::DefaultNode::DefaultNodeType > > | createContigMap (global_size_t numElements, size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm) |
| Non-member function to create a (potentially) non-uniform, contiguous Map with the default node. | |
| template<class LocalOrdinal , class GlobalOrdinal , class Node > | |
| Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | createContigMapWithNode (global_size_t numElements, size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node) |
| Non-member function to create a (potentially) non-uniform, contiguous Map with a user-specified node. | |
| template<class LocalOrdinal , class GlobalOrdinal , class Node > | |
| Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | createWeightedContigMapWithNode (int thisNodeWeight, global_size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node) |
| Non-member function to create a contiguous Map with user-defined weights and a user-specified node. | |
| template<class LocalOrdinal , class GlobalOrdinal , class Node > | |
| bool | operator== (const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map1, const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map2) |
Returns true if map is identical to this map. Implemented in Tpetra::Map::isSameAs(). | |
| template<class LocalOrdinal , class GlobalOrdinal , class Node > | |
| bool | operator!= (const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map1, const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map2) |
Returns true if map is not identical to this map. Implemented in Tpetra::Map::isSameAs(). | |
A class for partitioning distributed objects.
This class is templated on LocalOrdinal and GlobalOrdinal. The GlobalOrdinal type, if omitted, defaults to the LocalOrdinal type.
Definition at line 56 of file Tpetra_Map_decl.hpp.
| Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::Map | ( | global_size_t | numGlobalElements, |
| GlobalOrdinal | indexBase, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| LocalGlobal | lg = GloballyDistributed, |
||
| const Teuchos::RCP< Node > & | node = Kokkos::DefaultNode::getDefaultNode() |
||
| ) |
Map constructor with Tpetra-defined contiguous uniform distribution. The elements are distributed among nodes so that the subsets of global elements are non-overlapping and contiguous and as evenly distributed across the nodes as possible.
Definition at line 61 of file Tpetra_Map_def.hpp.
| Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::Map | ( | global_size_t | numGlobalElements, |
| size_t | numLocalElements, | ||
| GlobalOrdinal | indexBase, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| const Teuchos::RCP< Node > & | node = Kokkos::DefaultNode::getDefaultNode() |
||
| ) |
Map constructor with a user-defined contiguous distribution. The elements are distributed among the nodes so that the subsets of global elements are non-overlapping and contiguous.
If numGlobalElements == Teuchos::OrdinalTraits<global_size_t>::invalid(), it will be computed via a global communication. Otherwise, it must be equal to the sum of the local elements across all nodes. This will only be verified if Trilinos was compiled with --enable-teuchos-debug. If this verification fails, a std::invalid_argument exception will be thrown.
Definition at line 206 of file Tpetra_Map_def.hpp.
| Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::Map | ( | global_size_t | numGlobalElements, |
| const Teuchos::ArrayView< const GlobalOrdinal > & | elementList, | ||
| GlobalOrdinal | indexBase, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| const Teuchos::RCP< Node > & | node = Kokkos::DefaultNode::getDefaultNode() |
||
| ) |
Map constructor with user-defined non-contiguous (arbitrary) distribution.
If numGlobalElements == Teuchos::OrdinalTraits<global_size_t>::invalid(), it will be computed via a global communication. Otherwise, it must be equal to the sum of the local elements across all nodes. This will only be verified if Trilinos was compiled with --enable-teuchos-debug. If this verification fails, a std::invalid_argument exception will be thrown.
Definition at line 330 of file Tpetra_Map_def.hpp.
| Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::~Map | ( | ) |
Map destructor.
Definition at line 458 of file Tpetra_Map_def.hpp.
| global_size_t Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumElements | ( | ) | const [inline] |
Returns the number of elements in this Map.
Definition at line 104 of file Tpetra_Map_decl.hpp.
| size_t Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumElements | ( | ) | const [inline] |
Returns the number of elements belonging to the calling node.
Definition at line 107 of file Tpetra_Map_decl.hpp.
| GlobalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase | ( | ) | const [inline] |
Returns the index base for this Map.
Definition at line 110 of file Tpetra_Map_decl.hpp.
| LocalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinLocalIndex | ( | ) | const [inline] |
Returns minimum local index.
Definition at line 113 of file Tpetra_Map_decl.hpp.
| LocalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxLocalIndex | ( | ) | const [inline] |
Returns maximum local index.
Definition at line 116 of file Tpetra_Map_decl.hpp.
| GlobalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinGlobalIndex | ( | ) | const [inline] |
Returns minimum global index owned by this node.
Definition at line 119 of file Tpetra_Map_decl.hpp.
| GlobalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxGlobalIndex | ( | ) | const [inline] |
Returns maximum global index owned by this node.
Definition at line 122 of file Tpetra_Map_decl.hpp.
| GlobalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinAllGlobalIndex | ( | ) | const [inline] |
Return the minimum global index over all nodes.
Definition at line 125 of file Tpetra_Map_decl.hpp.
| GlobalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxAllGlobalIndex | ( | ) | const [inline] |
Return the maximum global index over all nodes.
Definition at line 128 of file Tpetra_Map_decl.hpp.
| LocalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getLocalElement | ( | GlobalOrdinal | globalIndex | ) | const |
Return the local index for a given global index.
If the global index is not owned by this node, returns Teuchos::OrdinalTraits<LocalOrdinal>::invalid().
Definition at line 462 of file Tpetra_Map_def.hpp.
| GlobalOrdinal Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getGlobalElement | ( | LocalOrdinal | localIndex | ) | const |
Return the global index for a given local index.
If the local index is not valid for this node, returns Teuchos::OrdinalTraits<GlobalOrdinal>::invalid().
Definition at line 480 of file Tpetra_Map_def.hpp.
| LookupStatus Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList | ( | const Teuchos::ArrayView< const GlobalOrdinal > & | GIDList, |
| const Teuchos::ArrayView< int > & | nodeIDList, | ||
| const Teuchos::ArrayView< LocalOrdinal > & | LIDList | ||
| ) | const |
Returns the node IDs and corresponding local indices for a given list of global indices.
Definition at line 720 of file Tpetra_Map_def.hpp.
| LookupStatus Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList | ( | const Teuchos::ArrayView< const GlobalOrdinal > & | GIDList, |
| const Teuchos::ArrayView< int > & | nodeIDList | ||
| ) | const |
Returns the node IDs for a given list of global indices.
Definition at line 735 of file Tpetra_Map_def.hpp.
| Teuchos::ArrayView< const GlobalOrdinal > Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getNodeElementList | ( | ) | const |
Return a list of the global indices owned by this node.
Definition at line 604 of file Tpetra_Map_def.hpp.
| bool Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isNodeLocalElement | ( | LocalOrdinal | localIndex | ) | const |
Returns true if the local index is valid for this Map on this node; returns false if it isn't.
Definition at line 493 of file Tpetra_Map_def.hpp.
| bool Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isNodeGlobalElement | ( | GlobalOrdinal | globalIndex | ) | const |
Returns true if the global index is found in this Map on this node; returns false if it isn't.
Definition at line 501 of file Tpetra_Map_def.hpp.
| bool Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isContiguous | ( | ) | const |
Returns true if this Map is distributed contiguously; returns false otherwise.
Definition at line 513 of file Tpetra_Map_def.hpp.
| bool Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isDistributed | ( | ) | const |
Returns true if this Map is distributed across more than one node; returns false otherwise.
Definition at line 622 of file Tpetra_Map_def.hpp.
| bool Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isCompatible | ( | const Map< LocalOrdinal, GlobalOrdinal, Node > & | map | ) | const |
Returns true if map is compatible with this Map.
Definition at line 518 of file Tpetra_Map_def.hpp.
| bool Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isSameAs | ( | const Map< LocalOrdinal, GlobalOrdinal, Node > & | map | ) | const |
Returns true if map is identical to this Map.
Definition at line 538 of file Tpetra_Map_def.hpp.
| const Teuchos::RCP< const Teuchos::Comm< int > > & Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getComm | ( | ) | const |
Get the Comm object for this Map.
Definition at line 750 of file Tpetra_Map_def.hpp.
| const Teuchos::RCP< Node > & Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getNode | ( | ) | const |
Get the Node object for this Map.
Definition at line 756 of file Tpetra_Map_def.hpp.
| std::string Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::description | ( | ) | const |
Return a simple one-line description of this object.
Definition at line 627 of file Tpetra_Map_def.hpp.
| void Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::describe | ( | Teuchos::FancyOStream & | out, |
| const Teuchos::EVerbosityLevel | verbLevel = verbLevel_default |
||
| ) | const |
Print the object with some verbosity level to a FancyOStream object.
Definition at line 639 of file Tpetra_Map_def.hpp.
| Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Kokkos::DefaultNode::DefaultNodeType > > createLocalMap | ( | size_t | numElements, |
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm | ||
| ) | [related] |
| Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createLocalMapWithNode | ( | size_t | numElements, |
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| const Teuchos::RCP< Node > & | node | ||
| ) | [related] |
| Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createUniformContigMapWithNode | ( | global_size_t | numElements, |
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| const Teuchos::RCP< Node > & | node | ||
| ) | [related] |
| Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Kokkos::DefaultNode::DefaultNodeType > > createUniformContigMap | ( | global_size_t | numElements, |
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm | ||
| ) | [related] |
| Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Kokkos::DefaultNode::DefaultNodeType > > createContigMap | ( | global_size_t | numElements, |
| size_t | localNumElements, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm | ||
| ) | [related] |
| Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createContigMapWithNode | ( | global_size_t | numElements, |
| size_t | localNumElements, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| const Teuchos::RCP< Node > & | node | ||
| ) | [related] |
| Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createWeightedContigMapWithNode | ( | int | thisNodeWeight, |
| global_size_t | numElements, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| const Teuchos::RCP< Node > & | node | ||
| ) | [related] |
| bool operator== | ( | const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > & | map1, |
| const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > & | map2 | ||
| ) | [related] |
Returns true if map is identical to this map. Implemented in Tpetra::Map::isSameAs().
Definition at line 861 of file Tpetra_Map_def.hpp.
| bool operator!= | ( | const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > & | map1, |
| const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > & | map2 | ||
| ) | [related] |
Returns true if map is not identical to this map. Implemented in Tpetra::Map::isSameAs().
Definition at line 867 of file Tpetra_Map_def.hpp.
1.7.4