All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types
Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_Map.hpp>

Inheritance diagram for Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >:
Describable Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >

List of all members.

Public Types

typedef LocalOrdinal local_ordinal_type
typedef GlobalOrdinal global_ordinal_type
typedef Node node_type

Constructor/Destructor Methods

virtual ~Map ()
 Destructor.

Attributes

virtual global_size_t getGlobalNumElements () const =0
 The number of elements in this Map.
virtual size_t getNodeNumElements () const =0
 The number of elements belonging to the calling process.
virtual GlobalOrdinal getIndexBase () const =0
 The index base for this Map.
virtual LocalOrdinal getMinLocalIndex () const =0
 The minimum local index.
virtual LocalOrdinal getMaxLocalIndex () const =0
 The maximum local index on the calling process.
virtual GlobalOrdinal getMinGlobalIndex () const =0
 The minimum global index owned by the calling process.
virtual GlobalOrdinal getMaxGlobalIndex () const =0
 The maximum global index owned by the calling process.
virtual GlobalOrdinal getMinAllGlobalIndex () const =0
 The minimum global index over all processes in the communicator.
virtual GlobalOrdinal getMaxAllGlobalIndex () const =0
 The maximum global index over all processes in the communicator.
virtual LocalOrdinal getLocalElement (GlobalOrdinal globalIndex) const =0
 The local index corresponding to the given global index.
virtual GlobalOrdinal getGlobalElement (LocalOrdinal localIndex) const =0
 The global index corresponding to the given local index.
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.
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.
virtual Teuchos::ArrayView
< const GlobalOrdinal > 
getNodeElementList () const =0
 Return a view of the global indices owned by this process.

Boolean tests

virtual bool isNodeLocalElement (LocalOrdinal localIndex) const =0
 Whether the given local index is valid for this Map on this process.
virtual bool isNodeGlobalElement (GlobalOrdinal globalIndex) const =0
 Whether the given global index is valid for this Map on this process.
virtual bool isContiguous () const =0
 True if this Map is distributed contiguously, else false.
virtual bool isDistributed () const =0
 Whether this Map is globally distributed or locally replicated.
virtual bool isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const =0
 True if and only if map is compatible with this Map.
virtual bool isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const =0
 True if and only if map is identical to this Map.
virtual Teuchos::RCP< const
Teuchos::Comm< int > > 
getComm () const =0
 Get this Map's Comm object.
virtual Teuchos::RCP< Node > getNode () const =0
 Get this Map's Node object.
virtual std::string description () const =0
 Return a simple one-line description of this object.
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.
virtual RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
removeEmptyProcesses () const =0
 Return a new Map with processes with zero elements removed.
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.

Xpetra specific

virtual UnderlyingLib lib () const =0
 Get the library used by this object (Tpetra or Epetra?)
virtual RCP< const MapgetMap () const

Detailed Description

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 66 of file Xpetra_Map.hpp.


Member Typedef Documentation

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef LocalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef Node Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::node_type

Constructor & Destructor Documentation

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::~Map ( ) [inline, virtual]

Destructor.

Definition at line 78 of file Xpetra_Map.hpp.


Member Function Documentation

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual global_size_t Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumElements ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumElements ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual LocalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinLocalIndex ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual LocalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxLocalIndex ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinGlobalIndex ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxGlobalIndex ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinAllGlobalIndex ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxAllGlobalIndex ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual LocalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getLocalElement ( GlobalOrdinal  globalIndex) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getGlobalElement ( LocalOrdinal  localIndex) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual LookupStatus Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > &  GIDList,
const Teuchos::ArrayView< int > &  nodeIDList,
const Teuchos::ArrayView< LocalOrdinal > &  LIDList 
) const [pure virtual]

Return the process ranks and corresponding local indices for the given global indices.

Implemented in Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< EpetraGlobalOrdinal >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual LookupStatus Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > &  GIDList,
const Teuchos::ArrayView< int > &  nodeIDList 
) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::ArrayView< const GlobalOrdinal > Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getNodeElementList ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isNodeLocalElement ( LocalOrdinal  localIndex) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isNodeGlobalElement ( GlobalOrdinal  globalIndex) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isContiguous ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isDistributed ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isCompatible ( const Map< LocalOrdinal, GlobalOrdinal, Node > &  map) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isSameAs ( const Map< LocalOrdinal, GlobalOrdinal, Node > &  map) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getComm ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP< Node > Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getNode ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual std::string Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const [pure virtual]

Print this object with the given verbosity level to the given Teuchos::FancyOStream.

Implemented in Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >, Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraMapT< EpetraGlobalOrdinal >.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::removeEmptyProcesses ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::replaceCommWithSubset ( const Teuchos::RCP< const Teuchos::Comm< int > > &  newComm) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual UnderlyingLib Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::lib ( ) const [pure virtual]
template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP<const Map> Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const [inline, virtual]

Reimplemented in Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 196 of file Xpetra_Map.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines