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

TrilinosWrappers::MPI::BlockVector Class Reference
[Vector classesTrilinosWrappers]

Inheritance diagram for TrilinosWrappers::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 std::vector< Epetra_Map > &parallel_partitioning)
 BlockVector (const std::vector< IndexSet > &parallel_partitioning, const MPI_Comm &communicator=MPI_COMM_WORLD)
 BlockVector (const BlockVector &V)
 BlockVector (const unsigned int num_blocks)
 ~BlockVector ()
BlockVectoroperator= (const value_type s)
BlockVectoroperator= (const BlockVector &V)
BlockVectoroperator= (const ::TrilinosWrappers::BlockVector &V)
template<typename Number >
BlockVectoroperator= (const ::BlockVector< Number > &V)
void reinit (const std::vector< Epetra_Map > &parallel_partitioning, const bool fast=false)
void reinit (const std::vector< IndexSet > &parallel_partitioning, const MPI_Comm &communicator=MPI_COMM_WORLD, const bool fast=false)
void reinit (const BlockVector &V, const bool fast=false)
void reinit (const unsigned int num_blocks)
void import_nonlocal_data_for_fe (const TrilinosWrappers::BlockSparseMatrix &m, const BlockVector &v)
void compress (const Epetra_CombineMode last_action=Zero)
bool is_compressed () 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 vector class implemented in TrilinosWrappers. 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:
Martin Kronbichler, Wolfgang Bangerth, 2008, 2009

Definition at line 67 of file trilinos_block_vector.h.


Member Typedef Documentation

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

Definition at line 74 of file trilinos_block_vector.h.

Typedef the type of the underlying vector.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 80 of file trilinos_block_vector.h.

Import the typedefs from the base class.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 86 of file trilinos_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 87 of file trilinos_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 88 of file trilinos_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 89 of file trilinos_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 90 of file trilinos_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 91 of file trilinos_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 92 of file trilinos_block_vector.h.

Reimplemented from BlockVectorBase< Vector >.

Definition at line 93 of file trilinos_block_vector.h.


Constructor & Destructor Documentation

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

Default constructor. Generate an empty vector without any blocks.

Definition at line 413 of file trilinos_block_vector.h.

BlockVector< Number >::BlockVector ( const std::vector< Epetra_Map > &  parallel_partitioning ) [inline]

Constructor. Generate a block vector with as many blocks as there are entries in partitioning. Each Epetra_Map contains the layout of the distribution of data among the MPI processes.

Definition at line 419 of file trilinos_block_vector.h.

References reinit().

BlockVector< Number >::BlockVector ( const std::vector< IndexSet > &  parallel_partitioning,
const MPI_Comm &  communicator = MPI_COMM_WORLD 
) [inline]

Constructor. Generate a block vector with as many blocks as there are entries in partitioning. Each IndexSet together with the MPI communicator contains the layout of the distribution of data among the MPI processes.

Definition at line 427 of file trilinos_block_vector.h.

References reinit().

BlockVector< Number >::BlockVector ( const BlockVector V ) [inline]
BlockVector< Number >::BlockVector ( const unsigned int  num_blocks ) [inline]

Creates a block vector consisting of num_blocks components, but there is no content in the individual components and the user has to fill appropriate data using a reinit of the blocks.

Definition at line 436 of file trilinos_block_vector.h.

References reinit().

TrilinosWrappers::MPI::BlockVector::~BlockVector (  )

Destructor. Clears memory


Member Function Documentation

BlockVector& TrilinosWrappers::MPI::BlockVector::operator= ( const value_type  s )

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

BlockVector& TrilinosWrappers::MPI::BlockVector::operator= ( const BlockVector V )

Copy operator for arguments of the same type.

BlockVector& TrilinosWrappers::MPI::BlockVector::operator= ( const ::TrilinosWrappers::BlockVector V )

Copy operator for arguments of the localized Trilinos vector type.

template<typename Number >
BlockVector & BlockVector< Number >::operator= ( const ::BlockVector< Number > &  V )

