#include <Xpetra_TpetraMap_def.hpp>

Inheritance diagram for Xpetra::TpetraMap< int, int, EpetraNode >:

Public Types
typedef int	GlobalOrdinal

typedef int	LocalOrdinal

typedef EpetraNode	Node

Public Types inherited from Xpetra::Map< int, int, EpetraNode >
typedef int	local_ordinal_type

typedef int	global_ordinal_type

typedef EpetraNode	node_type

Constructors and destructor
	TpetraMap (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...

	TpetraMap (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...

	TpetraMap (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...

	~TpetraMap ()
	Destructor. 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 node. 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 globalIndex) const
	The local index corresponding to the given global index. More...

GlobalOrdinal	getGlobalElement (LocalOrdinal localIndex) const
	The global index corresponding to the given local index. More...

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. More...

LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const
	Return the process IDs for the given global IDs. More...

Teuchos::ArrayView< const GlobalOrdinal >	getNodeElementList () const
	Return a view of the global indices owned by this node. More...

Boolean tests
bool	isNodeLocalElement (LocalOrdinal localIndex) const
	True if the local index is valid for this Map on this node, else false. More...

bool	isNodeGlobalElement (GlobalOrdinal globalIndex) const
	True if the global index is found in this Map on this node, else false. 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 > &map) const
	True if and only if map is compatible with this Map. More...

bool	isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) 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 &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
	Print this object with the given verbosity level to the given FancyOStream. More...

RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	removeEmptyProcesses () const
	Return a new Map with processes with zero elements removed. More...

RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const
	Replace this Map's communicator with a subset communicator. More...

Xpetra specific
	TpetraMap (const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &map)
	TpetraMap constructor to wrap a Tpetra::Map object. More...

UnderlyingLib	lib () const
	Get the library used by this object (Tpetra or Epetra?) More...

RCP< const Tpetra::Map < LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_Map () const
	Get the underlying Tpetra map. More...

Detailed Description

template<>
class Xpetra::TpetraMap< int, int, EpetraNode >

Definition at line 265 of file Xpetra_TpetraMap_def.hpp.

Member Typedef Documentation

typedef int Xpetra::TpetraMap< int, int, EpetraNode >::GlobalOrdinal

Definition at line 269 of file Xpetra_TpetraMap_def.hpp.

typedef int Xpetra::TpetraMap< int, int, EpetraNode >::LocalOrdinal

Definition at line 270 of file Xpetra_TpetraMap_def.hpp.

typedef EpetraNode Xpetra::TpetraMap< int, int, EpetraNode >::Node

Definition at line 271 of file Xpetra_TpetraMap_def.hpp.

