#include <Xpetra_EpetraMap.hpp>

Inheritance diagram for Xpetra::EpetraMapT< long long, EpetraNode >:

Public Types
typedef LocalOrdinal	local_ordinal_type

typedef GlobalOrdinal	global_ordinal_type

typedef Node	node_type

typedef int	local_ordinal_type

typedef long long	global_ordinal_type

typedef EpetraNode	node_type

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 Tpetra::Map< int, long long, EpetraNode >::local_map_type	local_map_type

Private Types
typedef int	LocalOrdinal

typedef long long	GlobalOrdinal

typedef EpetraNode	Node

typedef int	LocalOrdinal

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

local_map_type	localMap_

RCP< const Epetra_BlockMap >	map_

virtual	~EpetraMapT ()
	Destructor.

	EpetraMapT (const Teuchos::RCP< const Epetra_BlockMap > &map)
	EpetraMapT constructor to wrap a Epetra_Map object.

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

const RCP< const Epetra_Map > &	getEpetra_MapRCP () const
	Get the underlying Epetra map.

const Epetra_BlockMap &	getEpetra_BlockMap () const

const Epetra_Map &	getEpetra_Map () const

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

Xpetra specific
using	local_map_type

RCP< const Epetra_BlockMap >	map_

	EpetraMapT (const Teuchos::RCP< const Epetra_BlockMap > &map)
	EpetraMapT constructor to wrap a Epetra_Map object.

virtual	~EpetraMapT ()
	Destructor.

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

const RCP< const Epetra_Map > &	getEpetra_MapRCP () const
	Get the underlying Epetra map.

const Epetra_BlockMap &	getEpetra_BlockMap () const

const Epetra_Map &	getEpetra_Map () const

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

Constructors and destructor
	EpetraMapT (global_size_t numGlobalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=GloballyDistributed)
	Constructor with Tpetra-defined contiguous uniform distribution.

	EpetraMapT (global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
	Constructor with a user-defined contiguous distribution.

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

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

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.

LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const
	Return the process ranks and corresponding local indices for the given global indices.

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

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

Boolean tests
bool	isNodeLocalElement (LocalOrdinal localIndex) const
	Whether the given local index is valid for this Map on this process.

bool	isNodeGlobalElement (GlobalOrdinal globalIndex) const
	Whether the given global index is valid for this Map on this process.

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.

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

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

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 Teuchos::FancyOStream.

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

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

GlobalOrdinal	getGlobalElement (LocalOrdinal localIndex) const
	Return the global index for a given local index. Note that this returns -1 if not found on this processor. (This is different than Epetra's behavior!)

Constructors and destructor
	EpetraMapT (global_size_t numGlobalElements, long long indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=GloballyDistributed)
	Constructor with Tpetra-defined contiguous uniform distribution.

	EpetraMapT (global_size_t numGlobalElements, size_t numLocalElements, long long indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
	Constructor with a user-defined contiguous distribution.

	EpetraMapT (global_size_t numGlobalElements, const Teuchos::ArrayView< const long long > &elementList, long long indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
	Constructor with user-defined arbitrary (possibly noncontiguous) distribution.

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

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

long long	getMinGlobalIndex () const
	The minimum global index owned by the calling process.

long long	getMaxGlobalIndex () const
	The maximum global index owned by the calling process.

long long	getMinAllGlobalIndex () const
	The minimum global index over all processes in the communicator.

long long	getMaxAllGlobalIndex () const
	The maximum global index over all processes in the communicator.

LocalOrdinal	getLocalElement (long long) const
	The local index corresponding to the given global index.

LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const long long > &, const Teuchos::ArrayView< int > &, const Teuchos::ArrayView< LocalOrdinal > &) const
	Return the process ranks and corresponding local indices for the given global indices.

LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const long long > &, const Teuchos::ArrayView< int > &) const
	Return the process ranks for the given global indices.

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

Boolean tests
bool	isNodeLocalElement (LocalOrdinal) const
	Whether the given local index is valid for this Map on this process.

bool	isNodeGlobalElement (long long) const
	Whether the given global index is valid for this Map on this process.

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, long long, EpetraNode > &) const
	True if and only if map is compatible with this Map.

bool	isSameAs (const Map< LocalOrdinal, long long, EpetraNode > &) const
	True if and only if map is identical to this Map.

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

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

void	describe (Teuchos::FancyOStream &, const Teuchos::EVerbosityLevel=Teuchos::Describable::verbLevel_default) const
	Print this object with the given verbosity level to the given Teuchos::FancyOStream.

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

RCP< const Map< int, long long, EpetraNode > >	replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &) const
	Replace this Map's communicator with a subset communicator.

