All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Member Functions | Protected Attributes | Private Types
Xpetra::EpetraMap Class Reference

#include <Xpetra_EpetraMap.hpp>

Inheritance diagram for Xpetra::EpetraMap:
Xpetra::Map< int, int > Describable Xpetra::StridedEpetraMap

List of all members.

Public Member Functions

GlobalOrdinal getGlobalElement (LocalOrdinal localIndex) 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!)

Protected Attributes

RCP< const Epetra_BlockMap > map_

Private Types

typedef int LocalOrdinal
typedef int GlobalOrdinal
typedef
Kokkos::DefaultNode::DefaultNodeType 
Node

Constructors and destructor

 EpetraMap (global_size_t numGlobalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=GloballyDistributed, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
 Constructor with Tpetra-defined contiguous uniform distribution.
 EpetraMap (global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
 Constructor with a user-defined contiguous distribution.
 EpetraMap (global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
 Constructor with user-defined arbitrary (possibly noncontiguous) distribution.

Attributes

global_size_t getGlobalNumElements () const
 The number of elements in this Map.
size_t getNodeNumElements () const
 The number of elements belonging to the calling node.
GlobalOrdinal getIndexBase () const
 The index base for this Map.
LocalOrdinal getMinLocalIndex () const
 The minimum local index.
LocalOrdinal getMaxLocalIndex () const
 The maximum local index on the calling process.
GlobalOrdinal getMinGlobalIndex () const
 The minimum global index owned by the calling process.
GlobalOrdinal getMaxGlobalIndex () const
 The maximum global index owned by the calling process.
GlobalOrdinal getMinAllGlobalIndex () const
 The minimum global index over all processes in the communicator.
GlobalOrdinal getMaxAllGlobalIndex () const
 The maximum global index over all processes in the communicator.
LocalOrdinal getLocalElement (GlobalOrdinal globalIndex) const
 The local index corresponding to the given global index.
LookupStatus getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const
 Return the process IDs and corresponding local IDs for the given global IDs.
LookupStatus getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const
 Return the process IDs for the given global IDs.
Teuchos::ArrayView< const
GlobalOrdinal
getNodeElementList () const
 Return a view of the global indices owned by this node.

Boolean tests

bool isNodeLocalElement (LocalOrdinal localIndex) const
 True if the local index is valid for this Map on this node, else false.
bool isNodeGlobalElement (GlobalOrdinal globalIndex) const
 True if the global index is found in this Map on this node, else false.
bool isContiguous () const
 True if this Map is distributed contiguously, else false.
bool isDistributed () const
 Whether this Map is globally distributed or locally replicated.
bool isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
 True if and only if map is compatible with this Map.
bool isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
 True if and only if map is identical to this Map.
const Teuchos::RCP< const
Teuchos::Comm< int > > 
getComm () const
 Get this Map's Comm object.
const Teuchos::RCP< NodegetNode () const
 Get this Map's Node object.
std::string description () const
 Return a simple one-line description of this object.
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print this object with the given verbosity level to the given FancyOStream.

Xpetra specific

virtual ~EpetraMap ()
 Destructor.
 EpetraMap (const Teuchos::RCP< const Epetra_BlockMap > &map)
 EpetraMap constructor to wrap a Epetra_Map object.
UnderlyingLib lib () const
 Get the library used by this object (Epetra or Epetra?)
const Epetra_BlockMap & getEpetra_BlockMap () const
 Get the underlying Epetra map.
const Epetra_Map & getEpetra_Map () const

Detailed Description

Definition at line 72 of file Xpetra_EpetraMap.hpp.


Member Typedef Documentation

typedef int Xpetra::EpetraMap::LocalOrdinal [private]

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 76 of file Xpetra_EpetraMap.hpp.

typedef int Xpetra::EpetraMap::GlobalOrdinal [private]

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 77 of file Xpetra_EpetraMap.hpp.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 78 of file Xpetra_EpetraMap.hpp.


Constructor & Destructor Documentation

Xpetra::EpetraMap::EpetraMap ( global_size_t  numGlobalElements,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
LocalGlobal  lg = GloballyDistributed,
const Teuchos::RCP< Node > &  node = Kokkos::DefaultNode::getDefaultNode() 
)

Constructor with Tpetra-defined contiguous uniform distribution.

Definition at line 59 of file Xpetra_EpetraMap.cpp.

Xpetra::EpetraMap::EpetraMap ( global_size_t  numGlobalElements,
size_t  numLocalElements,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node = Kokkos::DefaultNode::getDefaultNode() 
)

Constructor with a user-defined contiguous distribution.

Definition at line 111 of file Xpetra_EpetraMap.cpp.

Xpetra::EpetraMap::EpetraMap ( global_size_t  numGlobalElements,
const Teuchos::ArrayView< const GlobalOrdinal > &  elementList,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node = Kokkos::DefaultNode::getDefaultNode() 
)

Constructor with user-defined arbitrary (possibly noncontiguous) distribution.

Definition at line 212 of file Xpetra_EpetraMap.cpp.

virtual Xpetra::EpetraMap::~EpetraMap ( ) [inline, virtual]

Destructor.

Definition at line 198 of file Xpetra_EpetraMap.hpp.

Xpetra::EpetraMap::EpetraMap ( const Teuchos::RCP< const Epetra_BlockMap > &  map) [inline]

EpetraMap constructor to wrap a Epetra_Map object.

Definition at line 201 of file Xpetra_EpetraMap.hpp.


Member Function Documentation

The number of elements in this Map.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 100 of file Xpetra_EpetraMap.hpp.

size_t Xpetra::EpetraMap::getNodeNumElements ( ) const [inline, virtual]

The number of elements belonging to the calling node.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 103 of file Xpetra_EpetraMap.hpp.

GlobalOrdinal Xpetra::EpetraMap::getIndexBase ( ) const [inline, virtual]

The index base for this Map.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 106 of file Xpetra_EpetraMap.hpp.

The minimum local index.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 109 of file Xpetra_EpetraMap.hpp.

The maximum local index on the calling process.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 112 of file Xpetra_EpetraMap.hpp.

The minimum global index owned by the calling process.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 115 of file Xpetra_EpetraMap.hpp.

The maximum global index owned by the calling process.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 118 of file Xpetra_EpetraMap.hpp.

The minimum global index over all processes in the communicator.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 121 of file Xpetra_EpetraMap.hpp.

The maximum global index over all processes in the communicator.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 124 of file Xpetra_EpetraMap.hpp.

LocalOrdinal Xpetra::EpetraMap::getLocalElement ( GlobalOrdinal  globalIndex) const [inline, virtual]

The local index corresponding to the given global index.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 127 of file Xpetra_EpetraMap.hpp.

LookupStatus Xpetra::EpetraMap::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > &  GIDList,
const Teuchos::ArrayView< int > &  nodeIDList,
const Teuchos::ArrayView< LocalOrdinal > &  LIDList 
) const [virtual]

Return the process IDs and corresponding local IDs for the given global IDs.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 228 of file Xpetra_EpetraMap.cpp.

LookupStatus Xpetra::EpetraMap::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > &  GIDList,
const Teuchos::ArrayView< int > &  nodeIDList 
) const [virtual]

Return the process IDs for the given global IDs.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 230 of file Xpetra_EpetraMap.cpp.

Teuchos::ArrayView< const int > Xpetra::EpetraMap::getNodeElementList ( ) const [virtual]

Return a view of the global indices owned by this node.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 232 of file Xpetra_EpetraMap.cpp.

bool Xpetra::EpetraMap::isNodeLocalElement ( LocalOrdinal  localIndex) const [inline, virtual]

True if the local index is valid for this Map on this node, else false.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 144 of file Xpetra_EpetraMap.hpp.

bool Xpetra::EpetraMap::isNodeGlobalElement ( GlobalOrdinal  globalIndex) const [inline, virtual]

True if the global index is found in this Map on this node, else false.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 147 of file Xpetra_EpetraMap.hpp.

bool Xpetra::EpetraMap::isContiguous ( ) const [inline, virtual]

True if this Map is distributed contiguously, else false.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 150 of file Xpetra_EpetraMap.hpp.

bool Xpetra::EpetraMap::isDistributed ( ) const [inline, virtual]

Whether this Map is globally distributed or locally replicated.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 153 of file Xpetra_EpetraMap.hpp.

bool Xpetra::EpetraMap::isCompatible ( const Map< LocalOrdinal, GlobalOrdinal, Node > &  map) const [inline, virtual]

True if and only if map is compatible with this Map.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 156 of file Xpetra_EpetraMap.hpp.

bool Xpetra::EpetraMap::isSameAs ( const Map< LocalOrdinal, GlobalOrdinal, Node > &  map) const [inline, virtual]

True if and only if map is identical to this Map.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 159 of file Xpetra_EpetraMap.hpp.

const Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::EpetraMap::getComm ( ) const [inline, virtual]

Get this Map's Comm object.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 167 of file Xpetra_EpetraMap.hpp.

const Teuchos::RCP< Kokkos::DefaultNode::DefaultNodeType > Xpetra::EpetraMap::getNode ( ) const [virtual]

Get this Map's Node object.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 235 of file Xpetra_EpetraMap.cpp.

std::string Xpetra::EpetraMap::description ( ) const [virtual]

Return a simple one-line description of this object.

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 242 of file Xpetra_EpetraMap.cpp.

void Xpetra::EpetraMap::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const [virtual]

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

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 256 of file Xpetra_EpetraMap.cpp.

GlobalOrdinal Xpetra::EpetraMap::getGlobalElement ( LocalOrdinal  localIndex) const [inline, virtual]

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, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 186 of file Xpetra_EpetraMap.hpp.

UnderlyingLib Xpetra::EpetraMap::lib ( ) const [inline, virtual]

Get the library used by this object (Epetra or Epetra?)

Implements Xpetra::Map< int, int >.

Reimplemented in Xpetra::StridedEpetraMap.

Definition at line 205 of file Xpetra_EpetraMap.hpp.

const Epetra_BlockMap& Xpetra::EpetraMap::getEpetra_BlockMap ( ) const [inline]

Get the underlying Epetra map.

Definition at line 209 of file Xpetra_EpetraMap.hpp.

const Epetra_Map& Xpetra::EpetraMap::getEpetra_Map ( ) const [inline]

Definition at line 210 of file Xpetra_EpetraMap.hpp.


Member Data Documentation

RCP<const Epetra_BlockMap> Xpetra::EpetraMap::map_ [protected]

Definition at line 216 of file Xpetra_EpetraMap.hpp.


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