#include <Xpetra_Map.hpp>
Public Types | |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
Constructor/Destructor Methods | |
virtual | ~Map () |
Destructor. More... | |
Attributes | |
virtual global_size_t | getGlobalNumElements () const =0 |
The number of elements in this Map. More... | |
virtual size_t | getNodeNumElements () const =0 |
The number of elements belonging to the calling process. More... | |
virtual GlobalOrdinal | getIndexBase () const =0 |
The index base for this Map. More... | |
virtual LocalOrdinal | getMinLocalIndex () const =0 |
The minimum local index. More... | |
virtual LocalOrdinal | getMaxLocalIndex () const =0 |
The maximum local index on the calling process. More... | |
virtual GlobalOrdinal | getMinGlobalIndex () const =0 |
The minimum global index owned by the calling process. More... | |
virtual GlobalOrdinal | getMaxGlobalIndex () const =0 |
The maximum global index owned by the calling process. More... | |
virtual GlobalOrdinal | getMinAllGlobalIndex () const =0 |
The minimum global index over all processes in the communicator. More... | |
virtual GlobalOrdinal | getMaxAllGlobalIndex () const =0 |
The maximum global index over all processes in the communicator. More... | |
virtual LocalOrdinal | getLocalElement (GlobalOrdinal globalIndex) const =0 |
The local index corresponding to the given global index. More... | |
virtual GlobalOrdinal | getGlobalElement (LocalOrdinal localIndex) const =0 |
The global index corresponding to the given local index. More... | |
virtual LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const =0 |
Return the process ranks and corresponding local indices for the given global indices. More... | |
virtual LookupStatus | getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const =0 |
Return the process ranks for the given global indices. More... | |
virtual Teuchos::ArrayView < const GlobalOrdinal > | getNodeElementList () const =0 |
Return a view of the global indices owned by this process. More... | |
Boolean tests | |
virtual bool | isNodeLocalElement (LocalOrdinal localIndex) const =0 |
Whether the given local index is valid for this Map on this process. More... | |
virtual bool | isNodeGlobalElement (GlobalOrdinal globalIndex) const =0 |
Whether the given global index is valid for this Map on this process. More... | |
virtual bool | isContiguous () const =0 |
True if this Map is distributed contiguously, else false. More... | |
virtual bool | isDistributed () const =0 |
Whether this Map is globally distributed or locally replicated. More... | |
virtual bool | isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const =0 |
True if and only if map is compatible with this Map. More... | |
virtual bool | isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const =0 |
True if and only if map is identical to this Map. More... | |
virtual Teuchos::RCP< const Teuchos::Comm< int > > | getComm () const =0 |
Get this Map's Comm object. More... | |
virtual std::string | description () const =0 |
Return a simple one-line description of this object. More... | |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0 |
Print this object with the given verbosity level to the given Teuchos::FancyOStream. More... | |
virtual RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | removeEmptyProcesses () const =0 |
Return a new Map with processes with zero elements removed. More... | |
virtual RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const =0 |
Replace this Map's communicator with a subset communicator. More... | |
Xpetra specific | |
virtual UnderlyingLib | lib () const =0 |
Get the library used by this object (Tpetra or Epetra?) More... | |
virtual RCP< const Xpetra::Map < LocalOrdinal, GlobalOrdinal, Node > > | getMap () const |
Additional Inherited Members | |
Public Member Functions inherited from Teuchos::Describable | |
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 |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Static Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
Definition at line 90 of file Xpetra_Map.hpp.
typedef LocalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type |
Definition at line 94 of file Xpetra_Map.hpp.
typedef GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type |
Definition at line 95 of file Xpetra_Map.hpp.
typedef Node Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::node_type |
Definition at line 96 of file Xpetra_Map.hpp.
|
inlinevirtual |
Destructor.
Definition at line 102 of file Xpetra_Map.hpp.
|
pure virtual |
The number of elements in this Map.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The number of elements belonging to the calling process.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The index base for this Map.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The minimum local index.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The maximum local index on the calling process.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The minimum global index owned by the calling process.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The maximum global index owned by the calling process.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The minimum global index over all processes in the communicator.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The maximum global index over all processes in the communicator.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The local index corresponding to the given global index.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
The global index corresponding to the given local index.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< GlobalOrdinal, Node >, and Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >.
|
pure virtual |
Return the process ranks and corresponding local indices for the given global indices.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Return the process ranks for the given global indices.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Return a view of the global indices owned by this process.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Whether the given local index is valid for this Map on this process.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Whether the given global index is valid for this Map on this process.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
True if this Map is distributed contiguously, else false.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Whether this Map is globally distributed or locally replicated.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
True if and only if map is compatible with this Map.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
True if and only if map is identical to this Map.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Get this Map's Comm object.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Return a simple one-line description of this object.
Reimplemented from Teuchos::Describable.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Print this object with the given verbosity level to the given Teuchos::FancyOStream.
Reimplemented from Teuchos::Describable.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Return a new Map with processes with zero elements removed.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Replace this Map's communicator with a subset communicator.
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
pure virtual |
Get the library used by this object (Tpetra or Epetra?)
Implemented in Xpetra::EpetraMapT< long long, EpetraNode >, Xpetra::TpetraMap< int, long long, EpetraNode >, Xpetra::EpetraMapT< int, EpetraNode >, Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< int, int, EpetraNode >, Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< GlobalOrdinal, Node >.
|
inlinevirtual |
Reimplemented in Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 222 of file Xpetra_Map.hpp.