Public Types | Public Member Functions | Static Public Member Functions | Related Functions

PETScWrappers::MPI::BlockVector Class Reference
[PETScWrappersVector classes]

Inheritance diagram for PETScWrappers::MPI::BlockVector:
Inheritance graph
[legend]

List of all members.

Public Types

typedef BlockVectorBase< VectorBaseClass
typedef BaseClass::BlockType BlockType
typedef BaseClass::value_type value_type
typedef BaseClass::pointer pointer
typedef BaseClass::const_pointer const_pointer
typedef BaseClass::reference reference
typedef BaseClass::const_reference const_reference
typedef BaseClass::size_type size_type
typedef BaseClass::iterator iterator
typedef BaseClass::const_iterator const_iterator

Public Member Functions

 BlockVector ()
 BlockVector (const unsigned int n_blocks, const MPI_Comm &communicator, const unsigned int block_size, const unsigned int local_size)
 BlockVector (const BlockVector &V)
 BlockVector (const std::vector< unsigned int > &block_sizes, const MPI_Comm &communicator, const std::vector< unsigned int > &local_elements)
 ~BlockVector ()
BlockVectoroperator= (const value_type s)
BlockVectoroperator= (const BlockVector &V)
BlockVectoroperator= (const PETScWrappers::BlockVector &v)
void reinit (const unsigned int n_blocks, const MPI_Comm &communicator, const unsigned int block_size, const unsigned int local_size, const bool fast=false)
void reinit (const std::vector< unsigned int > &block_sizes, const MPI_Comm &communicator, const std::vector< unsigned int > &local_sizes, const bool fast=false)
void reinit (const BlockVector &V, const bool fast=false)
const MPI_Comm & get_mpi_communicator () const
void swap (BlockVector &v)
void print (std::ostream &out, const unsigned int precision=3, const bool scientific=true, const bool across=true) const

Static Public Member Functions

::ExceptionBaseExcIteratorRangeDoesNotMatchVectorSize ()
::ExceptionBaseExcNonMatchingBlockVectors ()

Related Functions

(Note that these are not member functions.)


void swap (BlockVector &u, BlockVector &v)

Detailed Description

An implementation of block vectors based on the parallel vector class implemented in PETScWrappers. While the base class provides for most of the interface, this class handles the actual allocation of vectors and provides functions that are specific to the underlying vector type.

The model of distribution of data is such that each of the blocks is distributed across all MPI processes named in the MPI communicator. I.e. we don't just distribute the whole vector, but each component. In the constructors and reinit() functions, one therefore not only has to specify the sizes of the individual blocks, but also the number of elements of each of these blocks to be stored on the local process.

See also:
Block (linear algebra)
Author:
Wolfgang Bangerth, 2004

Definition at line 57 of file petsc_parallel_block_vector.h.


Member Typedef Documentation

Typedef the base class for simpler access to its own typedefs.

Definition at line 64 of file petsc_parallel_block_vector.h.

Typedef the type of the underlying vector.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 70 of file petsc_parallel_block_vector.h.

Import the typedefs from the base class.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 76 of file petsc_parallel_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 77 of file petsc_parallel_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 78 of file petsc_parallel_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 79 of file petsc_parallel_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 80 of file petsc_parallel_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 81 of file petsc_parallel_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 82 of file petsc_parallel_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 83 of file petsc_parallel_block_vector.h.


Constructor & Destructor Documentation

BlockVector< Number >::BlockVector (  ) [inline]

Default constructor. Generate an empty vector without any blocks.

Definition at line 331 of file petsc_parallel_block_vector.h.

BlockVector< Number >::BlockVector ( const unsigned int  n_blocks,
const MPI_Comm &  communicator,
const unsigned int  block_size,
const unsigned int  local_size 
) [inline, explicit]

Constructor. Generate a block vector with n_blocks blocks, each of which is a parallel vector across communicator with block_size elements of which local_size elements are stored on the present process.

Definition at line 337 of file petsc_parallel_block_vector.h.

References reinit().

BlockVector< Number >::BlockVector ( const BlockVector V ) [inline]
BlockVector< Number >::BlockVector ( const std::vector< unsigned int > &  block_sizes,
const MPI_Comm &  communicator,
const std::vector< unsigned int > &  local_elements 
) [inline]

Constructor. Set the number of blocks to block_sizes.size() and initialize each block with block_sizes[i] zero elements. The individual blocks are distributed across the given communicator, and each store local_elements[i] elements on the present process.

Definition at line 348 of file petsc_parallel_block_vector.h.

References reinit().

BlockVector< Number >::~BlockVector (  ) [inline]

Destructor. Clears memory

Definition at line 391 of file petsc_parallel_block_vector.h.


Member Function Documentation

BlockVector & BlockVector< Number >::operator= ( const value_type  s ) [inline]

Copy operator: fill all components of the vector that are locally stored with the given scalar value.

Definition at line 372 of file petsc_parallel_block_vector.h.

References BlockVectorBase< Vector >::operator=().

BlockVector & BlockVector< Number >::operator= ( const BlockVector V ) [inline]

Copy operator for arguments of the same type.

Definition at line 382 of file petsc_parallel_block_vector.h.

References BlockVectorBase< Vector >::operator=().

