#include <Xpetra_TpetraMap_def.hpp>

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

Public Types
typedef long long	GlobalOrdinal

typedef int	LocalOrdinal

typedef EpetraNode	Node

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

typedef long long	global_ordinal_type

typedef EpetraNode	node_type

typedef Kokkos::View< const global_ordinal_type *, typename Node::device_type >	global_indices_array_device_type

typedef Tpetra::Map< int, long long, EpetraNode >::local_map_type	local_map_type

Xpetra specific
using	local_map_type = typename Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_type

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

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

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

local_map_type	getLocalMap () const
	Get the local Map for Kokkos kernels.

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.

	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.

	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.

	~TpetraMap ()
	Destructor.

Attributes
global_size_t	getGlobalNumElements () const
	The number of elements in this Map.

size_t	getLocalNumElements () const
	The number of elements belonging to the calling node.

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.

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

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.

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

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

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

bool	isNodeGlobalElement (GlobalOrdinal globalIndex) const
	True if the global index is found in this Map on this node, else false.

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.

Additional Inherited Members
Public Member Functions inherited from Xpetra::Map< int, long long, EpetraNode >
virtual RCP< const Xpetra::Map< int, long long, EpetraNode > >	getMap () const

virtual	~Map ()
	Destructor.

virtual global_indices_array_device_type	getMyGlobalIndicesDevice () const=0
	Return a view of the global indices owned by this process on the Map's device.

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 420 of file Xpetra_TpetraMap_def.hpp.

Member Typedef Documentation

◆ GlobalOrdinal

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

Definition at line 423 of file Xpetra_TpetraMap_def.hpp.

◆ LocalOrdinal

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

Definition at line 424 of file Xpetra_TpetraMap_def.hpp.

◆ Node

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

Definition at line 425 of file Xpetra_TpetraMap_def.hpp.

◆ local_map_type

using Xpetra::TpetraMap< int, long long, EpetraNode >::local_map_type = typename Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type

Definition at line 566 of file Xpetra_TpetraMap_def.hpp.

Constructor & Destructor Documentation

◆ TpetraMap() [1/4]

Xpetra::TpetraMap< int, long long, 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 431 of file Xpetra_TpetraMap_def.hpp.

◆ TpetraMap() [2/4]

Xpetra::TpetraMap< int, long long, 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 439 of file Xpetra_TpetraMap_def.hpp.

◆ TpetraMap() [3/4]

Xpetra::TpetraMap< int, long long, 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 447 of file Xpetra_TpetraMap_def.hpp.

◆ ~TpetraMap()

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

inline

Destructor.

Definition at line 455 of file Xpetra_TpetraMap_def.hpp.

◆ TpetraMap() [4/4]

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

inline

TpetraMap constructor to wrap a Tpetra::Map object.

Definition at line 555 of file Xpetra_TpetraMap_def.hpp.

Member Function Documentation

◆ getGlobalNumElements()

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

inlinevirtual

The number of elements in this Map.

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

Definition at line 463 of file Xpetra_TpetraMap_def.hpp.

◆ getLocalNumElements()

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

inlinevirtual

The number of elements belonging to the calling node.

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

Definition at line 466 of file Xpetra_TpetraMap_def.hpp.

◆ getIndexBase()

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

inlinevirtual

The index base for this Map.

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

Definition at line 469 of file Xpetra_TpetraMap_def.hpp.

◆ getMinLocalIndex()

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

inlinevirtual

The minimum local index.

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

Definition at line 472 of file Xpetra_TpetraMap_def.hpp.

◆ getMaxLocalIndex()

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

inlinevirtual

The maximum local index on the calling process.

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

Definition at line 475 of file Xpetra_TpetraMap_def.hpp.

◆ getMinGlobalIndex()

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

inlinevirtual

The minimum global index owned by the calling process.

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

Definition at line 478 of file Xpetra_TpetraMap_def.hpp.

◆ getMaxGlobalIndex()

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

inlinevirtual

The maximum global index owned by the calling process.

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

Definition at line 481 of file Xpetra_TpetraMap_def.hpp.

◆ getMinAllGlobalIndex()

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

inlinevirtual

The minimum global index over all processes in the communicator.

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

Definition at line 484 of file Xpetra_TpetraMap_def.hpp.

◆ getMaxAllGlobalIndex()

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

inlinevirtual

The maximum global index over all processes in the communicator.

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

Definition at line 487 of file Xpetra_TpetraMap_def.hpp.

◆ getLocalElement()

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

inlinevirtual

The local index corresponding to the given global index.

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

Definition at line 490 of file Xpetra_TpetraMap_def.hpp.

◆ getGlobalElement()

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

