#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, const Teuchos::RCP< Node > &node=Teuchos::rcp(new Node))
	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, const Teuchos::RCP< Node > &node=Teuchos::rcp(new Node))
	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, const Teuchos::RCP< Node > &node=Teuchos::rcp(new Node))
	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...

Teuchos::RCP< Node >	getNode () const
	Get this Map's Node 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

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

template<class Node2 >
RCP< Map< LocalOrdinal, GlobalOrdinal, Node2 > >	clone (const RCP< Node2 > &node2) const

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 global_size_t	getGlobalNumElements () const=0
	The number of elements in this Map. More...

virtual size_t	getNodeNumElements () const=0
	The number of elements belonging to the calling process. More...

virtual int	getIndexBase () const=0
	The index base for this Map. More...

virtual int	getMinLocalIndex () const=0
	The minimum local index. More...

virtual int	getMaxLocalIndex () const=0
	The maximum local index on the calling process. More...

virtual int	getMinGlobalIndex () const=0
	The minimum global index owned by the calling process. More...

virtual int	getMaxGlobalIndex () const=0
	The maximum global index owned by the calling process. More...

virtual int	getMinAllGlobalIndex () const=0
	The minimum global index over all processes in the communicator. More...

virtual int	getMaxAllGlobalIndex () const=0
	The maximum global index over all processes in the communicator. More...

virtual Teuchos::ArrayView< const int >	getNodeElementList () const=0
	Return a view of the global indices owned by this process. More...

virtual bool	isContiguous () const=0
	True if this Map is distributed contiguously, else false. More...

virtual bool	isDistributed () const=0
	Whether this Map is globally distributed or locally replicated. More...

virtual Teuchos::RCP< const Teuchos::Comm< int > >	getComm () const=0
	Get this Map's Comm object. More...

virtual Teuchos::RCP< EpetraNode >	getNode () const=0
	Get this Map's Node object. More...

virtual std::string	description () const=0
	Return a simple one-line description of this object. More...

virtual RCP< const Map< int, int, EpetraNode > >	removeEmptyProcesses () const=0
	Return a new Map with processes with zero elements removed. More...

virtual UnderlyingLib	lib () const=0
	Get the library used by this object (Tpetra or Epetra?) 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 ()

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

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

Detailed Description

Definition at line 356 of file Xpetra_TpetraMap.hpp.

Member Typedef Documentation

◆ GlobalOrdinal

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

Definition at line 360 of file Xpetra_TpetraMap.hpp.

◆ LocalOrdinal

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

Definition at line 361 of file Xpetra_TpetraMap.hpp.

◆ Node

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

Definition at line 362 of file Xpetra_TpetraMap.hpp.

Constructor & Destructor Documentation

◆ TpetraMap() [1/4]

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap	(	global_size_t	numGlobalElements,
		GlobalOrdinal	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		LocalGlobal	lg = `GloballyDistributed`,
		const Teuchos::RCP< Node > &	node = `Teuchos::rcp(new Node)`
	)

inline

Constructor with Tpetra-defined contiguous uniform distribution.

Definition at line 368 of file Xpetra_TpetraMap.hpp.

◆ TpetraMap() [2/4]

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap	(	global_size_t	numGlobalElements,
		size_t	numLocalElements,
		GlobalOrdinal	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		const Teuchos::RCP< Node > &	node = `Teuchos::rcp(new Node)`
	)

inline

Constructor with a user-defined contiguous distribution.

Definition at line 377 of file Xpetra_TpetraMap.hpp.

◆ TpetraMap() [3/4]

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,
		const Teuchos::RCP< Node > &	node = `Teuchos::rcp(new Node)`
	)

inline

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

Definition at line 386 of file Xpetra_TpetraMap.hpp.

◆ ~TpetraMap()

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

inline

Destructor.

Definition at line 395 of file Xpetra_TpetraMap.hpp.

◆ TpetraMap() [4/4]

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 501 of file Xpetra_TpetraMap.hpp.

Member Function Documentation

◆ getGlobalNumElements()

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

inline

The number of elements in this Map.

Definition at line 403 of file Xpetra_TpetraMap.hpp.

◆ getNodeNumElements()

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

inline

The number of elements belonging to the calling node.

Definition at line 406 of file Xpetra_TpetraMap.hpp.

◆ getIndexBase()

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

inline

The index base for this Map.

Definition at line 409 of file Xpetra_TpetraMap.hpp.

◆ getMinLocalIndex()

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

inline

The minimum local index.

Definition at line 412 of file Xpetra_TpetraMap.hpp.

