Kaskade::GlobalLocalIndexRelationship< Index > Class Template Reference

The GlobalLocalIndexRelationship class provides relationships between local indices of (e.g. matrix) blocks and global indices (of the corresponding block matrix) More...

#include <matrixBlocks.hh>

Detailed Description

template<class Index>
class Kaskade::GlobalLocalIndexRelationship< Index >

The GlobalLocalIndexRelationship class provides relationships between local indices of (e.g. matrix) blocks and global indices (of the corresponding block matrix)

Definition at line 34 of file matrixBlocks.hh.

Public Member Functions
	GlobalLocalIndexRelationship ()
	GlobalLocalIndexRelationship (std::vector< Index > const &localSizes)
	GlobalLocalIndexRelationship. More...
Index	offset (Index block) const
	offset More...
Index	globalIndex (Index block, Index localIndex) const
	globalIndex More...
std::pair< Index, Index >	localIndex (Index globalIndex) const
	localIndex More...
std::pair< Index, Index >	findOffset (Index globalIndex) const
	findOffset More...
Index	globalSize () const
	globalSize More...
Index	localSize (Index block) const
	localSize More...
Index	numberBlocks () const
	numberBlocks More...

Constructor & Destructor Documentation

GlobalLocalIndexRelationship() [1/2]

template<class Index >

Kaskade::GlobalLocalIndexRelationship< Index >::GlobalLocalIndexRelationship ( )

inline

Definition at line 37 of file matrixBlocks.hh.

GlobalLocalIndexRelationship() [2/2]

template<class Index >

Kaskade::GlobalLocalIndexRelationship< Index >::GlobalLocalIndexRelationship ( std::vector< Index > const &  localSizes )

inline

GlobalLocalIndexRelationship.

Parameters

localSizes

are sizes of involved blocks

Definition at line 43 of file matrixBlocks.hh.

Member Function Documentation

findOffset()

template<class Index >

std::pair< Index, Index > Kaskade::GlobalLocalIndexRelationship< Index >::findOffset ( Index  globalIndex ) const

inline

findOffset

Parameters

globalIndex

Returns

pair containing block number and global start index of block by global index

Definition at line 87 of file matrixBlocks.hh.

Referenced by Kaskade::GlobalLocalIndexRelationship< Index >::localIndex().

globalIndex()

template<class Index >

Index Kaskade::GlobalLocalIndexRelationship< Index >::globalIndex ( Index  block, Index  localIndex  ) const

inline

globalIndex

Parameters

block
localIndex

Returns

global index by block number and block local index

Definition at line 67 of file matrixBlocks.hh.

Referenced by Kaskade::GlobalLocalIndexRelationship< Index >::findOffset(), and Kaskade::GlobalLocalIndexRelationship< Index >::localIndex().

globalSize()

template<class Index >

Index Kaskade::GlobalLocalIndexRelationship< Index >::globalSize ( ) const

inline

globalSize

Returns

number of global indices

Definition at line 101 of file matrixBlocks.hh.

localIndex()

template<class Index >

std::pair< Index, Index > Kaskade::GlobalLocalIndexRelationship< Index >::localIndex ( Index  globalIndex ) const

inline

localIndex

Parameters

globalIndex

Returns

pair containing block number and local index by global index

Definition at line 76 of file matrixBlocks.hh.

Referenced by Kaskade::GlobalLocalIndexRelationship< Index >::globalIndex().

localSize()

template<class Index >

Index Kaskade::GlobalLocalIndexRelationship< Index >::localSize ( Index  block ) const

inline

localSize

Parameters

block

Returns

size of some block

Definition at line 110 of file matrixBlocks.hh.

numberBlocks()

template<class Index >

Index Kaskade::GlobalLocalIndexRelationship< Index >::numberBlocks ( ) const

inline

numberBlocks

Returns

number of involved blocks

Definition at line 118 of file matrixBlocks.hh.

Referenced by Kaskade::GlobalLocalIndexRelationship< Index >::findOffset(), and Kaskade::GlobalLocalIndexRelationship< Index >::offset().

offset()

template<class Index >

Index Kaskade::GlobalLocalIndexRelationship< Index >::offset ( Index  block ) const

inline

offset

Parameters

block

Returns

global start index of some block

Definition at line 56 of file matrixBlocks.hh.

Referenced by Kaskade::GlobalLocalIndexRelationship< Index >::findOffset(), Kaskade::GlobalLocalIndexRelationship< Index >::globalIndex(), and Kaskade::GlobalLocalIndexRelationship< Index >::localSize().

---

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

• matrixBlocks.hh