inlinevirtual

The global index corresponding to the given local index.

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

Definition at line 493 of file Xpetra_TpetraMap_def.hpp.

◆ getRemoteIndexList() [1/2]

LookupStatus Xpetra::TpetraMap< int, long long, 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, long long, EpetraNode >.

Definition at line 496 of file Xpetra_TpetraMap_def.hpp.

◆ getRemoteIndexList() [2/2]

LookupStatus Xpetra::TpetraMap< int, long long, 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, long long, EpetraNode >.

Definition at line 499 of file Xpetra_TpetraMap_def.hpp.

◆ getLocalElementList()

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

inlinevirtual

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

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

Definition at line 502 of file Xpetra_TpetraMap_def.hpp.

◆ isNodeLocalElement()

bool Xpetra::TpetraMap< int, long long, 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, long long, EpetraNode >.

Definition at line 510 of file Xpetra_TpetraMap_def.hpp.

◆ isNodeGlobalElement()

bool Xpetra::TpetraMap< int, long long, 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, long long, EpetraNode >.

Definition at line 513 of file Xpetra_TpetraMap_def.hpp.

◆ isContiguous()

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

inlinevirtual

True if this Map is distributed contiguously, else false.

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

Definition at line 516 of file Xpetra_TpetraMap_def.hpp.

◆ isDistributed()

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

inlinevirtual

Whether this Map is globally distributed or locally replicated.

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

Definition at line 519 of file Xpetra_TpetraMap_def.hpp.

◆ isCompatible()

bool Xpetra::TpetraMap< int, long long, 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, long long, EpetraNode >.

Definition at line 522 of file Xpetra_TpetraMap_def.hpp.

◆ isSameAs()

bool Xpetra::TpetraMap< int, long long, 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, long long, EpetraNode >.

Definition at line 525 of file Xpetra_TpetraMap_def.hpp.

◆ getComm()

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

inlinevirtual

Get this Map's Comm object.

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

Definition at line 533 of file Xpetra_TpetraMap_def.hpp.

◆ description()

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

inlinevirtual

Return a simple one-line description of this object.

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

Definition at line 541 of file Xpetra_TpetraMap_def.hpp.

◆ describe()

void Xpetra::TpetraMap< int, long long, 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, long long, EpetraNode >.

Definition at line 544 of file Xpetra_TpetraMap_def.hpp.

◆ removeEmptyProcesses()

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

inlinevirtual

Return a new Map with processes with zero elements removed.

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

Definition at line 546 of file Xpetra_TpetraMap_def.hpp.

◆ replaceCommWithSubset()

RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMap< int, long long, 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, long long, EpetraNode >.

Definition at line 547 of file Xpetra_TpetraMap_def.hpp.

◆ lib()

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

inlinevirtual

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

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

Definition at line 560 of file Xpetra_TpetraMap_def.hpp.

◆ getTpetra_Map()

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

inline

Get the underlying Tpetra map.

Definition at line 563 of file Xpetra_TpetraMap_def.hpp.

◆ getLocalMap()

local_map_type Xpetra::TpetraMap< int, long long, EpetraNode >::getLocalMap ( ) const

inlinevirtual

Get the local Map for Kokkos kernels.

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

Definition at line 568 of file Xpetra_TpetraMap_def.hpp.

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

Xpetra_TpetraMap_def.hpp

Public Types

Xpetra specific

Constructors and destructor

Attributes

Boolean tests

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ GlobalOrdinal

◆ LocalOrdinal

◆ Node

◆ local_map_type

Constructor & Destructor Documentation

◆ TpetraMap() [1/4]

◆ TpetraMap() [2/4]

◆ TpetraMap() [3/4]

◆ ~TpetraMap()

◆ TpetraMap() [4/4]

Member Function Documentation

◆ getGlobalNumElements()

◆ getLocalNumElements()

◆ getIndexBase()

◆ getMinLocalIndex()

◆ getMaxLocalIndex()

◆ getMinGlobalIndex()

◆ getMaxGlobalIndex()

◆ getMinAllGlobalIndex()

◆ getMaxAllGlobalIndex()

◆ getLocalElement()

◆ getGlobalElement()

◆ getRemoteIndexList() [1/2]

◆ getRemoteIndexList() [2/2]

◆ getLocalElementList()

◆ isNodeLocalElement()

◆ isNodeGlobalElement()

◆ isContiguous()

◆ isDistributed()

◆ isCompatible()

◆ isSameAs()

◆ getComm()

◆ description()

◆ describe()

◆ removeEmptyProcesses()

◆ replaceCommWithSubset()

◆ lib()

◆ getTpetra_Map()

◆ getLocalMap()