#include <DistributedVector.hpp>

Collaboration diagram for DistributedVector:

Classes
class	Chunk

class	Iterator

class	Stripe

Public Member Functions
bool	IsGlobalIndexLocal (unsigned globalIndex)

	DistributedVector (Vec vec, DistributedVectorFactory *pFactory, bool readOnly=false)

unsigned	GetHigh () const

unsigned	GetLow () const

DistributedVectorFactory *	GetFactory ()

double &	operator[] (unsigned globalIndex)

void	Restore ()

Iterator	Begin ()

Iterator	End ()

double &	operator[] (Iterator index)

Private Attributes
unsigned	mLo

unsigned	mHi

unsigned	mProblemSize

unsigned	mSizeMultiplier

Vec	mVec

double *	mpVec

DistributedVectorFactory *	mpFactory

bool	mReadOnly

Friends
class	TestDistributedVector

Detailed Description

Gives access to the local portion of a PETSc vector via an iterator.

It also provides two nested classes for accessing vectors with particular memory layouts: striped and chunked.

Definition at line 55 of file DistributedVector.hpp.

Constructor & Destructor Documentation

DistributedVector::DistributedVector	(	Vec	vec,
		DistributedVectorFactory *	pFactory,
		bool	readOnly = `false`
	)

Constructor. This class represents the portion of a distributed PETSc vector on this process.

Note that this class does NOT take over responsibility for destroying the Vec.

Parameters

vec	PETSc vector of which this class shall be a portion
readOnly	A suggestion to PETSc that we are not going to change the content of the Vec (Note that it may still be possible to alter the content of the vector in an inconsistent way – the user is responsible for ensuring that this doesn't happen.) *
pFactory	pointer to the DistributedVectorFactory used to create this vector

Definition at line 44 of file DistributedVector.cpp.

References DistributedVectorFactory::GetHigh(), DistributedVectorFactory::GetLow(), DistributedVectorFactory::GetProblemSize(), mHi, mLo, mProblemSize, mpVec, mReadOnly, and mSizeMultiplier.

Member Function Documentation

DistributedVector::Iterator DistributedVector::Begin ( )

Returns: iterator pointing to the first element of the distributed vector on this process

Definition at line 124 of file DistributedVector.cpp.

References DistributedVector::Iterator::Global, DistributedVector::Iterator::Local, and mLo.

DistributedVector::Iterator DistributedVector::End ( )

Returns: iterator pointing to one past the last element of the distributed vector on this process

Definition at line 132 of file DistributedVector.cpp.

References DistributedVector::Iterator::Global, DistributedVector::Iterator::Local, mHi, and mLo.

DistributedVectorFactory* DistributedVector::GetFactory ( )

inline

Returns: the factory used to create this vector.

Definition at line 139 of file DistributedVector.hpp.

References mpFactory.

Referenced by DistributedVector::Stripe::Stripe().

unsigned DistributedVector::GetHigh ( ) const

inline

Returns: mHi - The next index above the top one owned by the process.

Definition at line 123 of file DistributedVector.hpp.

References mHi.

Referenced by DistributedVector::Chunk::Chunk(), and DistributedVector::Stripe::Stripe().

unsigned DistributedVector::GetLow ( ) const

inline

Returns: mLo - The lowest index owned by the process.

Definition at line 131 of file DistributedVector.hpp.

References mLo.

Referenced by DistributedVector::Chunk::Chunk(), and DistributedVector::Stripe::Stripe().

bool DistributedVector::IsGlobalIndexLocal ( unsigned globalIndex )

Test if the given global index is owned by the current process, i.e. is local to it.

Parameters

globalIndex

Returns: true if the global index can be accessed by this process

Definition at line 39 of file DistributedVector.cpp.

References mHi, and mLo.

Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToNonlinearResidual().

double & DistributedVector::operator[] ( unsigned globalIndex )

Parameters

globalIndex

Returns: value of distributed vector at globalIndex Do not use if stride>1. For use in tests. Will throw a DistributedVectorException if the specified element is not on this process.

Definition at line 78 of file DistributedVector.cpp.

References mHi, mLo, mpVec, and mSizeMultiplier.

double & DistributedVector::operator[] ( Iterator index )

Parameters

index

Returns: value of distributed vector pointed to by index. Do not use if stride>1.

Definition at line 88 of file DistributedVector.cpp.

References DistributedVector::Iterator::Local, mpVec, and mSizeMultiplier.

void DistributedVector::Restore ( )

Store elements that have been written to back into the PETSc vector. Call after you have finished writing. It appears that you do not need to call this if you only read from the vector.

Calling this method when the mReadOnly flag is set results in error (as a reminder that there should be no changes to the data in the original Vec).

Definition at line 94 of file DistributedVector.cpp.

References mpVec, mReadOnly, and mVec.

Member Data Documentation

unsigned DistributedVector::mHi

private

One above the last entry owned by the current processor.

Definition at line 66 of file DistributedVector.hpp.

Referenced by DistributedVector(), End(), GetHigh(), IsGlobalIndexLocal(), and operator[]().

unsigned DistributedVector::mLo

private

The first entry owned by the current processor.

Definition at line 63 of file DistributedVector.hpp.

Referenced by Begin(), DistributedVector(), End(), GetLow(), IsGlobalIndexLocal(), and operator[]().

DistributedVectorFactory* DistributedVector::mpFactory

private

Pointer to the factory that created this DistributedVector. Gives access to local and global sizes

Definition at line 86 of file DistributedVector.hpp.

Referenced by GetFactory().

unsigned DistributedVector::mProblemSize

private

The problem size, i.e. the length of the vector of unknowns.

Definition at line 69 of file DistributedVector.hpp.

Referenced by DistributedVector().

double* DistributedVector::mpVec

private

The local part of the underlying PETSc vector.

Definition at line 80 of file DistributedVector.hpp.

Referenced by DistributedVector::Chunk::Chunk(), DistributedVector(), operator[](), Restore(), and DistributedVector::Stripe::Stripe().

bool DistributedVector::mReadOnly

private

A hint to PETSc that we only want to read from the vector (and never write). Note that it may still be possible to alter the content of the vector in an inconsistent way – the user is responsible for ensuring that this doesn't happen. The only makes sense with PETSc 3.2 and above.

Definition at line 93 of file DistributedVector.hpp.

Referenced by DistributedVector(), and Restore().

unsigned DistributedVector::mSizeMultiplier

private

How much bigger this vector is than the problem size.

Definition at line 74 of file DistributedVector.hpp.

Referenced by DistributedVector::Chunk::Chunk(), DistributedVector(), operator[](), and DistributedVector::Stripe::Stripe().

Vec DistributedVector::mVec

private

The underlying PETSc vector.

Definition at line 77 of file DistributedVector.hpp.

Referenced by Restore().

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

global/src/parallel/DistributedVector.hpp
global/src/parallel/DistributedVector.cpp

Classes

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation