#include <Xpetra_EpetraMap.hpp>

Inheritance diagram for Xpetra::EpetraMapT< EpetraGlobalOrdinal >:

Public Types
typedef int	local_ordinal_type
typedef int	global_ordinal_type
typedef Map< int, int >::node_type	node_type
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!)
template<>
Teuchos::ArrayView< const int >	getNodeElementList () const
	Return a view of the global indices owned by this process.
template<>
Teuchos::ArrayView< const long long >	getNodeElementList () const
	Return a view of the global indices owned by this process.
Static Public Member Functions
static Teuchos::RCP< Node >	defaultArgNode ()
Protected Attributes
RCP< const Epetra_BlockMap >	map_
Private Types
typedef int	LocalOrdinal
typedef EpetraGlobalOrdinal	GlobalOrdinal
typedef Map< int, GlobalOrdinal >::node_type	Node
Constructors and destructor
	EpetraMapT (global_size_t numGlobalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=GloballyDistributed, const Teuchos::RCP< Node > &node=defaultArgNode())
	Constructor with Tpetra-defined contiguous uniform distribution.
	EpetraMapT (global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=defaultArgNode())
	Constructor with a user-defined contiguous distribution.
	EpetraMapT (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=defaultArgNode())
	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 process.
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 ranks and corresponding local indices for the given global indices.
LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const
	Return the process ranks for the given global indices.
Teuchos::ArrayView< const GlobalOrdinal >	getNodeElementList () const
	Return a view of the global indices owned by this process.
Boolean tests
bool	isNodeLocalElement (LocalOrdinal localIndex) const
	Whether the given local index is valid for this Map on this process.
bool	isNodeGlobalElement (GlobalOrdinal globalIndex) const
	Whether the given global index is valid for this Map on this process.
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.
Teuchos::RCP< const Teuchos::Comm< int > >	getComm () const
	Get this Map's Comm object.
Teuchos::RCP< Node >	getNode () 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 Teuchos::FancyOStream.
RCP< const Map< int, GlobalOrdinal > >	removeEmptyProcesses () const
	Return a new Map with processes with zero elements removed.
RCP< const Map< int, GlobalOrdinal > >	replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const
	Replace this Map's communicator with a subset communicator.
Xpetra specific
virtual	~EpetraMapT ()
	Destructor.
	EpetraMapT (const Teuchos::RCP< const Epetra_BlockMap > &map)
	EpetraMapT 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

template<class EpetraGlobalOrdinal>
class Xpetra::EpetraMapT< EpetraGlobalOrdinal >

Definition at line 78 of file Xpetra_EpetraMap.hpp.

Member Typedef Documentation

template<class EpetraGlobalOrdinal>

typedef int Xpetra::EpetraMapT< EpetraGlobalOrdinal >::LocalOrdinal [private]

Definition at line 81 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

typedef EpetraGlobalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::GlobalOrdinal [private]

Definition at line 82 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

typedef Map<int, GlobalOrdinal>::node_type Xpetra::EpetraMapT< EpetraGlobalOrdinal >::Node [private]

Definition at line 83 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

typedef int Xpetra::EpetraMapT< EpetraGlobalOrdinal >::local_ordinal_type

Reimplemented from Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 86 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

typedef int Xpetra::EpetraMapT< EpetraGlobalOrdinal >::global_ordinal_type

Reimplemented from Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 87 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

typedef Map<int, int>::node_type Xpetra::EpetraMapT< EpetraGlobalOrdinal >::node_type

Reimplemented from Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 88 of file Xpetra_EpetraMap.hpp.

Constructor & Destructor Documentation

template<class EpetraGlobalOrdinal >

Xpetra::EpetraMapT< EpetraGlobalOrdinal >::EpetraMapT	(	global_size_t	numGlobalElements,
		GlobalOrdinal	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		LocalGlobal	lg = `GloballyDistributed`,
		const Teuchos::RCP< Node > &	node = `defaultArgNode()`
	)

Constructor with Tpetra-defined contiguous uniform distribution.

Definition at line 274 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

Xpetra::EpetraMapT< EpetraGlobalOrdinal >::EpetraMapT	(	global_size_t	numGlobalElements,
		size_t	numLocalElements,
		GlobalOrdinal	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		const Teuchos::RCP< Node > &	node = `defaultArgNode()`
	)

Constructor with a user-defined contiguous distribution.

Definition at line 327 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

Xpetra::EpetraMapT< EpetraGlobalOrdinal >::EpetraMapT	(	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 = `defaultArgNode()`
	)

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

Definition at line 429 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

virtual Xpetra::EpetraMapT< EpetraGlobalOrdinal >::~EpetraMapT ( ) [inline, virtual]

Destructor.

Definition at line 234 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

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

EpetraMapT constructor to wrap a Epetra_Map object.

Definition at line 237 of file Xpetra_EpetraMap.hpp.

Member Function Documentation

template<class EpetraGlobalOrdinal>

static Teuchos::RCP<Node> Xpetra::EpetraMapT< EpetraGlobalOrdinal >::defaultArgNode ( ) [inline, static]

Definition at line 90 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

global_size_t Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getGlobalNumElements ( ) const [inline, virtual]