long long	getGlobalElement (LocalOrdinal) const
	Return the global index for a given local index. Note that this returns -1 if not found on this processor. (This is different than Epetra's behavior!)

Additional Inherited Members
virtual RCP< const Xpetra::Map< int, long long, EpetraNode > >	getMap () const

virtual	~Map ()
	Destructor.

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 718 of file Xpetra_EpetraMap.hpp.

Member Typedef Documentation

◆ LocalOrdinal [1/2]

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

private

Definition at line 721 of file Xpetra_EpetraMap.hpp.

◆ GlobalOrdinal

typedef long long Xpetra::EpetraMapT< long long, EpetraNode >::GlobalOrdinal

private

Definition at line 722 of file Xpetra_EpetraMap.hpp.

◆ Node

typedef EpetraNode Xpetra::EpetraMapT< long long, EpetraNode >::Node

private

Definition at line 723 of file Xpetra_EpetraMap.hpp.

◆ local_ordinal_type [1/2]

typedef LocalOrdinal Xpetra::EpetraMapT< long long, EpetraNode >::local_ordinal_type

Definition at line 726 of file Xpetra_EpetraMap.hpp.

◆ global_ordinal_type [1/2]

typedef GlobalOrdinal Xpetra::EpetraMapT< long long, EpetraNode >::global_ordinal_type

Definition at line 727 of file Xpetra_EpetraMap.hpp.

◆ node_type [1/2]

typedef Node Xpetra::EpetraMapT< long long, EpetraNode >::node_type

Definition at line 728 of file Xpetra_EpetraMap.hpp.

◆ local_map_type [1/2]

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

Definition at line 1127 of file Xpetra_EpetraMap.hpp.

◆ LocalOrdinal [2/2]

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

private

Definition at line 83 of file Xpetra_EpetraMap.hpp.

◆ local_ordinal_type [2/2]

typedef int Xpetra::EpetraMapT< long long, EpetraNode >::local_ordinal_type

Definition at line 86 of file Xpetra_EpetraMap.hpp.

◆ global_ordinal_type [2/2]

typedef long long Xpetra::EpetraMapT< long long, EpetraNode >::global_ordinal_type

Definition at line 87 of file Xpetra_EpetraMap.hpp.

◆ node_type [2/2]

typedef EpetraNode Xpetra::EpetraMapT< long long, EpetraNode >::node_type

Definition at line 88 of file Xpetra_EpetraMap.hpp.

◆ local_map_type [2/2]

using Xpetra::EpetraMapT< long long, EpetraNode >::local_map_type

Definition at line 244 of file Xpetra_EpetraMap.hpp.

Constructor & Destructor Documentation

◆ EpetraMapT() [1/8]

Xpetra::EpetraMapT< long long, EpetraNode >::EpetraMapT	(	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 734 of file Xpetra_EpetraMap.hpp.

◆ EpetraMapT() [2/8]

Xpetra::EpetraMapT< long long, EpetraNode >::EpetraMapT	(	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 789 of file Xpetra_EpetraMap.hpp.

◆ EpetraMapT() [3/8]

Xpetra::EpetraMapT< long long, EpetraNode >::EpetraMapT	(	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 888 of file Xpetra_EpetraMap.hpp.

◆ ~EpetraMapT() [1/2]

virtual Xpetra::EpetraMapT< long long, EpetraNode >::~EpetraMapT ( )

inlinevirtual

Destructor.

Definition at line 1110 of file Xpetra_EpetraMap.hpp.

◆ EpetraMapT() [4/8]

Xpetra::EpetraMapT< long long, EpetraNode >::EpetraMapT ( const Teuchos::RCP< const Epetra_BlockMap > & map )

inline

EpetraMapT constructor to wrap a Epetra_Map object.

Definition at line 1113 of file Xpetra_EpetraMap.hpp.

◆ EpetraMapT() [5/8]

Xpetra::EpetraMapT< long long, EpetraNode >::EpetraMapT	(	global_size_t	numGlobalElements,
		long long	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		LocalGlobal	lg = GloballyDistributed )

inline

Constructor with Tpetra-defined contiguous uniform distribution.

Definition at line 94 of file Xpetra_EpetraMap.hpp.

◆ EpetraMapT() [6/8]

Xpetra::EpetraMapT< long long, EpetraNode >::EpetraMapT	(	global_size_t	numGlobalElements,
		size_t	numLocalElements,
		long long	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm )

inline

Constructor with a user-defined contiguous distribution.

Definition at line 104 of file Xpetra_EpetraMap.hpp.

◆ EpetraMapT() [7/8]

Xpetra::EpetraMapT< long long, EpetraNode >::EpetraMapT	(	global_size_t	numGlobalElements,
		const Teuchos::ArrayView< const long long > &	elementList,
		long long	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm )

inline

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

Definition at line 110 of file Xpetra_EpetraMap.hpp.

◆ EpetraMapT() [8/8]

Xpetra::EpetraMapT< long long, EpetraNode >::EpetraMapT ( const Teuchos::RCP< const Epetra_BlockMap > & map )

inline

EpetraMapT constructor to wrap a Epetra_Map object.

Definition at line 229 of file Xpetra_EpetraMap.hpp.

◆ ~EpetraMapT() [2/2]

virtual Xpetra::EpetraMapT< long long, EpetraNode >::~EpetraMapT ( )

inlinevirtual

Destructor.

Definition at line 226 of file Xpetra_EpetraMap.hpp.

Member Function Documentation

◆ getGlobalNumElements() [1/2]

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

inlinevirtual

The number of elements in this Map.

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

Definition at line 906 of file Xpetra_EpetraMap.hpp.

◆ getLocalNumElements() [1/2]

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

inlinevirtual

The number of elements belonging to the calling process.

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

Definition at line 909 of file Xpetra_EpetraMap.hpp.

◆ getIndexBase() [1/2]

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

inlinevirtual

The index base for this Map.

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

Definition at line 912 of file Xpetra_EpetraMap.hpp.

◆ getMinLocalIndex() [1/2]

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

inlinevirtual

The minimum local index.

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

Definition at line 915 of file Xpetra_EpetraMap.hpp.

◆ getMaxLocalIndex() [1/2]

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

inlinevirtual

The maximum local index on the calling process.

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

Definition at line 918 of file Xpetra_EpetraMap.hpp.

◆ getMinGlobalIndex() [1/2]

GlobalOrdinal Xpetra::EpetraMapT< 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 921 of file Xpetra_EpetraMap.hpp.

◆ getMaxGlobalIndex() [1/2]

GlobalOrdinal Xpetra::EpetraMapT< 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 924 of file Xpetra_EpetraMap.hpp.

◆ getMinAllGlobalIndex() [1/2]

GlobalOrdinal Xpetra::EpetraMapT< 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 927 of file Xpetra_EpetraMap.hpp.

◆ getMaxAllGlobalIndex() [1/2]

GlobalOrdinal Xpetra::EpetraMapT< 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 930 of file Xpetra_EpetraMap.hpp.

◆ getLocalElement() [1/2]

LocalOrdinal Xpetra::EpetraMapT< 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 933 of file Xpetra_EpetraMap.hpp.

◆ getRemoteIndexList() [1/4]

LookupStatus Xpetra::EpetraMapT< 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 ranks and corresponding local indices for the given global indices.

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

Definition at line 936 of file Xpetra_EpetraMap.hpp.

◆ getRemoteIndexList() [2/4]

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

inlinevirtual

Return the process ranks for the given global indices.

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

Definition at line 939 of file Xpetra_EpetraMap.hpp.

◆ getLocalElementList() [1/2]

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

inlinevirtual

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

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

Definition at line 942 of file Xpetra_EpetraMap.hpp.

◆ isNodeLocalElement() [1/2]

bool Xpetra::EpetraMapT< long long, EpetraNode >::isNodeLocalElement ( LocalOrdinal localIndex ) const

inlinevirtual

Whether the given local index is valid for this Map on this process.

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

Definition at line 949 of file Xpetra_EpetraMap.hpp.

◆ isNodeGlobalElement() [1/2]

bool Xpetra::EpetraMapT< long long, EpetraNode >::isNodeGlobalElement ( GlobalOrdinal globalIndex ) const

inlinevirtual

Whether the given global index is valid for this Map on this process.

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

Definition at line 952 of file Xpetra_EpetraMap.hpp.

◆ isContiguous() [1/2]

bool Xpetra::EpetraMapT< 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 955 of file Xpetra_EpetraMap.hpp.

◆ isDistributed() [1/2]

bool Xpetra::EpetraMapT< 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 958 of file Xpetra_EpetraMap.hpp.

◆ isCompatible() [1/2]

bool Xpetra::EpetraMapT< 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 961 of file Xpetra_EpetraMap.hpp.

◆ isSameAs() [1/2]

bool Xpetra::EpetraMapT< 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 964 of file Xpetra_EpetraMap.hpp.

◆ getComm() [1/2]

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

inlinevirtual

Get this Map's Comm object.

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

Definition at line 972 of file Xpetra_EpetraMap.hpp.

◆ description() [1/2]

std::string Xpetra::EpetraMapT< 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 981 of file Xpetra_EpetraMap.hpp.

◆ describe() [1/2]

void Xpetra::EpetraMapT< 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 Teuchos::FancyOStream.

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

Definition at line 996 of file Xpetra_EpetraMap.hpp.

◆ removeEmptyProcesses() [1/2]

RCP< const Map< int, GlobalOrdinal, Node > > Xpetra::EpetraMapT< 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 1078 of file Xpetra_EpetraMap.hpp.

◆ replaceCommWithSubset() [1/2]

RCP< const Map< int, GlobalOrdinal, Node > > Xpetra::EpetraMapT< long long, EpetraNode >::replaceCommWithSubset ( const Teuchos::RCP< const Teuchos::Comm< int > > & ) const

inlinevirtual

Replace this Map's communicator with a subset communicator.

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

Definition at line 1090 of file Xpetra_EpetraMap.hpp.

◆ getGlobalElement() [1/2]

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

inlinevirtual

Return the global index for a given local index. Note that this returns -1 if not found on this processor. (This is different than Epetra's behavior!)

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

Definition at line 1098 of file Xpetra_EpetraMap.hpp.

◆ lib() [1/2]

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

inlinevirtual

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

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

Definition at line 1119 of file Xpetra_EpetraMap.hpp.

◆ getEpetra_MapRCP() [1/2]

const RCP< const Epetra_Map > & Xpetra::EpetraMapT< long long, EpetraNode >::getEpetra_MapRCP ( ) const

inline

Get the underlying Epetra map.

Definition at line 1122 of file Xpetra_EpetraMap.hpp.

◆ getEpetra_BlockMap() [1/2]

const Epetra_BlockMap & Xpetra::EpetraMapT< long long, EpetraNode >::getEpetra_BlockMap ( ) const

inline

Definition at line 1123 of file Xpetra_EpetraMap.hpp.

◆ getEpetra_Map() [1/2]

const Epetra_Map & Xpetra::EpetraMapT< long long, EpetraNode >::getEpetra_Map ( ) const

inline

Definition at line 1124 of file Xpetra_EpetraMap.hpp.

◆ getLocalMap() [1/2]

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

inlinevirtual

Get the local Map for Kokkos kernels.

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

Definition at line 1129 of file Xpetra_EpetraMap.hpp.

◆ getGlobalNumElements() [2/2]

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

inlinevirtual

The number of elements in this Map.

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

Definition at line 124 of file Xpetra_EpetraMap.hpp.

◆ getLocalNumElements() [2/2]

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

inlinevirtual

The number of elements belonging to the calling process.

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

Definition at line 127 of file Xpetra_EpetraMap.hpp.

◆ getIndexBase() [2/2]

long long Xpetra::EpetraMapT< long long, EpetraNode >::getIndexBase ( ) const

inlinevirtual

The index base for this Map.

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

Definition at line 130 of file Xpetra_EpetraMap.hpp.

◆ getMinLocalIndex() [2/2]

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

inlinevirtual

The minimum local index.

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

Definition at line 133 of file Xpetra_EpetraMap.hpp.

◆ getMaxLocalIndex() [2/2]

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

inlinevirtual

The maximum local index on the calling process.

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

Definition at line 136 of file Xpetra_EpetraMap.hpp.

◆ getMinGlobalIndex() [2/2]

long long Xpetra::EpetraMapT< 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 139 of file Xpetra_EpetraMap.hpp.

◆ getMaxGlobalIndex() [2/2]

long long Xpetra::EpetraMapT< 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 142 of file Xpetra_EpetraMap.hpp.

◆ getMinAllGlobalIndex() [2/2]

long long Xpetra::EpetraMapT< 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 145 of file Xpetra_EpetraMap.hpp.

◆ getMaxAllGlobalIndex() [2/2]

long long Xpetra::EpetraMapT< 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 148 of file Xpetra_EpetraMap.hpp.

◆ getLocalElement() [2/2]

LocalOrdinal Xpetra::EpetraMapT< long long, EpetraNode >::getLocalElement ( long long ) const

inlinevirtual

The local index corresponding to the given global index.

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

Definition at line 151 of file Xpetra_EpetraMap.hpp.

◆ getRemoteIndexList() [3/4]

LookupStatus Xpetra::EpetraMapT< long long, EpetraNode >::getRemoteIndexList	(	const Teuchos::ArrayView< const long long > &	,
		const Teuchos::ArrayView< int > &	,
		const Teuchos::ArrayView< LocalOrdinal > &	) const

inlinevirtual

Return the process ranks and corresponding local indices for the given global indices.

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

Definition at line 154 of file Xpetra_EpetraMap.hpp.

◆ getRemoteIndexList() [4/4]

LookupStatus Xpetra::EpetraMapT< long long, EpetraNode >::getRemoteIndexList	(	const Teuchos::ArrayView< const long long > &	,
		const Teuchos::ArrayView< int > &	) const

inlinevirtual

Return the process ranks for the given global indices.

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

Definition at line 157 of file Xpetra_EpetraMap.hpp.

◆ getLocalElementList() [2/2]

Teuchos::ArrayView< const long long > Xpetra::EpetraMapT< long long, EpetraNode >::getLocalElementList ( ) const

inlinevirtual

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

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

Definition at line 162 of file Xpetra_EpetraMap.hpp.

◆ isNodeLocalElement() [2/2]

bool Xpetra::EpetraMapT< long long, EpetraNode >::isNodeLocalElement ( LocalOrdinal ) const

inlinevirtual

Whether the given local index is valid for this Map on this process.

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

Definition at line 169 of file Xpetra_EpetraMap.hpp.

◆ isNodeGlobalElement() [2/2]

bool Xpetra::EpetraMapT< long long, EpetraNode >::isNodeGlobalElement ( long long ) const

inlinevirtual

Whether the given global index is valid for this Map on this process.

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

Definition at line 172 of file Xpetra_EpetraMap.hpp.

◆ isContiguous() [2/2]

bool Xpetra::EpetraMapT< 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 175 of file Xpetra_EpetraMap.hpp.

◆ isDistributed() [2/2]

bool Xpetra::EpetraMapT< 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 178 of file Xpetra_EpetraMap.hpp.

◆ isCompatible() [2/2]

bool Xpetra::EpetraMapT< long long, EpetraNode >::isCompatible ( const Map< LocalOrdinal, long long, EpetraNode > & ) const

inlinevirtual

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

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

Definition at line 181 of file Xpetra_EpetraMap.hpp.

◆ isSameAs() [2/2]

bool Xpetra::EpetraMapT< long long, EpetraNode >::isSameAs ( const Map< LocalOrdinal, long long, EpetraNode > & ) const

inlinevirtual

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

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

Definition at line 184 of file Xpetra_EpetraMap.hpp.

◆ getComm() [2/2]

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

inlinevirtual

Get this Map's Comm object.

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

Definition at line 192 of file Xpetra_EpetraMap.hpp.

◆ description() [2/2]

std::string Xpetra::EpetraMapT< 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 201 of file Xpetra_EpetraMap.hpp.

◆ describe() [2/2]

void Xpetra::EpetraMapT< long long, EpetraNode >::describe	(	Teuchos::FancyOStream &	,
		const Teuchos::EVerbosityLevel	= Teuchos::Describable::verbLevel_default ) const

inlinevirtual

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

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

Definition at line 204 of file Xpetra_EpetraMap.hpp.

◆ removeEmptyProcesses() [2/2]

RCP< const Map< int, long long, EpetraNode > > Xpetra::EpetraMapT< 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 212 of file Xpetra_EpetraMap.hpp.

◆ replaceCommWithSubset() [2/2]

RCP< const Map< int, long long, EpetraNode > > Xpetra::EpetraMapT< long long, EpetraNode >::replaceCommWithSubset ( const Teuchos::RCP< const Teuchos::Comm< int > > & ) const

inlinevirtual

Replace this Map's communicator with a subset communicator.

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

Definition at line 215 of file Xpetra_EpetraMap.hpp.

◆ getGlobalElement() [2/2]

long long Xpetra::EpetraMapT< long long, EpetraNode >::getGlobalElement ( LocalOrdinal ) const

inlinevirtual

Return the global index for a given local index. Note that this returns -1 if not found on this processor. (This is different than Epetra's behavior!)

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

Definition at line 220 of file Xpetra_EpetraMap.hpp.

◆ lib() [2/2]

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

inlinevirtual

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

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

Definition at line 236 of file Xpetra_EpetraMap.hpp.

◆ getEpetra_MapRCP() [2/2]

const RCP< const Epetra_Map > & Xpetra::EpetraMapT< long long, EpetraNode >::getEpetra_MapRCP ( ) const

inline

Get the underlying Epetra map.

Definition at line 239 of file Xpetra_EpetraMap.hpp.

◆ getEpetra_BlockMap() [2/2]

const Epetra_BlockMap & Xpetra::EpetraMapT< long long, EpetraNode >::getEpetra_BlockMap ( ) const

inline

Definition at line 240 of file Xpetra_EpetraMap.hpp.

◆ getEpetra_Map() [2/2]

const Epetra_Map & Xpetra::EpetraMapT< long long, EpetraNode >::getEpetra_Map ( ) const

inline

Definition at line 241 of file Xpetra_EpetraMap.hpp.

◆ getLocalMap() [2/2]

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

inlinevirtual

Get the local Map for Kokkos kernels.

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

Definition at line 246 of file Xpetra_EpetraMap.hpp.

Member Data Documentation

◆ localMap_

local_map_type Xpetra::EpetraMapT< long long, EpetraNode >::localMap_

mutableprivate

Definition at line 1134 of file Xpetra_EpetraMap.hpp.

◆ map_ [1/2]

RCP<const Epetra_BlockMap> Xpetra::EpetraMapT< long long, EpetraNode >::map_

protected

Definition at line 1145 of file Xpetra_EpetraMap.hpp.

◆ map_ [2/2]

RCP<const Epetra_BlockMap> Xpetra::EpetraMapT< long long, EpetraNode >::map_

protected

Definition at line 259 of file Xpetra_EpetraMap.hpp.

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

Xpetra_EpetraMap.hpp

Public Types

Private Types

Xpetra specific

Xpetra specific

Constructors and destructor

Attributes

Boolean tests

Constructors and destructor

Attributes

Boolean tests

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ LocalOrdinal [1/2]

◆ GlobalOrdinal

◆ Node

◆ local_ordinal_type [1/2]

◆ global_ordinal_type [1/2]

◆ node_type [1/2]

◆ local_map_type [1/2]

◆ LocalOrdinal [2/2]

◆ local_ordinal_type [2/2]

◆ global_ordinal_type [2/2]

◆ node_type [2/2]

◆ local_map_type [2/2]

Constructor & Destructor Documentation

◆ EpetraMapT() [1/8]

◆ EpetraMapT() [2/8]

◆ EpetraMapT() [3/8]

◆ ~EpetraMapT() [1/2]

◆ EpetraMapT() [4/8]

◆ EpetraMapT() [5/8]

◆ EpetraMapT() [6/8]

◆ EpetraMapT() [7/8]

◆ EpetraMapT() [8/8]

◆ ~EpetraMapT() [2/2]

Member Function Documentation

◆ getGlobalNumElements() [1/2]

◆ getLocalNumElements() [1/2]

◆ getIndexBase() [1/2]

◆ getMinLocalIndex() [1/2]

◆ getMaxLocalIndex() [1/2]

◆ getMinGlobalIndex() [1/2]

◆ getMaxGlobalIndex() [1/2]

◆ getMinAllGlobalIndex() [1/2]

◆ getMaxAllGlobalIndex() [1/2]

◆ getLocalElement() [1/2]

◆ getRemoteIndexList() [1/4]

◆ getRemoteIndexList() [2/4]

◆ getLocalElementList() [1/2]

◆ isNodeLocalElement() [1/2]

◆ isNodeGlobalElement() [1/2]

◆ isContiguous() [1/2]

◆ isDistributed() [1/2]

◆ isCompatible() [1/2]

◆ isSameAs() [1/2]

◆ getComm() [1/2]

◆ description() [1/2]

◆ describe() [1/2]

◆ removeEmptyProcesses() [1/2]

◆ replaceCommWithSubset() [1/2]

◆ getGlobalElement() [1/2]

◆ lib() [1/2]

◆ getEpetra_MapRCP() [1/2]

◆ getEpetra_BlockMap() [1/2]

◆ getEpetra_Map() [1/2]

◆ getLocalMap() [1/2]

◆ getGlobalNumElements() [2/2]

◆ getLocalNumElements() [2/2]

◆ getIndexBase() [2/2]

◆ getMinLocalIndex() [2/2]

◆ getMaxLocalIndex() [2/2]

◆ getMinGlobalIndex() [2/2]

◆ getMaxGlobalIndex() [2/2]

◆ getMinAllGlobalIndex() [2/2]

◆ getMaxAllGlobalIndex() [2/2]

◆ getLocalElement() [2/2]

◆ getRemoteIndexList() [3/4]

◆ getRemoteIndexList() [4/4]

◆ getLocalElementList() [2/2]