Public Types | List of all members
Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

#include <Xpetra_Map.hpp>

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

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 Teuchos::RCP< Node > getNode () const =0
 Get this Map's Node 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
 

Detailed Description

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

Definition at line 81 of file Xpetra_Map.hpp.

Member Typedef Documentation

◆ local_ordinal_type

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

Definition at line 85 of file Xpetra_Map.hpp.

◆ global_ordinal_type

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

Definition at line 86 of file Xpetra_Map.hpp.

◆ node_type

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

Definition at line 87 of file Xpetra_Map.hpp.

Constructor & Destructor Documentation

◆ ~Map()

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

Destructor.

Definition at line 93 of file Xpetra_Map.hpp.

Member Function Documentation

◆ getGlobalNumElements()

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

◆ getNodeNumElements()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumElements ( ) const
pure virtual

◆ getIndexBase()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase ( ) const
pure virtual

◆ getMinLocalIndex()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual LocalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinLocalIndex ( ) const
pure virtual

◆ getMaxLocalIndex()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual LocalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxLocalIndex ( ) const
pure virtual

◆ getMinGlobalIndex()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinGlobalIndex ( ) const
pure virtual

◆ getMaxGlobalIndex()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxGlobalIndex ( ) const
pure virtual

◆ getMinAllGlobalIndex()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMinAllGlobalIndex ( ) const
pure virtual

◆ getMaxAllGlobalIndex()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual GlobalOrdinal Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMaxAllGlobalIndex ( ) const
pure virtual

◆ getLocalElement()

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

◆ getGlobalElement()

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

◆ getRemoteIndexList() [1/2]

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

◆ getRemoteIndexList() [2/2]

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

◆ getNodeElementList()

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

◆ isNodeLocalElement()

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

◆ isNodeGlobalElement()

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

◆ isContiguous()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isContiguous ( ) const
pure virtual

◆ isDistributed()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isDistributed ( ) const
pure virtual

◆ isCompatible()

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

◆ isSameAs()

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

◆ getComm()

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

◆ getNode()

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

◆ description()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual std::string Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
pure virtual

◆ describe()

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

◆ removeEmptyProcesses()

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

◆ replaceCommWithSubset()

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

◆ lib()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual UnderlyingLib Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::lib ( ) const
pure virtual

◆ getMap()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const
inlinevirtual

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

Definition at line 211 of file Xpetra_Map.hpp.


The documentation for this class was generated from the following file: