All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | Private Types | List of all members
Xpetra::EpetraMapT< GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_EpetraMap.hpp>

Inheritance diagram for Xpetra::EpetraMapT< GlobalOrdinal, Node >:
Xpetra::Map< int, GlobalOrdinal, Node > Teuchos::Describable Teuchos::LabeledObject

Public Types

typedef int local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- Public Types inherited from Xpetra::Map< int, GlobalOrdinal, Node >
typedef int local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 

Public Member Functions

GlobalOrdinal getGlobalElement (LocalOrdinal) 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!) More...
 
- Public Member Functions inherited from Xpetra::Map< int, GlobalOrdinal, Node >
virtual ~Map ()
 Destructor. More...
 
virtual RCP< const Xpetra::Map
< int, GlobalOrdinal, Node > > 
getMap () const
 
- 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)
 

Protected Attributes

RCP< const Epetra_BlockMapmap_
 

Private Types

typedef int LocalOrdinal
 

Constructors and destructor

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

Attributes

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

Boolean tests

bool isNodeLocalElement (LocalOrdinal) const
 Whether the given local index is valid for this Map on this process. More...
 
bool isNodeGlobalElement (GlobalOrdinal) const
 Whether the given global index is valid for this Map on this process. More...
 
bool isContiguous () const
 True if this Map is distributed contiguously, else false. More...
 
bool isDistributed () const
 Whether this Map is globally distributed or locally replicated. More...
 
bool isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &) const
 True if and only if map is compatible with this Map. More...
 
bool isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &) const
 True if and only if map is identical to this Map. More...
 
Teuchos::RCP< const
Teuchos::Comm< int > > 
getComm () const
 Get this Map's Comm object. More...
 
std::string description () const
 Return a simple one-line description of this object. More...
 
void describe (Teuchos::FancyOStream &, const Teuchos::EVerbosityLevel=Teuchos::Describable::verbLevel_default) const
 Print this object with the given verbosity level to the given Teuchos::FancyOStream. More...
 
RCP< const Map< int,
GlobalOrdinal, Node > > 
removeEmptyProcesses () const
 Return a new Map with processes with zero elements removed. More...
 
RCP< const Map< int,
GlobalOrdinal, Node > > 
replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &) const
 Replace this Map's communicator with a subset communicator. More...
 

Xpetra specific

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

Additional Inherited Members

- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

template<class GlobalOrdinal, class Node>
class Xpetra::EpetraMapT< GlobalOrdinal, Node >

Definition at line 77 of file Xpetra_EpetraMap.hpp.

Member Typedef Documentation

template<class GlobalOrdinal, class Node>
typedef int Xpetra::EpetraMapT< GlobalOrdinal, Node >::LocalOrdinal
private

Definition at line 80 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
typedef int Xpetra::EpetraMapT< GlobalOrdinal, Node >::local_ordinal_type

Definition at line 83 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
typedef GlobalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::global_ordinal_type

Definition at line 84 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
typedef Node Xpetra::EpetraMapT< GlobalOrdinal, Node >::node_type

Definition at line 85 of file Xpetra_EpetraMap.hpp.

Constructor & Destructor Documentation

template<class GlobalOrdinal, class Node>
Xpetra::EpetraMapT< GlobalOrdinal, Node >::EpetraMapT ( global_size_t  numGlobalElements,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
LocalGlobal  lg = GloballyDistributed 
)
inline

Constructor with Tpetra-defined contiguous uniform distribution.

Definition at line 101 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
Xpetra::EpetraMapT< GlobalOrdinal, Node >::EpetraMapT ( global_size_t  numGlobalElements,
size_t  numLocalElements,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm 
)
inline

Constructor with a user-defined contiguous distribution.

Definition at line 117 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
Xpetra::EpetraMapT< GlobalOrdinal, Node >::EpetraMapT ( global_size_t  numGlobalElements,
const Teuchos::ArrayView< const GlobalOrdinal > &  elementList,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm 
)
inline

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

Definition at line 133 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
virtual Xpetra::EpetraMapT< GlobalOrdinal, Node >::~EpetraMapT ( )
inlinevirtual

Destructor.

Definition at line 256 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
Xpetra::EpetraMapT< GlobalOrdinal, Node >::EpetraMapT ( const Teuchos::RCP< const Epetra_BlockMap > &  map)
inline

EpetraMapT constructor to wrap a Epetra_Map object.

Definition at line 259 of file Xpetra_EpetraMap.hpp.

Member Function Documentation

template<class GlobalOrdinal, class Node>
global_size_t Xpetra::EpetraMapT< GlobalOrdinal, Node >::getGlobalNumElements ( ) const
inlinevirtual

The number of elements in this Map.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 147 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
size_t Xpetra::EpetraMapT< GlobalOrdinal, Node >::getNodeNumElements ( ) const
inlinevirtual

The number of elements belonging to the calling process.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 150 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
GlobalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getIndexBase ( ) const
inlinevirtual

The index base for this Map.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 153 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
LocalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getMinLocalIndex ( ) const
inlinevirtual

