#include <Xpetra_TpetraMap.hpp>
Protected Attributes | |
| RCP< const Tpetra::Map < LocalOrdinal, GlobalOrdinal, Node > > | map_ |
Constructors and destructor | |
| TpetraMap (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()) | |
| 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, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode()) | |
| 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, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode()) | |
| Constructor with user-defined arbitrary (possibly noncontiguous) distribution. | |
| ~TpetraMap () | |
| Destructor. | |
Attributes | |
| global_size_t | getGlobalNumElements () const |
| The number of elements in this Map. | |
| size_t | getNodeNumElements () 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 > | getNodeElementList () 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. | |
| const Teuchos::RCP< const Teuchos::Comm< int > > | getComm () const |
| Get this Map's Comm object. | |
| const Teuchos::RCP< Node > | getNode () const |
| Get this Map's Node 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. | |
Xpetra specific | |
| 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?) | |
| const RCP< const Tpetra::Map < LocalOrdinal, GlobalOrdinal, Node > > & | getTpetra_Map () const |
| Get the underlying Tpetra map. | |
Definition at line 74 of file Xpetra_TpetraMap.hpp.
| Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraMap | ( | 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() |
||
| ) | [inline] |
Constructor with Tpetra-defined contiguous uniform distribution.
Definition at line 83 of file Xpetra_TpetraMap.hpp.
| Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraMap | ( | 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() |
||
| ) | [inline] |
Constructor with a user-defined contiguous distribution.
Definition at line 87 of file Xpetra_TpetraMap.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, | ||
| const Teuchos::RCP< Node > & | node = Kokkos::DefaultNode::getDefaultNode() |
||
| ) | [inline] |
Constructor with user-defined arbitrary (possibly noncontiguous) distribution.
Definition at line 91 of file Xpetra_TpetraMap.hpp.
| Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::~TpetraMap | ( | ) | [inline] |
Destructor.
Definition at line 95 of file Xpetra_TpetraMap.hpp.
| Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraMap | ( | const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & | map | ) | [inline] |
TpetraMap constructor to wrap a Tpetra::Map object.
Definition at line 195 of file Xpetra_TpetraMap.hpp.
| global_size_t Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumElements | ( | ) | const [inline, virtual] |
The number of elements in this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 103 of file Xpetra_TpetraMap.hpp.
| size_t Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumElements | ( | ) | const [inline, virtual] |
The number of elements belonging to the calling node.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 106 of file Xpetra_TpetraMap.hpp.
| GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase | ( | ) | const [inline, virtual] |
The index base for this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 109 of file Xpetra_TpetraMap.hpp.
| LocalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinLocalIndex | ( | ) | const [inline, virtual] |
The minimum local index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 112 of file Xpetra_TpetraMap.hpp.
| LocalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxLocalIndex | ( | ) | const [inline, virtual] |
The maximum local index on the calling process.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 115 of file Xpetra_TpetraMap.hpp.
| GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinGlobalIndex | ( | ) | const [inline, virtual] |
The minimum global index owned by the calling process.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 118 of file Xpetra_TpetraMap.hpp.
| GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxGlobalIndex | ( | ) | const [inline, virtual] |
The maximum global index owned by the calling process.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 121 of file Xpetra_TpetraMap.hpp.
| GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinAllGlobalIndex | ( | ) | const [inline, virtual] |
The minimum global index over all processes in the communicator.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 124 of file Xpetra_TpetraMap.hpp.
| GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxAllGlobalIndex | ( | ) | const [inline, virtual] |
The maximum global index over all processes in the communicator.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 127 of file Xpetra_TpetraMap.hpp.
| LocalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalElement | ( | GlobalOrdinal | globalIndex | ) | const [inline, virtual] |
The local index corresponding to the given global index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 130 of file Xpetra_TpetraMap.hpp.
| GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalElement | ( | LocalOrdinal | localIndex | ) | const [inline, virtual] |
The global index corresponding to the given local index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 133 of file Xpetra_TpetraMap.hpp.
| LookupStatus Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList | ( | const Teuchos::ArrayView< const GlobalOrdinal > & | GIDList, |
| const Teuchos::ArrayView< int > & | nodeIDList, | ||
| const Teuchos::ArrayView< LocalOrdinal > & | LIDList | ||
| ) | const [inline, virtual] |
Return the process IDs and corresponding local IDs for the given global IDs.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 136 of file Xpetra_TpetraMap.hpp.
| LookupStatus Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList | ( | const Teuchos::ArrayView< const GlobalOrdinal > & | GIDList, |
| const Teuchos::ArrayView< int > & | nodeIDList | ||
| ) | const [inline, virtual] |
Return the process IDs for the given global IDs.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 139 of file Xpetra_TpetraMap.hpp.
| Teuchos::ArrayView< const GlobalOrdinal > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeElementList | ( | ) | const [inline, virtual] |
Return a view of the global indices owned by this node.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 142 of file Xpetra_TpetraMap.hpp.
| bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isNodeLocalElement | ( | LocalOrdinal | localIndex | ) | const [inline, virtual] |
True if the local index is valid for this Map on this node, else false.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 150 of file Xpetra_TpetraMap.hpp.
| bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isNodeGlobalElement | ( | GlobalOrdinal | globalIndex | ) | const [inline, virtual] |
True if the global index is found in this Map on this node, else false.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 153 of file Xpetra_TpetraMap.hpp.
| bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isContiguous | ( | ) | const [inline, virtual] |
True if this Map is distributed contiguously, else false.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 156 of file Xpetra_TpetraMap.hpp.
| bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isDistributed | ( | ) | const [inline, virtual] |
Whether this Map is globally distributed or locally replicated.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 159 of file Xpetra_TpetraMap.hpp.
| bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isCompatible | ( | const Map< LocalOrdinal, GlobalOrdinal, Node > & | map | ) | const [inline, virtual] |
True if and only if map is compatible with this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 162 of file Xpetra_TpetraMap.hpp.
| bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isSameAs | ( | const Map< LocalOrdinal, GlobalOrdinal, Node > & | map | ) | const [inline, virtual] |
True if and only if map is identical to this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 165 of file Xpetra_TpetraMap.hpp.
| const Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getComm | ( | ) | const [inline, virtual] |
Get this Map's Comm object.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 173 of file Xpetra_TpetraMap.hpp.
| const Teuchos::RCP< Node > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNode | ( | ) | const [inline, virtual] |
Get this Map's Node object.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 176 of file Xpetra_TpetraMap.hpp.
| std::string Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::description | ( | ) | const [inline, virtual] |
Return a simple one-line description of this object.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 184 of file Xpetra_TpetraMap.hpp.
| void Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::describe | ( | Teuchos::FancyOStream & | out, |
| const Teuchos::EVerbosityLevel | verbLevel = Teuchos::Describable::verbLevel_default |
||
| ) | const [inline, virtual] |
Print this object with the given verbosity level to the given FancyOStream.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 187 of file Xpetra_TpetraMap.hpp.
| UnderlyingLib Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::lib | ( | ) | const [inline, virtual] |
Get the library used by this object (Tpetra or Epetra?)
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Reimplemented in Xpetra::StridedTpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 199 of file Xpetra_TpetraMap.hpp.
| const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >& Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getTpetra_Map | ( | ) | const [inline] |
Get the underlying Tpetra map.
Definition at line 202 of file Xpetra_TpetraMap.hpp.
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::map_ [protected] |
Definition at line 208 of file Xpetra_TpetraMap.hpp.
1.7.6.1