#include <Xpetra_TpetraMap.hpp>

Inheritance diagram for Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >:

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
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	map_

	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 Types inherited from Xpetra::Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type, typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type >
typedef Map<>::local_ordinal_type	local_ordinal_type

typedef typename Map< Map<>::local_ordinal_type >::global_ordinal_type	global_ordinal_type

typedef typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type	node_type

Public Member Functions inherited from Xpetra::Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type, typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type >
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 typename Map< Map<>::local_ordinal_type >::global_ordinal_type	getIndexBase () const=0
	The index base for this Map. More...

virtual Map<>::local_ordinal_type	getMinLocalIndex () const=0
	The minimum local index. More...

virtual Map<>::local_ordinal_type	getMaxLocalIndex () const=0
	The maximum local index on the calling process. More...

virtual typename Map< Map<>::local_ordinal_type >::global_ordinal_type	getMinGlobalIndex () const=0
	The minimum global index owned by the calling process. More...

virtual typename Map< Map<>::local_ordinal_type >::global_ordinal_type	getMaxGlobalIndex () const=0
	The maximum global index owned by the calling process. More...

virtual typename Map< Map<>::local_ordinal_type >::global_ordinal_type	getMinAllGlobalIndex () const=0
	The minimum global index over all processes in the communicator. More...

virtual typename Map< Map<>::local_ordinal_type >::global_ordinal_type	getMaxAllGlobalIndex () const=0
	The maximum global index over all processes in the communicator. More...

virtual Map<>::local_ordinal_type	getLocalElement (typename Map< Map<>::local_ordinal_type >::global_ordinal_type globalIndex) const=0
	The local index corresponding to the given global index. More...

virtual typename Map< Map<>::local_ordinal_type >::global_ordinal_type	getGlobalElement (Map<>::local_ordinal_type localIndex) const=0
	The global index corresponding to the given local index. More...

virtual LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const typename Map< Map<>::local_ordinal_type >::global_ordinal_type > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< Map<>::local_ordinal_type > &LIDList) const=0
	Return the process ranks and corresponding local indices for the given global indices. More...

virtual LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const typename Map< Map<>::local_ordinal_type >::global_ordinal_type > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const=0
	Return the process ranks for the given global indices. More...

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

virtual bool	isNodeLocalElement (Map<>::local_ordinal_type localIndex) const=0
	Whether the given local index is valid for this Map on this process. More...

virtual bool	isNodeGlobalElement (typename Map< Map<>::local_ordinal_type >::global_ordinal_type globalIndex) const=0
	Whether the given global index is valid for this Map on 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 bool	isCompatible (const Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type, typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type > &map) const=0
	True if and only if map is compatible with this Map. More...

virtual bool	isSameAs (const Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type, typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type > &map) const=0
	True if and only if map is identical to this Map. More...

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

virtual Teuchos::RCP< typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type >	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< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type, typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type > >	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< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type, typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type > >	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

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 79 of file Xpetra_TpetraMap.hpp.

Constructor & Destructor Documentation

◆ TpetraMap() [1/4]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::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 88 of file Xpetra_TpetraMap.hpp.

◆ TpetraMap() [2/4]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::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 99 of file Xpetra_TpetraMap.hpp.

◆ TpetraMap() [3/4]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::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 111 of file Xpetra_TpetraMap.hpp.

◆ ~TpetraMap()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::~TpetraMap ( )

inline

Destructor.

Definition at line 122 of file Xpetra_TpetraMap.hpp.

◆ TpetraMap() [4/4]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

TpetraMap constructor to wrap a Tpetra::Map object.

Definition at line 234 of file Xpetra_TpetraMap.hpp.

Member Function Documentation

◆ getGlobalNumElements()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

global_size_t Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumElements ( ) const

inline

The number of elements in this Map.

Definition at line 130 of file Xpetra_TpetraMap.hpp.

◆ getNodeNumElements()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

size_t Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumElements ( ) const

inline

The number of elements belonging to the calling node.

Definition at line 133 of file Xpetra_TpetraMap.hpp.

◆ getIndexBase()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase ( ) const

inline

The index base for this Map.

Definition at line 136 of file Xpetra_TpetraMap.hpp.

◆ getMinLocalIndex()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

LocalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinLocalIndex ( ) const

inline

The minimum local index.

Definition at line 139 of file Xpetra_TpetraMap.hpp.

◆ getMaxLocalIndex()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

LocalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxLocalIndex ( ) const

inline