The minimum local index.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 156 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
LocalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getMaxLocalIndex ( ) const
inlinevirtual

The maximum local index on the calling process.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 159 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
GlobalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getMinGlobalIndex ( ) const
inlinevirtual

The minimum global index owned by the calling process.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 162 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
GlobalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getMaxGlobalIndex ( ) const
inlinevirtual

The maximum global index owned by the calling process.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 165 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
GlobalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getMinAllGlobalIndex ( ) const
inlinevirtual

The minimum global index over all processes in the communicator.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 168 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
GlobalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getMaxAllGlobalIndex ( ) const
inlinevirtual

The maximum global index over all processes in the communicator.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 171 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
LocalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getLocalElement ( GlobalOrdinal  ) const
inlinevirtual

The local index corresponding to the given global index.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 174 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
LookupStatus Xpetra::EpetraMapT< GlobalOrdinal, Node >::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > &  ,
const Teuchos::ArrayView< int > &  ,
const Teuchos::ArrayView< LocalOrdinal > &   
) const
inlinevirtual

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

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 177 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
LookupStatus Xpetra::EpetraMapT< GlobalOrdinal, Node >::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > &  ,
const Teuchos::ArrayView< int > &   
) const
inlinevirtual

Return the process ranks for the given global indices.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 180 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
Teuchos::ArrayView< const GlobalOrdinal > Xpetra::EpetraMapT< GlobalOrdinal, Node >::getNodeElementList ( ) const
inlinevirtual

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

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 185 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
bool Xpetra::EpetraMapT< GlobalOrdinal, Node >::isNodeLocalElement ( LocalOrdinal  ) const
inlinevirtual

Whether the given local index is valid for this Map on this process.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 192 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
bool Xpetra::EpetraMapT< GlobalOrdinal, Node >::isNodeGlobalElement ( GlobalOrdinal  ) const
inlinevirtual

Whether the given global index is valid for this Map on this process.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 195 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
bool Xpetra::EpetraMapT< GlobalOrdinal, Node >::isContiguous ( ) const
inlinevirtual

True if this Map is distributed contiguously, else false.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 198 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
bool Xpetra::EpetraMapT< GlobalOrdinal, Node >::isDistributed ( ) const
inlinevirtual

Whether this Map is globally distributed or locally replicated.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 201 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
bool Xpetra::EpetraMapT< GlobalOrdinal, Node >::isCompatible ( const Map< LocalOrdinal, GlobalOrdinal, Node > &  ) const
inlinevirtual

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

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 204 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
bool Xpetra::EpetraMapT< GlobalOrdinal, Node >::isSameAs ( const Map< LocalOrdinal, GlobalOrdinal, Node > &  ) const
inlinevirtual

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

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 207 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::EpetraMapT< GlobalOrdinal, Node >::getComm ( ) const
inlinevirtual

Get this Map's Comm object.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 215 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
std::string Xpetra::EpetraMapT< GlobalOrdinal, Node >::description ( ) const
inlinevirtual

Return a simple one-line description of this object.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 231 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
void Xpetra::EpetraMapT< GlobalOrdinal, Node >::describe ( Teuchos::FancyOStream ,
const Teuchos::EVerbosityLevel  = Teuchos::Describable::verbLevel_default 
) const
inlinevirtual

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

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 234 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
RCP<const Map<int,GlobalOrdinal,Node> > Xpetra::EpetraMapT< GlobalOrdinal, Node >::removeEmptyProcesses ( ) const
inlinevirtual

Return a new Map with processes with zero elements removed.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 242 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
RCP<const Map<int,GlobalOrdinal,Node> > Xpetra::EpetraMapT< GlobalOrdinal, Node >::replaceCommWithSubset ( const Teuchos::RCP< const Teuchos::Comm< int > > &  ) const
inlinevirtual

Replace this Map's communicator with a subset communicator.

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 245 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
GlobalOrdinal Xpetra::EpetraMapT< GlobalOrdinal, Node >::getGlobalElement ( LocalOrdinal  ) const
inlinevirtual

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, GlobalOrdinal, Node >.

Definition at line 250 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
UnderlyingLib Xpetra::EpetraMapT< GlobalOrdinal, Node >::lib ( ) const
inlinevirtual

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

Implements Xpetra::Map< int, GlobalOrdinal, Node >.

Definition at line 266 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
const Epetra_BlockMap& Xpetra::EpetraMapT< GlobalOrdinal, Node >::getEpetra_BlockMap ( ) const
inline

Get the underlying Epetra map.

Definition at line 270 of file Xpetra_EpetraMap.hpp.

template<class GlobalOrdinal, class Node>
const Epetra_Map& Xpetra::EpetraMapT< GlobalOrdinal, Node >::getEpetra_Map ( ) const
inline

Definition at line 271 of file Xpetra_EpetraMap.hpp.

Member Data Documentation

template<class GlobalOrdinal, class Node>
RCP<const Epetra_BlockMap> Xpetra::EpetraMapT< GlobalOrdinal, Node >::map_
protected

Definition at line 291 of file Xpetra_EpetraMap.hpp.


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