Xpetra::EpetraBlockMap Class Reference

Block-entry counterpart to Xpetra::Map. More...

#include <Xpetra_EpetraBlockMap.hpp>

Inheritance diagram for Xpetra::EpetraBlockMap:

List of all members.

Public Types
typedef int	LocalOrdinal
typedef int	GlobalOrdinal
typedef BlockMap< int, int > ::node_type	Node
Public Member Functions
RCP< const Epetra_BlockMap >	getEpetra_BlockMap () const
Private Attributes
const RCP< const Epetra_BlockMap >	map_
Constructor/Destructor Methods
	EpetraBlockMap (global_size_t numGlobalBlocks, int blockSize, int indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=KokkosClassic::Details::getNode< Node >())
	EpetraBlockMap constructor specifying numGlobalBlocks and constant blockSize.
	EpetraBlockMap (global_size_t numGlobalBlocks, size_t numLocalBlocks, int blockSize, int indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=KokkosClassic::Details::getNode< Node >())
	EpetraBlockMap constructor specifying num global and local blocks, and constant blockSize.
	EpetraBlockMap (const Teuchos::RCP< const Epetra_BlockMap > &map)
	EpetraBlockMap constructor specifying numGlobalBlocks and lists of local blocks first-global-point-in-blocks, and blockSizes.
virtual	~EpetraBlockMap ()
	EpetraBlockMap destructor.
Attribute Accessor Methods
global_size_t	getGlobalNumBlocks () const
size_t	getNodeNumBlocks () const
	Return number of blocks on the local processor.
bool	isBlockSizeConstant () const
int	getGlobalBlockID (int localBlockID) const
	Return ArrayRCP of first-local-point in local blocks.
int	getLocalBlockID (int globalBlockID) const
	Return the localBlockID corresponding to the given globalBlockID.
int	getLocalBlockSize (int localBlockID) const
	Return the block-size for localBlockID.
int	getFirstLocalPointInLocalBlock (int localBlockID) const
	Return the first local point-index corresponding to localBlockID.

---

Detailed Description

Block-entry counterpart to Xpetra::Map.

BlockMap doesn't inherit Xpetra::Map

Definition at line 70 of file Xpetra_EpetraBlockMap.hpp.

---

Member Typedef Documentation

typedef int Xpetra::EpetraBlockMap::LocalOrdinal

Definition at line 72 of file Xpetra_EpetraBlockMap.hpp.

typedef int Xpetra::EpetraBlockMap::GlobalOrdinal

Definition at line 73 of file Xpetra_EpetraBlockMap.hpp.

typedef BlockMap<int, int>::node_type Xpetra::EpetraBlockMap::Node

Definition at line 74 of file Xpetra_EpetraBlockMap.hpp.

---

Constructor & Destructor Documentation

Xpetra::EpetraBlockMap::EpetraBlockMap	(	global_size_t	numGlobalBlocks,
		int	blockSize,
		int	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		const Teuchos::RCP< Node > &	node = KokkosClassic::Details::getNode<Node> ()
	)		[inline]

EpetraBlockMap constructor specifying numGlobalBlocks and constant blockSize.

Definition at line 81 of file Xpetra_EpetraBlockMap.hpp.

Xpetra::EpetraBlockMap::EpetraBlockMap	(	global_size_t	numGlobalBlocks,
		size_t	numLocalBlocks,
		int	blockSize,
		int	indexBase,
		const Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		const Teuchos::RCP< Node > &	node = KokkosClassic::Details::getNode<Node> ()
	)		[inline]

EpetraBlockMap constructor specifying num global and local blocks, and constant blockSize.

Definition at line 95 of file Xpetra_EpetraBlockMap.hpp.

Xpetra::EpetraBlockMap::EpetraBlockMap

(

const Teuchos::RCP< const Epetra_BlockMap > &

map

)

[inline]

EpetraBlockMap constructor specifying numGlobalBlocks and lists of local blocks first-global-point-in-blocks, and blockSizes.

EpetraBlockMap constructor which takes a "regular" Map. The arrays myGlobalBlockIDs and myBlockSizes must be the same length, and sum(myBlockSizes) must equal pointMap->getNodeNumElements(). If these arrays are different lengths or sum(myBlockSizes) is incorrect, then std::runtime_error is thrown.

Definition at line 132 of file Xpetra_EpetraBlockMap.hpp.

virtual Xpetra::EpetraBlockMap::~EpetraBlockMap

(

)

[inline, virtual]

EpetraBlockMap destructor.

Definition at line 135 of file Xpetra_EpetraBlockMap.hpp.

---

Member Function Documentation

global_size_t Xpetra::EpetraBlockMap::getGlobalNumBlocks

(

)

const [inline]

Definition at line 145 of file Xpetra_EpetraBlockMap.hpp.

size_t Xpetra::EpetraBlockMap::getNodeNumBlocks

(

)

const [inline]

Return number of blocks on the local processor.

Definition at line 148 of file Xpetra_EpetraBlockMap.hpp.

bool Xpetra::EpetraBlockMap::isBlockSizeConstant

(

)

const [inline]

Definition at line 152 of file Xpetra_EpetraBlockMap.hpp.

int Xpetra::EpetraBlockMap::getGlobalBlockID

(

int

localBlockID

)

const [inline]

Return ArrayRCP of first-local-point in local blocks.

Return the globalBlockID corresponding to the given localBlockID

If localBlockID is not present on this processor, returns Teuchos::OrdinalTraits<int>::invalid().

Definition at line 168 of file Xpetra_EpetraBlockMap.hpp.

int Xpetra::EpetraBlockMap::getLocalBlockID

(

int

globalBlockID

)

const [inline]

Return the localBlockID corresponding to the given globalBlockID.

If globalBlockID is not present on this processor, returns Teuchos::OrdinalTraits<int>::invalid().

Definition at line 173 of file Xpetra_EpetraBlockMap.hpp.

int Xpetra::EpetraBlockMap::getLocalBlockSize

(

int

localBlockID

)

const [inline]

Return the block-size for localBlockID.

If localBlockID is out of range (less than 0 or greater/equal num-local-blocks), then std::runtime_error is thrown.

Definition at line 179 of file Xpetra_EpetraBlockMap.hpp.

int Xpetra::EpetraBlockMap::getFirstLocalPointInLocalBlock

(

int

localBlockID

)

const [inline]

Return the first local point-index corresponding to localBlockID.

If localBlockID is out of range (less than 0 or greater/equal num-local-blocks), then std::runtime_error is thrown.

Definition at line 185 of file Xpetra_EpetraBlockMap.hpp.

RCP< const Epetra_BlockMap > Xpetra::EpetraBlockMap::getEpetra_BlockMap

(

)

const [inline]

Definition at line 197 of file Xpetra_EpetraBlockMap.hpp.

---

Member Data Documentation

const RCP< const Epetra_BlockMap > Xpetra::EpetraBlockMap::map_ [private]

Definition at line 200 of file Xpetra_EpetraBlockMap.hpp.

---

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

• Xpetra_EpetraBlockMap.hpp