#include <Xpetra_StridedTpetraMap.hpp>
Private Member Functions | |
| bool | CheckConsistency () |
Constructor/Destructor Methods | |
| StridedTpetraMap (global_size_t numGlobalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0, LocalGlobal lg=GloballyDistributed, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode()) | |
| Map constructor with Tpetra-defined contiguous uniform distribution. | |
| StridedTpetraMap (global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode()) | |
| Map constructor with a user-defined contiguous distribution. | |
| StridedTpetraMap (global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalOrdinal stridedBlockId=-1, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode()) | |
| Map constructor with user-defined non-contiguous (arbitrary) distribution. | |
| ~StridedTpetraMap () | |
| 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=Teuchos::Describable::verbLevel_default) const |
| Print the object with some verbosity level to a FancyOStream object. | |
Xpetra specific | |
| StridedTpetraMap (const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &map, std::vector< size_t > &stridingInfo, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0) | |
| TpetraMap constructor to wrap a Tpetra::Map object. | |
| UnderlyingLib | lib () const |
| Get the library used by this object (Tpetra or Epetra?) | |
Definition at line 64 of file Xpetra_StridedTpetraMap.hpp.
| Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::StridedTpetraMap | ( | global_size_t | numGlobalElements, |
| GlobalOrdinal | indexBase, | ||
| std::vector< size_t > & | stridingInfo, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| LocalOrdinal | stridedBlockId = -1, |
||
| GlobalOrdinal | offset = 0, |
||
| LocalGlobal | lg = GloballyDistributed, |
||
| const Teuchos::RCP< Node > & | node = Kokkos::DefaultNode::getDefaultNode() |
||
| ) | [inline] |
Map constructor with Tpetra-defined contiguous uniform distribution.
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.
If numGlobalElements == Teuchos::OrdinalTraits<global_size_t>::invalid(), the number of global elements 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' Teuchos package was built with debug support (CMake Boolean option TEUCHOS_ENABLE_DEBUG=ON). If verification fails, a std::invalid_argument exception will be thrown.
Definition at line 91 of file Xpetra_StridedTpetraMap.hpp.
| Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::StridedTpetraMap | ( | global_size_t | numGlobalElements, |
| size_t | numLocalElements, | ||
| GlobalOrdinal | indexBase, | ||
| std::vector< size_t > & | stridingInfo, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| LocalOrdinal | stridedBlockId = -1, |
||
| GlobalOrdinal | offset = 0, |
||
| const Teuchos::RCP< Node > & | node = Kokkos::DefaultNode::getDefaultNode() |
||
| ) | [inline] |
Map constructor with a user-defined contiguous distribution.
Map constructor with a user-defined contiguous distribution.
Map constructor with a user-defined contiguous 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.
If numGlobalElements == Teuchos::OrdinalTraits<global_size_t>::invalid(), the number of global elements 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' Teuchos package was built with debug support (CMake Boolean option TEUCHOS_ENABLE_DEBUG=ON). If verification fails, a std::invalid_argument exception will be thrown.
Definition at line 164 of file Xpetra_StridedTpetraMap.hpp.
| Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::StridedTpetraMap | ( | global_size_t | numGlobalElements, |
| const Teuchos::ArrayView< const GlobalOrdinal > & | elementList, | ||
| GlobalOrdinal | indexBase, | ||
| std::vector< size_t > & | stridingInfo, | ||
| const Teuchos::RCP< const Teuchos::Comm< int > > & | comm, | ||
| LocalOrdinal | stridedBlockId = -1, |
||
| const Teuchos::RCP< Node > & | node = Kokkos::DefaultNode::getDefaultNode() |
||
| ) | [inline] |
Map constructor with user-defined non-contiguous (arbitrary) distribution.
createse a strided map using the GIDs in elementList and the striding information provided by user.
Definition at line 228 of file Xpetra_StridedTpetraMap.hpp.
| Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::~StridedTpetraMap | ( | ) | [inline] |
Map destructor.
Definition at line 245 of file Xpetra_StridedTpetraMap.hpp.
| Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::StridedTpetraMap | ( | const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & | map, |
| std::vector< size_t > & | stridingInfo, | ||
| LocalOrdinal | stridedBlockId = -1, |
||
| GlobalOrdinal | offset = 0 |
||
| ) | [inline] |
TpetraMap constructor to wrap a Tpetra::Map object.
Definition at line 345 of file Xpetra_StridedTpetraMap.hpp.
| global_size_t Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumElements | ( | ) | const [inline, virtual] |
Returns the number of elements in this Map.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 253 of file Xpetra_StridedTpetraMap.hpp.
| size_t Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumElements | ( | ) | const [inline, virtual] |
Returns the number of elements belonging to the calling node.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 256 of file Xpetra_StridedTpetraMap.hpp.
| GlobalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase | ( | ) | const [inline, virtual] |
Returns the index base for this Map.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 259 of file Xpetra_StridedTpetraMap.hpp.
| LocalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinLocalIndex | ( | ) | const [inline, virtual] |
Returns minimum local index.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 262 of file Xpetra_StridedTpetraMap.hpp.
| LocalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxLocalIndex | ( | ) | const [inline, virtual] |
Returns maximum local index.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 265 of file Xpetra_StridedTpetraMap.hpp.
| GlobalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinGlobalIndex | ( | ) | const [inline, virtual] |
Returns minimum global index owned by this node.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 268 of file Xpetra_StridedTpetraMap.hpp.
| GlobalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxGlobalIndex | ( | ) | const [inline, virtual] |
Returns maximum global index owned by this node.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 271 of file Xpetra_StridedTpetraMap.hpp.
| GlobalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinAllGlobalIndex | ( | ) | const [inline, virtual] |
Return the minimum global index over all nodes.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 274 of file Xpetra_StridedTpetraMap.hpp.
| GlobalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxAllGlobalIndex | ( | ) | const [inline, virtual] |
Return the maximum global index over all nodes.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 277 of file Xpetra_StridedTpetraMap.hpp.
| LocalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalElement | ( | GlobalOrdinal | globalIndex | ) | const [inline, virtual] |
Return the local index for a given global index.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 280 of file Xpetra_StridedTpetraMap.hpp.
| GlobalOrdinal Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalElement | ( | LocalOrdinal | localIndex | ) | const [inline, virtual] |
Return the global index for a given local index.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 283 of file Xpetra_StridedTpetraMap.hpp.
| LookupStatus Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList | ( | const Teuchos::ArrayView< const GlobalOrdinal > & | GIDList, |
| const Teuchos::ArrayView< int > & | nodeIDList, | ||
| const Teuchos::ArrayView< LocalOrdinal > & | LIDList | ||
| ) | const [inline, virtual] |
Returns the node IDs and corresponding local indices for a given list of global indices.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 286 of file Xpetra_StridedTpetraMap.hpp.
| LookupStatus Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList | ( | const Teuchos::ArrayView< const GlobalOrdinal > & | GIDList, |
| const Teuchos::ArrayView< int > & | nodeIDList | ||
| ) | const [inline, virtual] |
Returns the node IDs for a given list of global indices.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 289 of file Xpetra_StridedTpetraMap.hpp.
| Teuchos::ArrayView< const GlobalOrdinal > Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeElementList | ( | ) | const [inline, virtual] |
Return a list of the global indices owned by this node.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 292 of file Xpetra_StridedTpetraMap.hpp.
| bool Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isNodeLocalElement | ( | LocalOrdinal | localIndex | ) | const [inline, virtual] |
Returns true if the local index is valid for this Map on this node; returns false if it isn't.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 295 of file Xpetra_StridedTpetraMap.hpp.
| bool Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isNodeGlobalElement | ( | GlobalOrdinal | globalIndex | ) | const [inline, virtual] |
Returns true if the global index is found in this Map on this node; returns false if it isn't.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 298 of file Xpetra_StridedTpetraMap.hpp.
| bool Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isContiguous | ( | ) | const [inline, virtual] |
Returns true if this Map is distributed contiguously; returns false otherwise.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 301 of file Xpetra_StridedTpetraMap.hpp.
| bool Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isDistributed | ( | ) | const [inline, virtual] |
Returns true if this Map is distributed across more than one node; returns false otherwise.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 304 of file Xpetra_StridedTpetraMap.hpp.
| bool Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isCompatible | ( | const Map< LocalOrdinal, GlobalOrdinal, Node > & | map | ) | const [inline, virtual] |
Returns true if map is compatible with this Map.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 312 of file Xpetra_StridedTpetraMap.hpp.
| bool Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isSameAs | ( | const Map< LocalOrdinal, GlobalOrdinal, Node > & | map | ) | const [inline, virtual] |
Returns true if map is identical to this Map.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 315 of file Xpetra_StridedTpetraMap.hpp.
| const Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getComm | ( | ) | const [inline, virtual] |
Get the Comm object for this Map.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 323 of file Xpetra_StridedTpetraMap.hpp.
| const Teuchos::RCP< Node > Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNode | ( | ) | const [inline, virtual] |
Get the Node object for this Map.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 326 of file Xpetra_StridedTpetraMap.hpp.
| std::string Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::description | ( | ) | const [inline, virtual] |
Return a simple one-line description of this object.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 334 of file Xpetra_StridedTpetraMap.hpp.
| void Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::describe | ( | Teuchos::FancyOStream & | out, |
| const Teuchos::EVerbosityLevel | verbLevel = Teuchos::Describable::verbLevel_default |
||
| ) | const [inline, virtual] |
Print the object with some verbosity level to a FancyOStream object.
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 337 of file Xpetra_StridedTpetraMap.hpp.
| UnderlyingLib Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::lib | ( | ) | const [inline, virtual] |
Get the library used by this object (Tpetra or Epetra?)
Reimplemented from Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 354 of file Xpetra_StridedTpetraMap.hpp.
| bool Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >::CheckConsistency | ( | ) | [inline, private, virtual] |
Implements Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 362 of file Xpetra_StridedTpetraMap.hpp.
1.7.6.1
