#include <Xpetra_StridedEpetraMap.hpp>

Inheritance diagram for Xpetra::StridedEpetraMap:

Public Member Functions
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!)
Private Types
typedef int	LocalOrdinal
typedef int	GlobalOrdinal
typedef Kokkos::DefaultNode::DefaultNodeType	Node
Private Member Functions
bool	CheckConsistency ()
Constructor/Destructor Methods
	StridedEpetraMap (global_size_t numGlobalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0, LocalGlobal lg=GloballyDistributed, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
	Map constructor with Tpetra-defined contiguous uniform distribution. The elements are distributed among nodes so that the subsets of global elements are non-overlapping and contiguous and as evenly distributed across the nodes as possible.
	StridedEpetraMap (global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
	Map constructor with a user-defined contiguous distribution. The elements are distributed among the nodes so that the subsets of global elements are non-overlapping and contiguous.
	StridedEpetraMap (global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalOrdinal stridedBlockId=-1, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
	Map constructor with user-defined non-contiguous (arbitrary) distribution.
	~StridedEpetraMap ()
	Map destructor.
Map Attribute Methods
global_size_t	getGlobalNumElements () const
	Returns the number of elements in this Map.
size_t	getNodeNumElements () const
	Returns the number of elements belonging to the calling node.
GlobalOrdinal	getIndexBase () const
	Returns the index base for this Map.
LocalOrdinal	getMinLocalIndex () const
	Returns minimum local index.
LocalOrdinal	getMaxLocalIndex () const
	Returns maximum local index.
GlobalOrdinal	getMinGlobalIndex () const
	Returns minimum global index owned by this node.
GlobalOrdinal	getMaxGlobalIndex () const
	Returns maximum global index owned by this node.
GlobalOrdinal	getMinAllGlobalIndex () const
	Return the minimum global index over all nodes.
GlobalOrdinal	getMaxAllGlobalIndex () const
	Return the maximum global index over all nodes.
LocalOrdinal	getLocalElement (GlobalOrdinal globalIndex) const
	Return the local index for a given global index.
LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const
	Returns the node IDs and corresponding local indices for a given list of global indices.
LookupStatus	getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const
	Returns the node IDs for a given list of global indices.
Teuchos::ArrayView< const GlobalOrdinal >	getNodeElementList () const
	Return a list of the global indices owned by this node.
bool	isNodeLocalElement (LocalOrdinal localIndex) const
	Returns true if the local index is valid for this Map on this node; returns false if it isn't.
bool	isNodeGlobalElement (GlobalOrdinal globalIndex) const
	Returns true if the global index is found in this Map on this node; returns false if it isn't.
bool	isContiguous () const
	Returns true if this Map is distributed contiguously; returns false otherwise.
bool	isDistributed () const
	Returns true if this Map is distributed across more than one node; returns false otherwise.
const Teuchos::RCP< const Teuchos::Comm< int > >	getComm () const
	Get the Comm object for this Map.
const Teuchos::RCP< Node >	getNode () const
	Get the Node object for this Map.
Boolean Tests
bool	isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
	Returns true if map is compatible with this Map.
bool	isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
	Returns true if map is identical to this Map.
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 the object with some verbosity level to a FancyOStream object.
Xpetra specific
	StridedEpetraMap (const Teuchos::RCP< const Epetra_BlockMap > &map, std::vector< size_t > &stridingInfo, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0)
	EpetraMap constructor to wrap a Epetra_Map object.
UnderlyingLib	lib () const
	Get the library used by this object (Epetra or Epetra?)

Detailed Description

Definition at line 65 of file Xpetra_StridedEpetraMap.hpp.

Member Typedef Documentation

typedef int Xpetra::StridedEpetraMap::LocalOrdinal [private]

Reimplemented from Xpetra::EpetraMap.

Definition at line 69 of file Xpetra_StridedEpetraMap.hpp.

typedef int Xpetra::StridedEpetraMap::GlobalOrdinal [private]

Reimplemented from Xpetra::EpetraMap.

Definition at line 70 of file Xpetra_StridedEpetraMap.hpp.

typedef Kokkos::DefaultNode::DefaultNodeType Xpetra::StridedEpetraMap::Node [private]

Reimplemented from Xpetra::EpetraMap.

Definition at line 71 of file Xpetra_StridedEpetraMap.hpp.

Constructor & Destructor Documentation

Xpetra::StridedEpetraMap::StridedEpetraMap	(	global_size_t	numGlobalElements,
		GlobalOrdinal	indexBase,
		std::vector< size_t > &	stridingInfo,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		LocalOrdinal	stridedBlockId = `-1`,
		GlobalOrdinal	offset = `0`,
		LocalGlobal	lg = `GloballyDistributed`,
		const Teuchos::RCP< Node > &	node = `Kokkos::DefaultNode::getDefaultNode()`
	)

Map constructor with Tpetra-defined contiguous uniform distribution. The elements are distributed among nodes so that the subsets of global elements are non-overlapping and contiguous and as evenly distributed across the nodes as possible.

Definition at line 70 of file Xpetra_StridedEpetraMap.cpp.

Xpetra::StridedEpetraMap::StridedEpetraMap	(	global_size_t	numGlobalElements,
		size_t	numLocalElements,
		GlobalOrdinal	indexBase,
		std::vector< size_t > &	stridingInfo,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		LocalOrdinal	stridedBlockId = `-1`,
		GlobalOrdinal	offset = `0`,
		const Teuchos::RCP< Node > &	node = `Kokkos::DefaultNode::getDefaultNode()`
	)

Map constructor with a user-defined contiguous distribution. The elements are distributed among the nodes so that the subsets of global elements are non-overlapping and contiguous.

Definition at line 125 of file Xpetra_StridedEpetraMap.cpp.

Xpetra::StridedEpetraMap::StridedEpetraMap	(	global_size_t	numGlobalElements,
		const Teuchos::ArrayView< const GlobalOrdinal > &	elementList,
		GlobalOrdinal	indexBase,
		std::vector< size_t > &	stridingInfo,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		LocalOrdinal	stridedBlockId = `-1`,
		const Teuchos::RCP< Node > &	node = `Kokkos::DefaultNode::getDefaultNode()`
	)

Map constructor with user-defined non-contiguous (arbitrary) distribution.

Definition at line 187 of file Xpetra_StridedEpetraMap.cpp.

Xpetra::StridedEpetraMap::~StridedEpetraMap ( ) [inline]

Map destructor.

Definition at line 88 of file Xpetra_StridedEpetraMap.hpp.

Xpetra::StridedEpetraMap::StridedEpetraMap	(	const Teuchos::RCP< const Epetra_BlockMap > &	map,
		std::vector< size_t > &	stridingInfo,
		LocalOrdinal	stridedBlockId = `-1`,
		GlobalOrdinal	offset = `0`
	)		`[inline]`

EpetraMap constructor to wrap a Epetra_Map object.

Definition at line 189 of file Xpetra_StridedEpetraMap.hpp.

Member Function Documentation

global_size_t Xpetra::StridedEpetraMap::getGlobalNumElements ( ) const [inline, virtual]

Returns the number of elements in this Map.

Reimplemented from Xpetra::EpetraMap.

Definition at line 96 of file Xpetra_StridedEpetraMap.hpp.

size_t Xpetra::StridedEpetraMap::getNodeNumElements ( ) const [inline, virtual]

Returns the number of elements belonging to the calling node.

Reimplemented from Xpetra::EpetraMap.

Definition at line 99 of file Xpetra_StridedEpetraMap.hpp.

GlobalOrdinal Xpetra::StridedEpetraMap::getIndexBase ( ) const [inline, virtual]

Returns the index base for this Map.

Reimplemented from Xpetra::EpetraMap.

Definition at line 102 of file Xpetra_StridedEpetraMap.hpp.

LocalOrdinal Xpetra::StridedEpetraMap::getMinLocalIndex ( ) const [inline, virtual]

Returns minimum local index.

Reimplemented from Xpetra::EpetraMap.

Definition at line 105 of file Xpetra_StridedEpetraMap.hpp.

LocalOrdinal Xpetra::StridedEpetraMap::getMaxLocalIndex ( ) const [inline, virtual]

Returns maximum local index.

Reimplemented from Xpetra::EpetraMap.

Definition at line 108 of file Xpetra_StridedEpetraMap.hpp.

GlobalOrdinal Xpetra::StridedEpetraMap::getMinGlobalIndex ( ) const [inline, virtual]

Returns minimum global index owned by this node.

Reimplemented from Xpetra::EpetraMap.

Definition at line 111 of file Xpetra_StridedEpetraMap.hpp.

GlobalOrdinal Xpetra::StridedEpetraMap::getMaxGlobalIndex ( ) const [inline, virtual]

Returns maximum global index owned by this node.

Reimplemented from Xpetra::EpetraMap.

Definition at line 114 of file Xpetra_StridedEpetraMap.hpp.

GlobalOrdinal Xpetra::StridedEpetraMap::getMinAllGlobalIndex ( ) const [inline, virtual]

Return the minimum global index over all nodes.

Reimplemented from Xpetra::EpetraMap.

Definition at line 117 of file Xpetra_StridedEpetraMap.hpp.

GlobalOrdinal Xpetra::StridedEpetraMap::getMaxAllGlobalIndex ( ) const [inline, virtual]

Return the maximum global index over all nodes.

Reimplemented from Xpetra::EpetraMap.

Definition at line 120 of file Xpetra_StridedEpetraMap.hpp.

LocalOrdinal Xpetra::StridedEpetraMap::getLocalElement ( GlobalOrdinal globalIndex ) const [inline, virtual]

Return the local index for a given global index.

Reimplemented from Xpetra::EpetraMap.

Definition at line 123 of file Xpetra_StridedEpetraMap.hpp.

LookupStatus Xpetra::StridedEpetraMap::getRemoteIndexList	(	const Teuchos::ArrayView< const GlobalOrdinal > &	GIDList,
		const Teuchos::ArrayView< int > &	nodeIDList,
		const Teuchos::ArrayView< LocalOrdinal > &	LIDList
	)		const `[inline, virtual]`

Returns the node IDs and corresponding local indices for a given list of global indices.

Reimplemented from Xpetra::EpetraMap.

Definition at line 126 of file Xpetra_StridedEpetraMap.hpp.

LookupStatus Xpetra::StridedEpetraMap::getRemoteIndexList	(	const Teuchos::ArrayView< const GlobalOrdinal > &	GIDList,
		const Teuchos::ArrayView< int > &	nodeIDList
	)		const `[inline, virtual]`

Returns the node IDs for a given list of global indices.

Reimplemented from Xpetra::EpetraMap.

Definition at line 129 of file Xpetra_StridedEpetraMap.hpp.

Teuchos::ArrayView< const GlobalOrdinal > Xpetra::StridedEpetraMap::getNodeElementList ( ) const [inline, virtual]

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

Reimplemented from Xpetra::EpetraMap.

Definition at line 132 of file Xpetra_StridedEpetraMap.hpp.

bool Xpetra::StridedEpetraMap::isNodeLocalElement ( LocalOrdinal localIndex ) const [inline, virtual]

Returns true if the local index is valid for this Map on this node; returns false if it isn't.

Reimplemented from Xpetra::EpetraMap.

Definition at line 135 of file Xpetra_StridedEpetraMap.hpp.

bool Xpetra::StridedEpetraMap::isNodeGlobalElement ( GlobalOrdinal globalIndex ) const [inline, virtual]

Returns true if the global index is found in this Map on this node; returns false if it isn't.

Reimplemented from Xpetra::EpetraMap.

Definition at line 138 of file Xpetra_StridedEpetraMap.hpp.

bool Xpetra::StridedEpetraMap::isContiguous ( ) const [inline, virtual]

Returns true if this Map is distributed contiguously; returns false otherwise.

Reimplemented from Xpetra::EpetraMap.

Definition at line 141 of file Xpetra_StridedEpetraMap.hpp.

bool Xpetra::StridedEpetraMap::isDistributed ( ) const [inline, virtual]

Returns true if this Map is distributed across more than one node; returns false otherwise.

Reimplemented from Xpetra::EpetraMap.

Definition at line 144 of file Xpetra_StridedEpetraMap.hpp.

const Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::StridedEpetraMap::getComm ( ) const [inline, virtual]

Get the Comm object for this Map.

Reimplemented from Xpetra::EpetraMap.

Definition at line 152 of file Xpetra_StridedEpetraMap.hpp.

const Teuchos::RCP< Node > Xpetra::StridedEpetraMap::getNode ( ) const [inline, virtual]

Get the Node object for this Map.

Reimplemented from Xpetra::EpetraMap.

Definition at line 155 of file Xpetra_StridedEpetraMap.hpp.

bool Xpetra::StridedEpetraMap::isCompatible ( const Map< LocalOrdinal, GlobalOrdinal, Node > & map ) const [inline, virtual]

Returns true if map is compatible with this Map.

Reimplemented from Xpetra::EpetraMap.

Definition at line 164 of file Xpetra_StridedEpetraMap.hpp.

bool Xpetra::StridedEpetraMap::isSameAs ( const Map< LocalOrdinal, GlobalOrdinal, Node > & map ) const [inline, virtual]

Returns true if map is identical to this Map.

Reimplemented from Xpetra::EpetraMap.

Definition at line 167 of file Xpetra_StridedEpetraMap.hpp.

std::string Xpetra::StridedEpetraMap::description ( ) const [virtual]

Return a simple one-line description of this object.

Reimplemented from Xpetra::EpetraMap.

Definition at line 206 of file Xpetra_StridedEpetraMap.cpp.

void Xpetra::StridedEpetraMap::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = `Teuchos::Describable::verbLevel_default`
	)		const `[virtual]`

Print the object with some verbosity level to a FancyOStream object.

Reimplemented from Xpetra::EpetraMap.

Definition at line 217 of file Xpetra_StridedEpetraMap.cpp.

GlobalOrdinal Xpetra::StridedEpetraMap::getGlobalElement ( LocalOrdinal localIndex ) const [inline, virtual]

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!)

Reimplemented from Xpetra::EpetraMap.

Definition at line 183 of file Xpetra_StridedEpetraMap.hpp.

UnderlyingLib Xpetra::StridedEpetraMap::lib ( ) const [inline, virtual]

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

Reimplemented from Xpetra::EpetraMap.

Definition at line 197 of file Xpetra_StridedEpetraMap.hpp.

bool Xpetra::StridedEpetraMap::CheckConsistency ( ) [inline, private, virtual]

Implements Xpetra::StridedMap< int, int >.

Definition at line 208 of file Xpetra_StridedEpetraMap.hpp.

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