All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types | Public Member Functions | Private Attributes
Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_TpetraBlockMap.hpp>

Inheritance diagram for Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::BlockMap< LocalOrdinal, GlobalOrdinal, Node > Describable

List of all members.

Public Types

typedef TpetraMap
< LocalOrdinal, GlobalOrdinal,
Node > 		TpetraMapClass

Public Member Functions

RCP< const Tpetra::BlockMap
< LocalOrdinal, GlobalOrdinal,
Node > > 		getTpetra_BlockMap () const

Private Attributes

RCP< const Tpetra::BlockMap
< LocalOrdinal, GlobalOrdinal,
Node > > 		map_

Constructor/Destructor Methods

 TpetraBlockMap (global_size_t numGlobalBlocks, LocalOrdinal blockSize, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
 TpetraBlockMap constructor specifying numGlobalBlocks and constant blockSize.
 TpetraBlockMap (global_size_t numGlobalBlocks, size_t numLocalBlocks, LocalOrdinal blockSize, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
 TpetraBlockMap constructor specifying num global and local blocks, and constant blockSize.
 TpetraBlockMap (global_size_t numGlobalBlocks, const Teuchos::ArrayView< const GlobalOrdinal > &myGlobalBlockIDs, const Teuchos::ArrayView< const GlobalOrdinal > &myFirstGlobalPointInBlocks, const Teuchos::ArrayView< const LocalOrdinal > &myBlockSizes, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
 TpetraBlockMap constructor specifying numGlobalBlocks and lists of local blocks first-global-point-in-blocks, and blockSizes.
 TpetraBlockMap (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &pointMap, const Teuchos::ArrayView< const GlobalOrdinal > &myGlobalBlockIDs, const Teuchos::ArrayView< const LocalOrdinal > &myBlockSizes, const Teuchos::RCP< Node > &node=Kokkos::DefaultNode::getDefaultNode())
 TpetraBlockMap 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.
 TpetraBlockMap (const Teuchos::RCP< const Tpetra::BlockMap< LocalOrdinal, GlobalOrdinal, Node > > &map)
virtual ~TpetraBlockMap ()
 TpetraBlockMap destructor.

Attribute Accessor Methods

global_size_t getGlobalNumBlocks () const
size_t getNodeNumBlocks () const
 Return number of blocks on the local processor.
Teuchos::ArrayView< const
GlobalOrdinal > 		getNodeBlockIDs () const
bool isBlockSizeConstant () const
Teuchos::ArrayRCP< const
LocalOrdinal > 		getNodeFirstPointInBlocks () const
 Return ArrayRCP of first-local-point in local blocks.
Teuchos::ArrayRCP< const
LocalOrdinal > 		getNodeFirstPointInBlocks_Device () const
 Return device-resident ArrayRCP of first-local-point in local blocks.
GlobalOrdinal getGlobalBlockID (LocalOrdinal localBlockID) const
 Return the globalBlockID corresponding to the given localBlockID.
LocalOrdinal getLocalBlockID (GlobalOrdinal globalBlockID) const
 Return the localBlockID corresponding to the given globalBlockID.
LocalOrdinal getLocalBlockSize (LocalOrdinal localBlockID) const
 Return the block-size for localBlockID.
LocalOrdinal getFirstLocalPointInLocalBlock (LocalOrdinal localBlockID) const
 Return the first local point-index corresponding to localBlockID.
GlobalOrdinal getFirstGlobalPointInLocalBlock (LocalOrdinal localBlockID) const
 Return the first global point-index corresponding to localBlockID.

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
class Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 66 of file Xpetra_TpetraBlockMap.hpp.

Member Typedef Documentation

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
typedef TpetraMap<LocalOrdinal, GlobalOrdinal, Node> Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraMapClass

Definition at line 72 of file Xpetra_TpetraBlockMap.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraBlockMap ( global_size_t  numGlobalBlocks,
LocalOrdinal  blockSize,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node = Kokkos::DefaultNode::getDefaultNode() 
) [inline]

TpetraBlockMap constructor specifying numGlobalBlocks and constant blockSize.

Definition at line 79 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraBlockMap ( global_size_t  numGlobalBlocks,
size_t  numLocalBlocks,
LocalOrdinal  blockSize,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node = Kokkos::DefaultNode::getDefaultNode() 
) [inline]

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

Definition at line 87 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraBlockMap ( global_size_t  numGlobalBlocks,
const Teuchos::ArrayView< const GlobalOrdinal > &  myGlobalBlockIDs,
const Teuchos::ArrayView< const GlobalOrdinal > &  myFirstGlobalPointInBlocks,
const Teuchos::ArrayView< const LocalOrdinal > &  myBlockSizes,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node = Kokkos::DefaultNode::getDefaultNode() 
) [inline]

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

Definition at line 96 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraBlockMap ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  pointMap,
const Teuchos::ArrayView< const GlobalOrdinal > &  myGlobalBlockIDs,
const Teuchos::ArrayView< const LocalOrdinal > &  myBlockSizes,
const Teuchos::RCP< Node > &  node = Kokkos::DefaultNode::getDefaultNode() 
) [inline]

TpetraBlockMap 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 110 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::TpetraBlockMap ( const Teuchos::RCP< const Tpetra::BlockMap< LocalOrdinal, GlobalOrdinal, Node > > &  map) [inline]

Definition at line 119 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::~TpetraBlockMap ( ) [inline, virtual]

TpetraBlockMap destructor.

Definition at line 122 of file Xpetra_TpetraBlockMap.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
global_size_t Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumBlocks ( ) const [inline]

Definition at line 129 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
size_t Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeNumBlocks ( ) const [inline]

Return number of blocks on the local processor.

Definition at line 132 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Teuchos::ArrayView<const GlobalOrdinal> Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeBlockIDs ( ) const [inline]

Definition at line 134 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
bool Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::isBlockSizeConstant ( ) const [inline]

Definition at line 136 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Teuchos::ArrayRCP<const LocalOrdinal> Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeFirstPointInBlocks ( ) const [inline]

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

Definition at line 139 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
Teuchos::ArrayRCP<const LocalOrdinal> Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getNodeFirstPointInBlocks_Device ( ) const [inline]

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

This version of this method is primarily used internally by VbrMatrix for passing data to the matrix-vector-product kernel.

Definition at line 145 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
GlobalOrdinal Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalBlockID ( LocalOrdinal  localBlockID) const [inline]

Return the globalBlockID corresponding to the given localBlockID.

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

Definition at line 150 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
LocalOrdinal Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalBlockID ( GlobalOrdinal  globalBlockID) const [inline]

Return the localBlockID corresponding to the given globalBlockID.

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

Definition at line 155 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
LocalOrdinal Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalBlockSize ( LocalOrdinal  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 161 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
LocalOrdinal Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getFirstLocalPointInLocalBlock ( LocalOrdinal  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 167 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
GlobalOrdinal Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getFirstGlobalPointInLocalBlock ( LocalOrdinal  localBlockID) const [inline]

Return the first global 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 173 of file Xpetra_TpetraBlockMap.hpp.

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
RCP< const Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::getTpetra_BlockMap ( ) const [inline]

Definition at line 177 of file Xpetra_TpetraBlockMap.hpp.

Member Data Documentation

template<class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
RCP< const Tpetra::BlockMap<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraBlockMap< LocalOrdinal, GlobalOrdinal, Node >::map_ [private]

Definition at line 180 of file Xpetra_TpetraBlockMap.hpp.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Generated on Mon Oct 29 2012 04:49:00 for Xpetra by   doxygen 1.7.6.1