Chaste Release::3.1
Public Member Functions | Private Attributes
DistributedVector::Chunk Class Reference

#include <DistributedVector.hpp>

Collaboration diagram for DistributedVector::Chunk:

List of all members.

Public Member Functions

 Chunk (DistributedVector parallelVec, unsigned chunk)
double & operator[] (unsigned globalIndex) throw (DistributedVectorException)
double & operator[] (Iterator index) throw (DistributedVectorException)

Private Attributes

unsigned mOffset
double * mpVec
unsigned mLo
unsigned mHi

Detailed Description

Provide access to a particular chunk of a chunked vector.

A chunked vector has multiple types of information encoded within a single vector, with a layout like [x_1, x_2, ..., x_n, y_1, y_2, ... y_n]. This class provides easy access to, for example, the x values.

Definition at line 246 of file DistributedVector.hpp.

Constructor & Destructor Documentation

DistributedVector::Chunk::Chunk ( DistributedVector  parallelVec,
unsigned  chunk 
) [inline]

Constructor.

Parameters:
parallelVecchunked vector
chunknumber of this chunk within the vector starting from 0

Definition at line 260 of file DistributedVector.hpp.

References DistributedVector::GetHigh(), DistributedVector::GetLow(), mHi, mLo, mOffset, DistributedVector::mpVec, mpVec, and DistributedVector::mSizeMultiplier.

Member Function Documentation

double& DistributedVector::Chunk::operator[] ( unsigned  globalIndex) throw (DistributedVectorException) [inline]

Access a particular element of the chunk if on this processor. For use in tests. Will throw a DistributedVectorException if the specified element is not on this process.

Parameters:
globalIndexindex within the chunk
Returns:
value of striped vector

Definition at line 277 of file DistributedVector.hpp.

References mHi, mLo, mOffset, and mpVec.

double& DistributedVector::Chunk::operator[] ( Iterator  index) throw (DistributedVectorException) [inline]
Parameters:
index
Returns:
value of striped distributed vector pointed to by index.

Definition at line 291 of file DistributedVector.hpp.

References mOffset, and mpVec.

Member Data Documentation

unsigned DistributedVector::Chunk::mHi [private]

One above the last entry owned by the current processor.

Definition at line 251 of file DistributedVector.hpp.

Referenced by Chunk(), and operator[]().

unsigned DistributedVector::Chunk::mLo [private]

The first entry owned by the current processor.

Definition at line 250 of file DistributedVector.hpp.

Referenced by Chunk(), and operator[]().

unsigned DistributedVector::Chunk::mOffset [private]

The start of this chunk within the locally-owned part of the vector.

Definition at line 248 of file DistributedVector.hpp.

Referenced by Chunk(), and operator[]().

double* DistributedVector::Chunk::mpVec [private]

The local part of the underlying PETSc vector.

Definition at line 249 of file DistributedVector.hpp.

Referenced by Chunk(), and operator[]().

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