Constructor & Destructor Documentation

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap	(	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 280 of file Xpetra_TpetraMap_def.hpp.

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap	(	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 291 of file Xpetra_TpetraMap_def.hpp.

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap	(	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 302 of file Xpetra_TpetraMap_def.hpp.

Xpetra::TpetraMap< int, int, EpetraNode >::~TpetraMap ( )

inline

Destructor.

Definition at line 311 of file Xpetra_TpetraMap_def.hpp.

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap ( const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & map )

inline

TpetraMap constructor to wrap a Tpetra::Map object.

Definition at line 412 of file Xpetra_TpetraMap_def.hpp.

Member Function Documentation

global_size_t Xpetra::TpetraMap< int, int, EpetraNode >::getGlobalNumElements ( ) const

inlinevirtual

The number of elements in this Map.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 319 of file Xpetra_TpetraMap_def.hpp.

size_t Xpetra::TpetraMap< int, int, EpetraNode >::getNodeNumElements ( ) const

inlinevirtual

The number of elements belonging to the calling node.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 322 of file Xpetra_TpetraMap_def.hpp.

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getIndexBase ( ) const

inlinevirtual

The index base for this Map.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 325 of file Xpetra_TpetraMap_def.hpp.

LocalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMinLocalIndex ( ) const

inlinevirtual

The minimum local index.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 328 of file Xpetra_TpetraMap_def.hpp.

LocalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMaxLocalIndex ( ) const

inlinevirtual

The maximum local index on the calling process.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 331 of file Xpetra_TpetraMap_def.hpp.

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMinGlobalIndex ( ) const

inlinevirtual

The minimum global index owned by the calling process.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 334 of file Xpetra_TpetraMap_def.hpp.

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMaxGlobalIndex ( ) const

inlinevirtual

The maximum global index owned by the calling process.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 337 of file Xpetra_TpetraMap_def.hpp.

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMinAllGlobalIndex ( ) const

inlinevirtual

The minimum global index over all processes in the communicator.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 340 of file Xpetra_TpetraMap_def.hpp.

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMaxAllGlobalIndex ( ) const

inlinevirtual

The maximum global index over all processes in the communicator.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 343 of file Xpetra_TpetraMap_def.hpp.

LocalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getLocalElement ( GlobalOrdinal globalIndex ) const

inlinevirtual

The local index corresponding to the given global index.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 346 of file Xpetra_TpetraMap_def.hpp.

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getGlobalElement ( LocalOrdinal localIndex ) const

inlinevirtual

The global index corresponding to the given local index.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 349 of file Xpetra_TpetraMap_def.hpp.

LookupStatus Xpetra::TpetraMap< int, int, EpetraNode >::getRemoteIndexList	(	const Teuchos::ArrayView< const GlobalOrdinal > &	GIDList,
		const Teuchos::ArrayView< int > &	nodeIDList,
		const Teuchos::ArrayView< LocalOrdinal > &	LIDList
	)		const

inlinevirtual

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

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 352 of file Xpetra_TpetraMap_def.hpp.

LookupStatus Xpetra::TpetraMap< int, int, EpetraNode >::getRemoteIndexList	(	const Teuchos::ArrayView< const GlobalOrdinal > &	GIDList,
		const Teuchos::ArrayView< int > &	nodeIDList
	)		const

inlinevirtual

Return the process IDs for the given global IDs.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 355 of file Xpetra_TpetraMap_def.hpp.

Teuchos::ArrayView< const GlobalOrdinal > Xpetra::TpetraMap< int, int, EpetraNode >::getNodeElementList ( ) const

inlinevirtual

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

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 358 of file Xpetra_TpetraMap_def.hpp.

bool Xpetra::TpetraMap< int, int, EpetraNode >::isNodeLocalElement ( LocalOrdinal localIndex ) const

inlinevirtual

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

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 366 of file Xpetra_TpetraMap_def.hpp.

bool Xpetra::TpetraMap< int, int, EpetraNode >::isNodeGlobalElement ( GlobalOrdinal globalIndex ) const

inlinevirtual

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

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 369 of file Xpetra_TpetraMap_def.hpp.

bool Xpetra::TpetraMap< int, int, EpetraNode >::isContiguous ( ) const

inlinevirtual

True if this Map is distributed contiguously, else false.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 372 of file Xpetra_TpetraMap_def.hpp.

bool Xpetra::TpetraMap< int, int, EpetraNode >::isDistributed ( ) const

inlinevirtual

Whether this Map is globally distributed or locally replicated.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 375 of file Xpetra_TpetraMap_def.hpp.

bool Xpetra::TpetraMap< int, int, EpetraNode >::isCompatible ( const Map< LocalOrdinal, GlobalOrdinal, Node > & map ) const

inlinevirtual

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

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 378 of file Xpetra_TpetraMap_def.hpp.

bool Xpetra::TpetraMap< int, int, EpetraNode >::isSameAs ( const Map< LocalOrdinal, GlobalOrdinal, Node > & map ) const

inlinevirtual

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

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 381 of file Xpetra_TpetraMap_def.hpp.

Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::TpetraMap< int, int, EpetraNode >::getComm ( ) const

inlinevirtual

Get this Map's Comm object.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 389 of file Xpetra_TpetraMap_def.hpp.

std::string Xpetra::TpetraMap< int, int, EpetraNode >::description ( ) const

inlinevirtual

Return a simple one-line description of this object.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 398 of file Xpetra_TpetraMap_def.hpp.

void Xpetra::TpetraMap< int, int, EpetraNode >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = `Teuchos::Describable::verbLevel_default`
	)		const

inlinevirtual

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

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 401 of file Xpetra_TpetraMap_def.hpp.

RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraMap< int, int, EpetraNode >::removeEmptyProcesses ( ) const

inlinevirtual

Return a new Map with processes with zero elements removed.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 403 of file Xpetra_TpetraMap_def.hpp.

RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraMap< int, int, EpetraNode >::replaceCommWithSubset ( const Teuchos::RCP< const Teuchos::Comm< int > > & newComm ) const

inlinevirtual

Replace this Map's communicator with a subset communicator.

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 404 of file Xpetra_TpetraMap_def.hpp.

UnderlyingLib Xpetra::TpetraMap< int, int, EpetraNode >::lib ( ) const

inlinevirtual

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

Implements Xpetra::Map< int, int, EpetraNode >.

Definition at line 417 of file Xpetra_TpetraMap_def.hpp.

RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMap< int, int, EpetraNode >::getTpetra_Map ( ) const

inline

Get the underlying Tpetra map.

Definition at line 420 of file Xpetra_TpetraMap_def.hpp.

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

Xpetra_TpetraMap_def.hpp

Public Types

Constructors and destructor

Attributes

Boolean tests

Xpetra specific

Detailed Description

template<> class Xpetra::TpetraMap< int, int, EpetraNode >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<>
class Xpetra::TpetraMap< int, int, EpetraNode >