The maximum local index on the calling process.

Definition at line 142 of file Xpetra_TpetraMap.hpp.

◆ getMinGlobalIndex()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinGlobalIndex ( ) const

inline

The minimum global index owned by the calling process.

Definition at line 145 of file Xpetra_TpetraMap.hpp.

◆ getMaxGlobalIndex()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxGlobalIndex ( ) const

inline

The maximum global index owned by the calling process.

Definition at line 148 of file Xpetra_TpetraMap.hpp.

◆ getMinAllGlobalIndex()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMinAllGlobalIndex ( ) const

inline

The minimum global index over all processes in the communicator.

Definition at line 151 of file Xpetra_TpetraMap.hpp.

◆ getMaxAllGlobalIndex()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

GlobalOrdinal Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxAllGlobalIndex ( ) const

inline

The maximum global index over all processes in the communicator.

Definition at line 154 of file Xpetra_TpetraMap.hpp.

◆ getLocalElement()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

The local index corresponding to the given global index.

Definition at line 157 of file Xpetra_TpetraMap.hpp.

◆ getGlobalElement()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

The global index corresponding to the given local index.

Definition at line 160 of file Xpetra_TpetraMap.hpp.

◆ getRemoteIndexList() [1/2]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

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

Definition at line 163 of file Xpetra_TpetraMap.hpp.

◆ getRemoteIndexList() [2/2]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

Return the process IDs for the given global IDs.

Definition at line 166 of file Xpetra_TpetraMap.hpp.

◆ getNodeElementList()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

Teuchos::ArrayView< const GlobalOrdinal > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeElementList ( ) const

inline

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

Definition at line 169 of file Xpetra_TpetraMap.hpp.

◆ isNodeLocalElement()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isNodeLocalElement ( LocalOrdinal localIndex ) const

inline

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

Definition at line 177 of file Xpetra_TpetraMap.hpp.

◆ isNodeGlobalElement()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isNodeGlobalElement ( GlobalOrdinal globalIndex ) const

inline

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

Definition at line 180 of file Xpetra_TpetraMap.hpp.

◆ isContiguous()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isContiguous ( ) const

inline

True if this Map is distributed contiguously, else false.

Definition at line 183 of file Xpetra_TpetraMap.hpp.

◆ isDistributed()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

bool Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::isDistributed ( ) const

inline

Whether this Map is globally distributed or locally replicated.

Definition at line 186 of file Xpetra_TpetraMap.hpp.

◆ isCompatible()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

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

Definition at line 189 of file Xpetra_TpetraMap.hpp.

◆ isSameAs()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

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

Definition at line 192 of file Xpetra_TpetraMap.hpp.

◆ getComm()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getComm ( ) const

inline

Get this Map's Comm object.

Definition at line 200 of file Xpetra_TpetraMap.hpp.

◆ getNode()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

Teuchos::RCP< Node > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::getNode ( ) const

inline

Get this Map's Node object.

Definition at line 203 of file Xpetra_TpetraMap.hpp.

◆ description()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

std::string Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from Teuchos::Describable.

Definition at line 211 of file Xpetra_TpetraMap.hpp.

◆ describe()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

void Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::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< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type, typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 214 of file Xpetra_TpetraMap.hpp.

◆ removeEmptyProcesses()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

Definition at line 216 of file Xpetra_TpetraMap.hpp.

◆ replaceCommWithSubset()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inlinevirtual

Replace this Map's communicator with a subset communicator.

Implements Xpetra::Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type, typename Map< Map<>::local_ordinal_type, typename Map< Map<>::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 219 of file Xpetra_TpetraMap.hpp.

◆ clone()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

template<class Node2 >

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

inline

Definition at line 224 of file Xpetra_TpetraMap.hpp.

◆ lib()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

UnderlyingLib Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::lib ( ) const

inline

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

Definition at line 238 of file Xpetra_TpetraMap.hpp.

◆ getTpetra_Map()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

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

inline

Get the underlying Tpetra map.

Definition at line 241 of file Xpetra_TpetraMap.hpp.

Member Data Documentation

◆ map_

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>

RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >::map_

protected

Definition at line 257 of file Xpetra_TpetraMap.hpp.

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

Xpetra_TpetraMap.hpp

Constructors and destructor

Attributes

Boolean tests

Xpetra specific

Additional Inherited Members

Detailed Description

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type> class Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, 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()

Member Data Documentation

◆ map_

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::TpetraMap< LocalOrdinal, GlobalOrdinal, Node >