The number of elements in this Map.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 125 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

size_t Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getNodeNumElements ( ) const [inline, virtual]

The number of elements belonging to the calling process.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 128 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

GlobalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getIndexBase ( ) const [inline, virtual]

The index base for this Map.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 131 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

LocalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getMinLocalIndex ( ) const [inline, virtual]

The minimum local index.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 134 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

LocalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getMaxLocalIndex ( ) const [inline, virtual]

The maximum local index on the calling process.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 137 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

GlobalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getMinGlobalIndex ( ) const [inline, virtual]

The minimum global index owned by the calling process.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 140 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

GlobalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getMaxGlobalIndex ( ) const [inline, virtual]

The maximum global index owned by the calling process.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 143 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

GlobalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getMinAllGlobalIndex ( ) const [inline, virtual]

The minimum global index over all processes in the communicator.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 146 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

GlobalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getMaxAllGlobalIndex ( ) const [inline, virtual]

The maximum global index over all processes in the communicator.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 149 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

LocalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getLocalElement ( GlobalOrdinal globalIndex ) const [inline, virtual]

The local index corresponding to the given global index.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 152 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

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

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

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 441 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

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

Return the process ranks for the given global indices.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 444 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

Teuchos::ArrayView< const GlobalOrdinal > Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getNodeElementList ( ) const [virtual]

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

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

template<class EpetraGlobalOrdinal>

bool Xpetra::EpetraMapT< EpetraGlobalOrdinal >::isNodeLocalElement ( LocalOrdinal localIndex ) const [inline, virtual]

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

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 169 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

bool Xpetra::EpetraMapT< EpetraGlobalOrdinal >::isNodeGlobalElement ( GlobalOrdinal globalIndex ) const [inline, virtual]

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

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 172 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

bool Xpetra::EpetraMapT< EpetraGlobalOrdinal >::isContiguous ( ) const [inline, virtual]

True if this Map is distributed contiguously, else false.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 175 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

bool Xpetra::EpetraMapT< EpetraGlobalOrdinal >::isDistributed ( ) const [inline, virtual]

Whether this Map is globally distributed or locally replicated.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 178 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

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

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

Definition at line 181 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

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

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

Definition at line 184 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

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

Get this Map's Comm object.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 192 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

Teuchos::RCP< typename EpetraMapT< EpetraGlobalOrdinal >::Node > Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getNode ( ) const [virtual]

Get this Map's Node object.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 458 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

std::string Xpetra::EpetraMapT< EpetraGlobalOrdinal >::description ( ) const [virtual]

Return a simple one-line description of this object.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 483 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

void Xpetra::EpetraMapT< EpetraGlobalOrdinal >::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 Teuchos::FancyOStream.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 498 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

RCP< const Map< int, EpetraGlobalOrdinal > > Xpetra::EpetraMapT< EpetraGlobalOrdinal >::removeEmptyProcesses ( ) const [virtual]

Return a new Map with processes with zero elements removed.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 465 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal >

RCP< const Map< int, EpetraGlobalOrdinal > > Xpetra::EpetraMapT< EpetraGlobalOrdinal >::replaceCommWithSubset ( const Teuchos::RCP< const Teuchos::Comm< int > > & newComm ) const [virtual]

Replace this Map's communicator with a subset communicator.

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 477 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

GlobalOrdinal Xpetra::EpetraMapT< EpetraGlobalOrdinal >::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, EpetraGlobalOrdinal >.

Definition at line 222 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

UnderlyingLib Xpetra::EpetraMapT< EpetraGlobalOrdinal >::lib ( ) const [inline, virtual]

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

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 243 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

const Epetra_BlockMap& Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getEpetra_BlockMap ( ) const [inline]

Get the underlying Epetra map.

Definition at line 247 of file Xpetra_EpetraMap.hpp.

template<class EpetraGlobalOrdinal>

const Epetra_Map& Xpetra::EpetraMapT< EpetraGlobalOrdinal >::getEpetra_Map ( ) const [inline]

Definition at line 248 of file Xpetra_EpetraMap.hpp.

template<>

Teuchos::ArrayView< const int > Xpetra::EpetraMapT< int >::getNodeElementList ( ) const [inline, virtual]

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

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 448 of file Xpetra_EpetraMap.hpp.

template<>

Teuchos::ArrayView< const long long > Xpetra::EpetraMapT< long long >::getNodeElementList ( ) const [inline, virtual]

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

Implements Xpetra::Map< int, EpetraGlobalOrdinal >.

Definition at line 453 of file Xpetra_EpetraMap.hpp.

Member Data Documentation

template<class EpetraGlobalOrdinal>

RCP<const Epetra_BlockMap> Xpetra::EpetraMapT< EpetraGlobalOrdinal >::map_ [protected]

Definition at line 254 of file Xpetra_EpetraMap.hpp.

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

Xpetra_EpetraMap.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Constructors and destructor

Attributes

Boolean tests

Xpetra specific

Detailed Description

template<class EpetraGlobalOrdinal> class Xpetra::EpetraMapT< EpetraGlobalOrdinal >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class EpetraGlobalOrdinal>
class Xpetra::EpetraMapT< EpetraGlobalOrdinal >