◆ getMaxLocalIndex()

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

inline

The maximum local index on the calling process.

Definition at line 415 of file Xpetra_TpetraMap.hpp.

◆ getMinGlobalIndex()

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

inline

The minimum global index owned by the calling process.

Definition at line 418 of file Xpetra_TpetraMap.hpp.

◆ getMaxGlobalIndex()

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

inline

The maximum global index owned by the calling process.

Definition at line 421 of file Xpetra_TpetraMap.hpp.

◆ getMinAllGlobalIndex()

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

inline

The minimum global index over all processes in the communicator.

Definition at line 424 of file Xpetra_TpetraMap.hpp.

◆ getMaxAllGlobalIndex()

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

inline

The maximum global index over all processes in the communicator.

Definition at line 427 of file Xpetra_TpetraMap.hpp.

◆ getLocalElement()

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 430 of file Xpetra_TpetraMap.hpp.

◆ getGlobalElement()

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 433 of file Xpetra_TpetraMap.hpp.

◆ getRemoteIndexList() [1/2]

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 436 of file Xpetra_TpetraMap.hpp.

◆ getRemoteIndexList() [2/2]

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 439 of file Xpetra_TpetraMap.hpp.

◆ getNodeElementList()

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

inline

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

Definition at line 442 of file Xpetra_TpetraMap.hpp.

◆ isNodeLocalElement()

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 450 of file Xpetra_TpetraMap.hpp.

◆ isNodeGlobalElement()

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 453 of file Xpetra_TpetraMap.hpp.

◆ isContiguous()

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

inline

True if this Map is distributed contiguously, else false.

Definition at line 456 of file Xpetra_TpetraMap.hpp.

◆ isDistributed()

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

inline

Whether this Map is globally distributed or locally replicated.

Definition at line 459 of file Xpetra_TpetraMap.hpp.

◆ isCompatible()

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 462 of file Xpetra_TpetraMap.hpp.

◆ isSameAs()

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 465 of file Xpetra_TpetraMap.hpp.

◆ getComm()

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

inline

Get this Map's Comm object.

Definition at line 473 of file Xpetra_TpetraMap.hpp.

◆ getNode()

Teuchos::RCP< Node > Xpetra::TpetraMap< int, int, EpetraNode >::getNode ( ) const

inline

Get this Map's Node object.

Definition at line 476 of file Xpetra_TpetraMap.hpp.

◆ description()

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

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from Teuchos::Describable.

Definition at line 484 of file Xpetra_TpetraMap.hpp.

◆ describe()

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 487 of file Xpetra_TpetraMap.hpp.

◆ removeEmptyProcesses()

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

inline

Definition at line 489 of file Xpetra_TpetraMap.hpp.

◆ replaceCommWithSubset()

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 490 of file Xpetra_TpetraMap.hpp.

◆ clone()

template<class Node2 >

RCP<Map<LocalOrdinal, GlobalOrdinal, Node2> > Xpetra::TpetraMap< int, int, EpetraNode >::clone ( const RCP< Node2 > & node2 ) const

inline

Definition at line 493 of file Xpetra_TpetraMap.hpp.

◆ lib()

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

inline

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

Definition at line 506 of file Xpetra_TpetraMap.hpp.

◆ getTpetra_Map()

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

inline

Get the underlying Tpetra map.

Definition at line 509 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

Member Typedef Documentation

◆ GlobalOrdinal

◆ LocalOrdinal

◆ Node

Constructor & Destructor Documentation

◆ TpetraMap() [1/4]

◆ TpetraMap() [2/4]

◆ TpetraMap() [3/4]

◆ ~TpetraMap()

◆ TpetraMap() [4/4]

Member Function Documentation

◆ getGlobalNumElements()

◆ getNodeNumElements()

◆ getIndexBase()

◆ getMinLocalIndex()

◆ getMaxLocalIndex()

◆ getMinGlobalIndex()

◆ getMaxGlobalIndex()

◆ getMinAllGlobalIndex()

◆ getMaxAllGlobalIndex()

◆ getLocalElement()

◆ getGlobalElement()

◆ getRemoteIndexList() [1/2]

◆ getRemoteIndexList() [2/2]

◆ getNodeElementList()

◆ isNodeLocalElement()

◆ isNodeGlobalElement()

◆ isContiguous()

◆ isDistributed()

◆ isCompatible()

◆ isSameAs()

◆ getComm()

◆ getNode()

◆ description()

◆ describe()

◆ removeEmptyProcesses()

◆ replaceCommWithSubset()

◆ clone()

◆ lib()

◆ getTpetra_Map()