Another copy function. This one takes a deal.II block vector and copies it into a TrilinosWrappers block vector. Note that the number of blocks has to be the same in the vector as in the input vector. Use the reinit() command for resizing the BlockVector or for changing the internal structure of the block components.

Since Trilinos only works on doubles, this function is limited to accept only one possible number type in the deal.II vector.

Definition at line 476 of file trilinos_block_vector.h.

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

void TrilinosWrappers::MPI::BlockVector::reinit ( const std::vector< Epetra_Map > &  parallel_partitioning,
const bool  fast = false 
)

Reinitialize the BlockVector to contain as many blocks as there are Epetra_Maps given in the input argument, according to the parallel distribution of the individual components described in the maps.

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

Referenced by BlockVector().

void TrilinosWrappers::MPI::BlockVector::reinit ( const std::vector< IndexSet > &  parallel_partitioning,
const MPI_Comm &  communicator = MPI_COMM_WORLD,
const bool  fast = false 
)

Reinitialize the BlockVector to contain as many blocks as there are index sets given in the input argument, according to the parallel distribution of the individual components described in the maps.

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

void TrilinosWrappers::MPI::BlockVector::reinit ( const BlockVector V,
const bool  fast = false 
)

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.

void TrilinosWrappers::MPI::BlockVector::reinit ( const unsigned int  num_blocks )

Change the number of blocks to num_blocks. The individual blocks will get initialized with zero size, so it is assumed that the user resizes the individual blocks by herself in an appropriate way, and calls collect_sizes afterwards.

void TrilinosWrappers::MPI::BlockVector::import_nonlocal_data_for_fe ( const TrilinosWrappers::BlockSparseMatrix m,
const BlockVector v 
)

This reinit function is meant to be used for parallel calculations where some non-local data has to be used. The typical situation where one needs this function is the call of the FEValues<dim>::get_function_values function (or of some derivatives) in parallel. Since it is usually faster to retrieve the data in advance, this function can be called before the assembly forks out to the different processors. What this function does is the following: It takes the information in the columns of the given matrix and looks which data couples between the different processors. That data is then queried from the input vector. Note that you should not write to the resulting vector any more, since the some data can be stored several times on different processors, leading to unpredictable results. In particular, such a vector cannot be used for matrix-vector products as for example done during the solution of linear systems.

void TrilinosWrappers::MPI::BlockVector::compress ( const Epetra_CombineMode  last_action = Zero )

Compress the underlying representation of the Trilinos object, i.e. flush the buffers of the vector object if it has any. This function is necessary after writing into a vector element-by-element and before anything else can be done on it.

The (defaulted) argument can be used to specify the compress mode (Add or Insert) in case the vector has not been written to since the last time this function was called. The argument is ignored if the vector has been added or written to since the last time compress() was called.

See Compressing distributed objects for more information. more information.

bool BlockVector< Number >::is_compressed (  ) const [inline]

Returns the state of the vector, i.e., whether compress() needs to be called after an operation requiring data exchange. Does only return non-true values when used in debug mode, since it is quite expensive to keep track of all operations that lead to the need for compress().

Definition at line 459 of file trilinos_block_vector.h.

References BlockVectorBase< Vector >::block(), and BlockVectorBase< Vector >::n_blocks().

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 497 of file trilinos_block_vector.h.

References Assert, BlockVectorBase< VectorType >::block(), BlockVectorBase< Vector >::block(), StandardExceptions::ExcDimensionMismatch(), BlockVectorBase< VectorType >::n_blocks(), BlockVectorBase< Vector >::n_blocks(), and Vector< Number >::swap().

Referenced by swap().

void TrilinosWrappers::MPI::BlockVector::print ( std::ostream &  out,
const unsigned int  precision = 3,
const bool  scientific = true,
const bool  across = true 
) const

Print to a stream.

::ExceptionBase& TrilinosWrappers::MPI::BlockVector::ExcIteratorRangeDoesNotMatchVectorSize (  ) [static]

Exception

::ExceptionBase& TrilinosWrappers::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:
Martin Kronbichler, Wolfgang Bangerth, 2008

Definition at line 517 of file trilinos_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:18 by doxygen 1.7.2