Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

#include <Xpetra_Map_decl.hpp>

Inheritance diagram for Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >:
Teuchos::Describable Teuchos::LabeledObject Xpetra::BlockedMap< 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
 

Xpetra specific

typedef Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_type local_map_type
 
virtual UnderlyingLib lib () const =0
 Get the library used by this object (Tpetra or Epetra?)
 
virtual RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap () const
 
virtual local_map_type getLocalMap () const =0
 Get the local Map for Kokkos kernels.
 

Constructor/Destructor Methods

virtual ~Map ()
 Destructor.
 

Attributes

virtual global_size_t getGlobalNumElements () const =0
 The number of elements in this Map.
 
virtual size_t getLocalNumElements () 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 > getLocalElementList () 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 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.
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

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

Definition at line 87 of file Xpetra_Map_decl.hpp.

Member Typedef Documentation

◆ local_ordinal_type

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

Definition at line 91 of file Xpetra_Map_decl.hpp.

◆ global_ordinal_type

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

Definition at line 92 of file Xpetra_Map_decl.hpp.

◆ node_type

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

Definition at line 93 of file Xpetra_Map_decl.hpp.

◆ local_map_type

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

Definition at line 223 of file Xpetra_Map_decl.hpp.

Constructor & Destructor Documentation

◆ ~Map()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::~Map ( )
virtual

Destructor.

Definition at line 56 of file Xpetra_Map_def.hpp.

Member Function Documentation

◆ getGlobalNumElements()

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

◆ getLocalNumElements()

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

◆ getIndexBase()

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

◆ getMinLocalIndex()

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

◆ getMaxLocalIndex()

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

◆ getMinGlobalIndex()

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

◆ getMaxGlobalIndex()

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

◆ getMinAllGlobalIndex()

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

◆ getMaxAllGlobalIndex()

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

◆ getLocalElement()

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

◆ getGlobalElement()

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

◆ getRemoteIndexList() [1/2]

template<class LocalOrdinal , class GlobalOrdinal , 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 , class GlobalOrdinal , 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

◆ getLocalElementList()

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

◆ isNodeLocalElement()

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

◆ isNodeGlobalElement()

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

◆ isContiguous()

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

◆ isDistributed()

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

◆ isCompatible()

template<class LocalOrdinal , class GlobalOrdinal , 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 , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual bool Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::isSameAs ( const Map< LocalOrdinal, GlobalOrdinal, Node > & map) const
pure virtual

◆ getComm()

◆ description()

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

◆ describe()

template<class LocalOrdinal , class GlobalOrdinal , 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 , class GlobalOrdinal , 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 , class GlobalOrdinal , 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 , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual UnderlyingLib Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::lib ( ) const
pure virtual

◆ getMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const
virtual

◆ getLocalMap()


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