#include <Xpetra_TpetraMap.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...

Additional Inherited Members
Public Member Functions inherited from Xpetra::Map< int, int, EpetraNode >
virtual	~Map ()
	Destructor. More...

virtual RCP< const Xpetra::Map < int, int, EpetraNode > >	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)

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

Detailed Description

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

Definition at line 425 of file Xpetra_TpetraMap.hpp.

Member Typedef Documentation

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

Definition at line 429 of file Xpetra_TpetraMap.hpp.

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

Definition at line 430 of file Xpetra_TpetraMap.hpp.

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

Definition at line 431 of file Xpetra_TpetraMap.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 447 of file Xpetra_TpetraMap.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 465 of file Xpetra_TpetraMap.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 483 of file Xpetra_TpetraMap.hpp.

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

inline

Destructor.

Definition at line 491 of file Xpetra_TpetraMap.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 600 of file Xpetra_TpetraMap.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 499 of file Xpetra_TpetraMap.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 502 of file Xpetra_TpetraMap.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 505 of file Xpetra_TpetraMap.hpp.

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

inlinevirtual

The minimum local index.

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

Definition at line 508 of file Xpetra_TpetraMap.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 511 of file Xpetra_TpetraMap.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 514 of file Xpetra_TpetraMap.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 517 of file Xpetra_TpetraMap.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 520 of file Xpetra_TpetraMap.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 523 of file Xpetra_TpetraMap.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 526 of file Xpetra_TpetraMap.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 529 of file Xpetra_TpetraMap.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 532 of file Xpetra_TpetraMap.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 535 of file Xpetra_TpetraMap.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 538 of file Xpetra_TpetraMap.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 546 of file Xpetra_TpetraMap.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 549 of file Xpetra_TpetraMap.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 552 of file Xpetra_TpetraMap.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 555 of file Xpetra_TpetraMap.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 558 of file Xpetra_TpetraMap.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 561 of file Xpetra_TpetraMap.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 569 of file Xpetra_TpetraMap.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 582 of file Xpetra_TpetraMap.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 585 of file Xpetra_TpetraMap.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 587 of file Xpetra_TpetraMap.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 588 of file Xpetra_TpetraMap.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 605 of file Xpetra_TpetraMap.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 608 of file Xpetra_TpetraMap.hpp.

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

Xpetra_TpetraMap.hpp

Public Types

Constructors and destructor

Attributes

Boolean tests

Xpetra specific

Additional Inherited Members

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 >