Xpetra Version of the Day
|
#include <Xpetra_TpetraMap_decl.hpp>
Xpetra specific | |
using | local_map_type = typename Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type |
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > | map_ |
TpetraMap (const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &map) | |
TpetraMap constructor to wrap a Tpetra::Map object. | |
UnderlyingLib | lib () const |
Get the library used by this object (Tpetra or Epetra?) | |
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > | getTpetra_Map () const |
Get the underlying Tpetra map. | |
local_map_type | getLocalMap () const |
Get the local Map for Kokkos kernels. | |
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. | |
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. | |
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. | |
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) | |
Constructor with user-defined arbitrary (possibly noncontiguous) distribution passed as a Kokkos::View. | |
~TpetraMap () | |
Destructor. | |
Attributes | |
global_size_t | getGlobalNumElements () const |
The number of elements in this Map. | |
size_t | getLocalNumElements () const |
The number of elements belonging to the calling node. | |
GlobalOrdinal | getIndexBase () const |
The index base for this Map. | |
LocalOrdinal | getMinLocalIndex () const |
The minimum local index. | |
LocalOrdinal | getMaxLocalIndex () const |
The maximum local index on the calling process. | |
GlobalOrdinal | getMinGlobalIndex () const |
The minimum global index owned by the calling process. | |
GlobalOrdinal | getMaxGlobalIndex () const |
The maximum global index owned by the calling process. | |
GlobalOrdinal | getMinAllGlobalIndex () const |
The minimum global index over all processes in the communicator. | |
GlobalOrdinal | getMaxAllGlobalIndex () const |
The maximum global index over all processes in the communicator. | |
LocalOrdinal | getLocalElement (GlobalOrdinal globalIndex) const |
The local index corresponding to the given global index. | |
GlobalOrdinal | getGlobalElement (LocalOrdinal localIndex) const |
The global index corresponding to the given local index. | |
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. | |
LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const |
Return the process IDs for the given global IDs. | |
Teuchos::ArrayView< const GlobalOrdinal > | getLocalElementList () const |
Return a view of the global indices owned by this node. | |
Boolean tests | |
bool | isNodeLocalElement (LocalOrdinal localIndex) const |
True if the local index is valid for this Map on this node, else false. | |
bool | isNodeGlobalElement (GlobalOrdinal globalIndex) const |
True if the global index is found in this Map on this node, else false. | |
bool | isContiguous () const |
True if this Map is distributed contiguously, else false. | |
bool | isDistributed () const |
Whether this Map is globally distributed or locally replicated. | |
bool | isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const |
True if and only if map is compatible with this Map. | |
bool | isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const |
True if and only if map is identical to this Map. | |
Teuchos::RCP< const Teuchos::Comm< int > > | getComm () const |
Get this Map's Comm object. | |
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 this object with the given verbosity level to the given FancyOStream. | |
RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > | removeEmptyProcesses () const |
Return a new Map with processes with zero elements removed. | |
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. | |
Additional Inherited Members | |
![]() | |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
typedef Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_type | local_map_type |
![]() | |
virtual RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > | getMap () const |
virtual | ~Map () |
Destructor. | |
![]() | |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
![]() | |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
![]() | |
static const EVerbosityLevel | verbLevel_default |
Definition at line 68 of file Xpetra_TpetraMap_decl.hpp.
using Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::local_map_type = typename Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type |
Definition at line 222 of file Xpetra_TpetraMap_decl.hpp.
Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::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.
Definition at line 63 of file Xpetra_TpetraMap_def.hpp.
Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::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.
Definition at line 78 of file Xpetra_TpetraMap_def.hpp.
Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::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.
Definition at line 93 of file Xpetra_TpetraMap_def.hpp.
Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::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 ) |
Constructor with user-defined arbitrary (possibly noncontiguous) distribution passed as a Kokkos::View.
Definition at line 109 of file Xpetra_TpetraMap_def.hpp.
Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::~TpetraMap | ( | ) |
Destructor.
Definition at line 123 of file Xpetra_TpetraMap_def.hpp.
Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraMap | ( | const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & | map | ) |
TpetraMap constructor to wrap a Tpetra::Map object.
Definition at line 233 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The number of elements in this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 129 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The number of elements belonging to the calling node.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 133 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The index base for this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 137 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The minimum local index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 141 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The maximum local index on the calling process.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 145 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The minimum global index owned by the calling process.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 149 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The maximum global index owned by the calling process.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 153 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The minimum global index over all processes in the communicator.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 157 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The maximum global index over all processes in the communicator.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 161 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The local index corresponding to the given global index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 165 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
The global index corresponding to the given local index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 169 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Return the process IDs and corresponding local IDs for the given global IDs.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 173 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Return the process IDs for the given global IDs.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 177 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Return a view of the global indices owned by this node.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 181 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
True if the local index is valid for this Map on this node, else false.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 185 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
True if the global index is found in this Map on this node, else false.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 189 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
True if this Map is distributed contiguously, else false.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 193 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Whether this Map is globally distributed or locally replicated.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 197 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
True if and only if map is compatible with this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 201 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
True if and only if map is identical to this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 205 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Get this Map's Comm object.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 209 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 213 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Print this object with the given verbosity level to the given FancyOStream.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 217 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Return a new Map with processes with zero elements removed.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 221 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Replace this Map's communicator with a subset communicator.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 227 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Get the library used by this object (Tpetra or Epetra?)
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 237 of file Xpetra_TpetraMap_def.hpp.
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getTpetra_Map | ( | ) | const |
Get the underlying Tpetra map.
Definition at line 240 of file Xpetra_TpetraMap_def.hpp.
|
virtual |
Get the local Map for Kokkos kernels.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 247 of file Xpetra_TpetraMap_def.hpp.
|
protected |
Definition at line 231 of file Xpetra_TpetraMap_decl.hpp.