Xpetra
Version of the Day
|
#include <Xpetra_EpetraMap.hpp>
Public Types | |
typedef int | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
Public Types inherited from Xpetra::Map< int, GlobalOrdinal, Node > | |
typedef int | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
Public Member Functions | |
GlobalOrdinal | getGlobalElement (LocalOrdinal) const |
Return the global index for a given local index. Note that this returns -1 if not found on this processor. (This is different than Epetra's behavior!) More... | |
Public Member Functions inherited from Xpetra::Map< int, GlobalOrdinal, Node > | |
virtual | ~Map () |
Destructor. More... | |
virtual RCP< const Xpetra::Map < int, GlobalOrdinal, Node > > | getMap () const |
Protected Attributes | |
RCP< const Epetra_BlockMap > | map_ |
Private Types | |
typedef int | LocalOrdinal |
Constructors and destructor | |
EpetraMapT (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... | |
EpetraMapT (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... | |
EpetraMapT (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... | |
Attributes | |
global_size_t | getGlobalNumElements () const |
The number of elements in this Map. More... | |
size_t | getNodeNumElements () const |
The number of elements belonging to the calling process. 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) const |
The local index corresponding to the given global index. More... | |
LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &, const Teuchos::ArrayView< int > &, const Teuchos::ArrayView< LocalOrdinal > &) const |
Return the process ranks and corresponding local indices for the given global indices. More... | |
LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &, const Teuchos::ArrayView< int > &) const |
Return the process ranks for the given global indices. More... | |
Teuchos::ArrayView< const GlobalOrdinal > | getNodeElementList () const |
Return a view of the global indices owned by this process. More... | |
Boolean tests | |
bool | isNodeLocalElement (LocalOrdinal) const |
Whether the given local index is valid for this Map on this process. More... | |
bool | isNodeGlobalElement (GlobalOrdinal) const |
Whether the given global index is valid for this Map on this process. 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 > &) const |
True if and only if map is compatible with this Map. More... | |
bool | isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &) 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 &, const Teuchos::EVerbosityLevel=Teuchos::Describable::verbLevel_default) const |
Print this object with the given verbosity level to the given Teuchos::FancyOStream. More... | |
RCP< const Map< int, GlobalOrdinal, Node > > | removeEmptyProcesses () const |
Return a new Map with processes with zero elements removed. More... | |
RCP< const Map< int, GlobalOrdinal, Node > > | replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &) const |
Replace this Map's communicator with a subset communicator. More... | |
Xpetra specific | |
virtual | ~EpetraMapT () |
Destructor. More... | |
EpetraMapT (const Teuchos::RCP< const Epetra_BlockMap > &map) | |
EpetraMapT constructor to wrap a Epetra_Map object. More... | |
UnderlyingLib | lib () const |
Get the library used by this object (Epetra or Epetra?) More... | |
const Epetra_BlockMap & | getEpetra_BlockMap () const |
Get the underlying Epetra map. More... | |
const Epetra_Map & | getEpetra_Map () const |
Definition at line 80 of file Xpetra_EpetraMap.hpp.
|
private |
Definition at line 83 of file Xpetra_EpetraMap.hpp.
typedef int Xpetra::EpetraMapT< GlobalOrdinal, Node >::local_ordinal_type |
Definition at line 86 of file Xpetra_EpetraMap.hpp.
typedef GlobalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::global_ordinal_type |
Definition at line 87 of file Xpetra_EpetraMap.hpp.
typedef Node Xpetra::EpetraMapT< GlobalOrdinal, Node >::node_type |
Definition at line 88 of file Xpetra_EpetraMap.hpp.
|
inline |
Constructor with Tpetra-defined contiguous uniform distribution.
Definition at line 94 of file Xpetra_EpetraMap.hpp.
|
inline |
Constructor with a user-defined contiguous distribution.
Definition at line 104 of file Xpetra_EpetraMap.hpp.
|
inline |
Constructor with user-defined arbitrary (possibly noncontiguous) distribution.
Definition at line 110 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Destructor.
Definition at line 226 of file Xpetra_EpetraMap.hpp.
|
inline |
EpetraMapT constructor to wrap a Epetra_Map object.
Definition at line 229 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The number of elements in this Map.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 124 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The number of elements belonging to the calling process.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 127 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The index base for this Map.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 130 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The minimum local index.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 133 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The maximum local index on the calling process.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 136 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The minimum global index owned by the calling process.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 139 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The maximum global index owned by the calling process.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 142 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The minimum global index over all processes in the communicator.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 145 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The maximum global index over all processes in the communicator.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 148 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
The local index corresponding to the given global index.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 151 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Return the process ranks and corresponding local indices for the given global indices.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 154 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Return the process ranks for the given global indices.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 157 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Return a view of the global indices owned by this process.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 162 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Whether the given local index is valid for this Map on this process.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 169 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Whether the given global index is valid for this Map on this process.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 172 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
True if this Map is distributed contiguously, else false.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 175 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Whether this Map is globally distributed or locally replicated.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 178 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
True if and only if map is compatible with this Map.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 181 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
True if and only if map is identical to this Map.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 184 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Get this Map's Comm object.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 192 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Return a simple one-line description of this object.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 201 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Print this object with the given verbosity level to the given Teuchos::FancyOStream.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 204 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Return a new Map with processes with zero elements removed.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 212 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Replace this Map's communicator with a subset communicator.
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 215 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Return the global index for a given local index. Note that this returns -1 if not found on this processor. (This is different than Epetra's behavior!)
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 220 of file Xpetra_EpetraMap.hpp.
|
inlinevirtual |
Get the library used by this object (Epetra or Epetra?)
Implements Xpetra::Map< int, GlobalOrdinal, Node >.
Definition at line 236 of file Xpetra_EpetraMap.hpp.
|
inline |
Get the underlying Epetra map.
Definition at line 240 of file Xpetra_EpetraMap.hpp.
|
inline |
Definition at line 241 of file Xpetra_EpetraMap.hpp.
|
protected |
Definition at line 261 of file Xpetra_EpetraMap.hpp.