Xpetra
Version of the Day
|
#include <Xpetra_TpetraMap_def.hpp>
Public Types | |
typedef int | GlobalOrdinal |
typedef int | LocalOrdinal |
typedef EpetraNode | Node |
Public Types inherited from Xpetra::Map< int, int, EpetraNode > | |
typedef int | local_ordinal_type |
typedef int | global_ordinal_type |
typedef EpetraNode | node_type |
typedef Kokkos::View< const global_ordinal_type *, typename EpetraNode::device_type > | global_indices_array_device_type |
typedef Tpetra::Map< int, int, EpetraNode >::local_map_type | local_map_type |
Constructors and destructor | |
TpetraMap (global_size_t numGlobalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=GloballyDistributed) | |
Constructor with Tpetra-defined contiguous uniform distribution. More... | |
TpetraMap (global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm) | |
Constructor with a user-defined contiguous distribution. More... | |
TpetraMap (global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm) | |
Constructor with user-defined arbitrary (possibly noncontiguous) distribution. More... | |
~TpetraMap () | |
Destructor. More... | |
Attributes | |
global_size_t | getGlobalNumElements () const |
The number of elements in this Map. More... | |
size_t | getLocalNumElements () const |
The number of elements belonging to the calling node. More... | |
GlobalOrdinal | getIndexBase () const |
The index base for this Map. More... | |
LocalOrdinal | getMinLocalIndex () const |
The minimum local index. More... | |
LocalOrdinal | getMaxLocalIndex () const |
The maximum local index on the calling process. More... | |
GlobalOrdinal | getMinGlobalIndex () const |
The minimum global index owned by the calling process. More... | |
GlobalOrdinal | getMaxGlobalIndex () const |
The maximum global index owned by the calling process. More... | |
GlobalOrdinal | getMinAllGlobalIndex () const |
The minimum global index over all processes in the communicator. More... | |
GlobalOrdinal | getMaxAllGlobalIndex () const |
The maximum global index over all processes in the communicator. More... | |
LocalOrdinal | getLocalElement (GlobalOrdinal globalIndex) const |
The local index corresponding to the given global index. More... | |
GlobalOrdinal | getGlobalElement (LocalOrdinal localIndex) const |
The global index corresponding to the given local index. More... | |
LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const |
Return the process IDs and corresponding local IDs for the given global IDs. More... | |
LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const |
Return the process IDs for the given global IDs. More... | |
Teuchos::ArrayView< const GlobalOrdinal > | getLocalElementList () const |
Return a view of the global indices owned by this node. More... | |
Boolean tests | |
bool | isNodeLocalElement (LocalOrdinal localIndex) const |
True if the local index is valid for this Map on this node, else false. More... | |
bool | isNodeGlobalElement (GlobalOrdinal globalIndex) const |
True if the global index is found in this Map on this node, else false. More... | |
bool | isContiguous () const |
True if this Map is distributed contiguously, else false. More... | |
bool | isDistributed () const |
Whether this Map is globally distributed or locally replicated. More... | |
bool | isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const |
True if and only if map is compatible with this Map. More... | |
bool | isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const |
True if and only if map is identical to this Map. More... | |
Teuchos::RCP< const Teuchos::Comm< int > > | getComm () const |
Get this Map's Comm object. More... | |
std::string | description () const |
Return a simple one-line description of this object. More... | |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const |
Print this object with the given verbosity level to the given FancyOStream. More... | |
RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > | removeEmptyProcesses () const |
Return a new Map with processes with zero elements removed. More... | |
RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > | replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const |
Replace this Map's communicator with a subset communicator. More... | |
Xpetra specific | |
using | local_map_type = typename Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_type |
TpetraMap (const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &map) | |
TpetraMap constructor to wrap a Tpetra::Map object. More... | |
UnderlyingLib | lib () const |
Get the library used by this object (Tpetra or Epetra?) More... | |
RCP< const Tpetra::Map < LocalOrdinal, GlobalOrdinal, Node > > | getTpetra_Map () const |
Get the underlying Tpetra map. More... | |
local_map_type | getLocalMap () const |
Get the local Map for Kokkos kernels. More... | |
Definition at line 291 of file Xpetra_TpetraMap_def.hpp.
typedef int Xpetra::TpetraMap< int, int, EpetraNode >::GlobalOrdinal |
Definition at line 294 of file Xpetra_TpetraMap_def.hpp.
typedef int Xpetra::TpetraMap< int, int, EpetraNode >::LocalOrdinal |
Definition at line 295 of file Xpetra_TpetraMap_def.hpp.
typedef EpetraNode Xpetra::TpetraMap< int, int, EpetraNode >::Node |
Definition at line 296 of file Xpetra_TpetraMap_def.hpp.
using Xpetra::TpetraMap< int, int, EpetraNode >::local_map_type = typename Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type |
Definition at line 440 of file Xpetra_TpetraMap_def.hpp.
|
inline |
Constructor with Tpetra-defined contiguous uniform distribution.
Definition at line 303 of file Xpetra_TpetraMap_def.hpp.
|
inline |
Constructor with a user-defined contiguous distribution.
Definition at line 312 of file Xpetra_TpetraMap_def.hpp.
|
inline |
Constructor with user-defined arbitrary (possibly noncontiguous) distribution.
Definition at line 321 of file Xpetra_TpetraMap_def.hpp.
|
inline |
Destructor.
Definition at line 329 of file Xpetra_TpetraMap_def.hpp.
|
inline |
TpetraMap constructor to wrap a Tpetra::Map object.
Definition at line 429 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The number of elements in this Map.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 337 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The number of elements belonging to the calling node.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 340 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The index base for this Map.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 343 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The minimum local index.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 346 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The maximum local index on the calling process.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 349 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The minimum global index owned by the calling process.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 352 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The maximum global index owned by the calling process.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 355 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The minimum global index over all processes in the communicator.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 358 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The maximum global index over all processes in the communicator.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 361 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The local index corresponding to the given global index.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 364 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
The global index corresponding to the given local index.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 367 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Return the process IDs and corresponding local IDs for the given global IDs.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 370 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Return the process IDs for the given global IDs.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 373 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Return a view of the global indices owned by this node.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 376 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
True if the local index is valid for this Map on this node, else false.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 384 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
True if the global index is found in this Map on this node, else false.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 387 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
True if this Map is distributed contiguously, else false.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 390 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Whether this Map is globally distributed or locally replicated.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 393 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
True if and only if map is compatible with this Map.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 396 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
True if and only if map is identical to this Map.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 399 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Get this Map's Comm object.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 407 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Return a simple one-line description of this object.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 415 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Print this object with the given verbosity level to the given FancyOStream.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 418 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Return a new Map with processes with zero elements removed.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 420 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Replace this Map's communicator with a subset communicator.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 421 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Get the library used by this object (Tpetra or Epetra?)
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 434 of file Xpetra_TpetraMap_def.hpp.
|
inline |
Get the underlying Tpetra map.
Definition at line 437 of file Xpetra_TpetraMap_def.hpp.
|
inlinevirtual |
Get the local Map for Kokkos kernels.
Implements Xpetra::Map< int, int, EpetraNode >.
Definition at line 442 of file Xpetra_TpetraMap_def.hpp.