BlockVector& PETScWrappers::MPI::BlockVector::operator= ( const PETScWrappers::BlockVector v )

Copy the given sequential (non-distributed) block vector into the present parallel block vector. It is assumed that they have the same size, and this operation does not change the partitioning of the parallel vectors by which its elements are distributed across several MPI processes. What this operation therefore does is to copy that chunk of the given vector v that corresponds to elements of the target vector that are stored locally, and copies them, for each of the individual blocks of this object. Elements that are not stored locally are not touched.

This being a parallel vector, you must make sure that all processes call this function at the same time. It is not possible to change the local part of a parallel vector on only one process, independent of what other processes do, with this function.

void BlockVector< Number >::reinit ( const unsigned int  n_blocks,
const MPI_Comm &  communicator,
const unsigned int  block_size,
const unsigned int  local_size,
const bool  fast = false 
) [inline]

Reinitialize the BlockVector to contain n_blocks of size block_size, each of which stores local_size elements locally. The communicator argument denotes which MPI channel each of these blocks shall communicate.

If fast==false, the vector is filled with zeros.

Definition at line 397 of file petsc_parallel_block_vector.h.

Referenced by BlockVector(), and reinit().

void BlockVector< Number >::reinit ( const std::vector< unsigned int > &  block_sizes,
const MPI_Comm &  communicator,
const std::vector< unsigned int > &  local_sizes,
const bool  fast = false 
) [inline]

Reinitialize the BlockVector such that it contains block_sizes.size() blocks. Each block is reinitialized to dimension block_sizes[i]. Each of them stores local_sizes[i] elements on the present process.

If the number of blocks is the same as before this function was called, all vectors remain the same and reinit() is called for each vector.

If fast==false, the vector is filled with zeros.

Note that you must call this (or the other reinit() functions) function, rather than calling the reinit() functions of an individual block, to allow the block vector to update its caches of vector sizes. If you call reinit() of one of the blocks, then subsequent actions on this object may yield unpredictable results since they may be routed to the wrong block.

Definition at line 413 of file petsc_parallel_block_vector.h.

References BlockVectorBase< Vector >::block_indices, BlockVectorBase< Vector >::components, BlockVectorBase< Vector >::n_blocks(), reinit(), and BlockIndices::reinit().

void BlockVector< Number >::reinit ( const BlockVector V,
const bool  fast = false 
) [inline]

Change the dimension to that of the vector V. The same applies as for the other reinit() function.

The elements of V are not copied, i.e. this function is the same as calling reinit (V.size(), fast).

Note that you must call this (or the other reinit() functions) function, rather than calling the reinit() functions of an individual block, to allow the block vector to update its caches of vector sizes. If you call reinit() on one of the blocks, then subsequent actions on this object may yield unpredictable results since they may be routed to the wrong block.

Definition at line 430 of file petsc_parallel_block_vector.h.

References BlockVectorBase< VectorType >::block(), BlockVectorBase< Vector >::block(), BlockVectorBase< Vector >::block_indices, BlockVectorBase< Vector >::components, BlockVectorBase< VectorType >::get_block_indices(), BlockVectorBase< Vector >::n_blocks(), and Vector< Number >::reinit().

const MPI_Comm & BlockVector< Number >::get_mpi_communicator (  ) const [inline]

Return a reference to the MPI communicator object in use with this vector.

Definition at line 445 of file petsc_parallel_block_vector.h.

References BlockVectorBase< Vector >::block().

void BlockVector< Number >::swap ( BlockVector v ) [inline]

Swap the contents of this vector and the other vector v. One could do this operation with a temporary variable and copying over the data elements, but this function is significantly more efficient since it only swaps the pointers to the data of the two vectors and therefore does not need to allocate temporary storage and move data around.

Limitation: right now this function only works if both vectors have the same number of blocks. If needed, the numbers of blocks should be exchanged, too.

This function is analog to the the swap() function of all C++ standard containers. Also, there is a global function swap(u,v) that simply calls u.swap(v), again in analogy to standard functions.

Definition at line 454 of file petsc_parallel_block_vector.h.

References Assert, BlockVectorBase< VectorType >::block_indices, BlockVectorBase< Vector >::block_indices, BlockVectorBase< VectorType >::components, BlockVectorBase< Vector >::components, StandardExceptions::ExcDimensionMismatch(), BlockVectorBase< VectorType >::n_blocks(), and BlockVectorBase< Vector >::n_blocks().

Referenced by swap().

void BlockVector< Number >::print ( std::ostream &  out,
const unsigned int  precision = 3,
const bool  scientific = true,
const bool  across = true 
) const [inline]
::ExceptionBase& PETScWrappers::MPI::BlockVector::ExcIteratorRangeDoesNotMatchVectorSize (  ) [static]

Exception

::ExceptionBase& PETScWrappers::MPI::BlockVector::ExcNonMatchingBlockVectors (  ) [static]

Exception


Friends And Related Function Documentation

void swap ( BlockVector u,
BlockVector v 
) [related]

Global function which overloads the default implementation of the C++ standard library which uses a temporary object. The function simply exchanges the data of the two vectors.

Author:
Wolfgang Bangerth, 2000

Definition at line 494 of file petsc_parallel_block_vector.h.

References swap().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:16 by doxygen 1.7.2