 |
Reference documentation for deal.II version 9.1.0-pre
|
|
Reference documentation for deal.II version 9.1.0-pre
|
#include <deal.II/lac/petsc_block_vector.h>
Public Types | |
| using | BaseClass = BlockVectorBase< Vector > |
| using | BlockType = BaseClass::BlockType |
| using | value_type = BaseClass::value_type |
 Public Types inherited from BlockVectorBase< Vector > | |
| using | BlockType = Vector |
| using | real_type = typename BlockType::real_type |
Public Member Functions | |
| BlockVector ()=default | |
| BlockVector (const unsigned int n_blocks, const MPI_Comm &communicator, const size_type block_size, const size_type local_size) | |
| BlockVector (const BlockVector &V) | |
| BlockVector (const std::vector< size_type > &block_sizes, const MPI_Comm &communicator, const std::vector< size_type > &local_elements) | |
| BlockVector (const std::vector< IndexSet > ¶llel_partitioning, const MPI_Comm &communicator=MPI_COMM_WORLD) | |
| BlockVector (const std::vector< IndexSet > ¶llel_partitioning, const std::vector< IndexSet > &ghost_indices, const MPI_Comm &communicator) | |
| ~BlockVector () override=default | |
| BlockVector & | operator= (const value_type s) |
| BlockVector & | operator= (const BlockVector &V) |
| void | reinit (const unsigned int n_blocks, const MPI_Comm &communicator, const size_type block_size, const size_type local_size, const bool omit_zeroing_entries=false) |
| void | reinit (const std::vector< size_type > &block_sizes, const MPI_Comm &communicator, const std::vector< size_type > &local_sizes, const bool omit_zeroing_entries=false) |
| void | reinit (const BlockVector &V, const bool omit_zeroing_entries=false) |
| void | reinit (const std::vector< IndexSet > ¶llel_partitioning, const MPI_Comm &communicator) |
| void | reinit (const std::vector< IndexSet > ¶llel_partitioning, const std::vector< IndexSet > &ghost_entries, const MPI_Comm &communicator) |
| void | reinit (const unsigned int num_blocks) |
| bool | has_ghost_elements () const |
| 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 |
| Public Member Functions inherited from BlockVectorBase< Vector > | |
| BlockVectorBase ()=default | |
| BlockVectorBase (const BlockVectorBase &)=default | |
| BlockVectorBase (BlockVectorBase &&) noexcept=default | |
| void | collect_sizes () |
| void | compress (::VectorOperation::values operation) |
| BlockType & | block (const unsigned int i) |
| const BlockType & | block (const unsigned int i) const |
| const BlockIndices & | get_block_indices () const |
| unsigned int | n_blocks () const |
| std::size_t | size () const |
| IndexSet | locally_owned_elements () const |
| iterator | begin () |
| const_iterator | begin () const |
| iterator | end () |
| const_iterator | end () const |
| value_type | operator() (const size_type i) const |
| reference | operator() (const size_type i) |
| value_type | operator[] (const size_type i) const |
| reference | operator[] (const size_type i) |
| void | extract_subvector_to (const std::vector< size_type > &indices, std::vector< OtherNumber > &values) const |
| void | extract_subvector_to (ForwardIterator indices_begin, const ForwardIterator indices_end, OutputIterator values_begin) const |
| BlockVectorBase & | operator= (const value_type s) |
| BlockVectorBase & | operator= (const BlockVectorBase &V) |
| BlockVectorBase & | operator= (BlockVectorBase &&)=default |
| BlockVectorBase & | operator= (const BlockVectorBase< VectorType2 > &V) |
| BlockVectorBase & | operator= (const Vector &v) |
| bool | operator== (const BlockVectorBase< VectorType2 > &v) const |
| value_type | operator* (const BlockVectorBase &V) const |
| real_type | norm_sqr () const |
| value_type | mean_value () const |
| real_type | l1_norm () const |
| real_type | l2_norm () const |
| real_type | linfty_norm () const |
| value_type | add_and_dot (const value_type a, const BlockVectorBase &V, const BlockVectorBase &W) |
| bool | in_local_range (const size_type global_index) const |
| bool | all_zero () const |
| bool | is_non_negative () const |
| BlockVectorBase & | operator+= (const BlockVectorBase &V) |
| BlockVectorBase & | operator-= (const BlockVectorBase &V) |
| void | add (const std::vector< size_type > &indices, const std::vector< Number > &values) |
| void | add (const std::vector< size_type > &indices, const Vector< Number > &values) |
| void | add (const size_type n_elements, const size_type *indices, const Number *values) |
| void | add (const value_type s) |
| void | add (const value_type a, const BlockVectorBase &V) |
| void | add (const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W) |
| void | sadd (const value_type s, const BlockVectorBase &V) |
| void | sadd (const value_type s, const value_type a, const BlockVectorBase &V) |
| void | sadd (const value_type s, const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W) |
| void | sadd (const value_type s, const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W, const value_type c, const BlockVectorBase &X) |
| BlockVectorBase & | operator*= (const value_type factor) |
| BlockVectorBase & | operator/= (const value_type factor) |
| void | scale (const BlockVector2 &v) |
| void | equ (const value_type a, const BlockVector2 &V) |
| void | equ (const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W) |
| void | update_ghost_values () const |
| std::size_t | memory_consumption () const |
| Public Member Functions inherited from Subscriptor | |
| Subscriptor () | |
| Subscriptor (const Subscriptor &) | |
| Subscriptor (Subscriptor &&) noexcept | |
| virtual | ~Subscriptor () |
| Subscriptor & | operator= (const Subscriptor &) |
| Subscriptor & | operator= (Subscriptor &&) noexcept |
| void | subscribe (const char *identifier=nullptr) const |
| void | unsubscribe (const char *identifier=nullptr) const |
| unsigned int | n_subscriptions () const |
| template<typename StreamType > | |
| void | list_subscribers (StreamType &stream) const |
| void | list_subscribers () const |
| template<class Archive > | |
| void | serialize (Archive &ar, const unsigned int version) |
Static Public Member Functions | |
| static::ExceptionBase & | ExcIteratorRangeDoesNotMatchVectorSize () |
| static::ExceptionBase & | ExcNonMatchingBlockVectors () |
| Static Public Member Functions inherited from Subscriptor | |
| static::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
| static::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Related Functions | |
(Note that these are not member functions.) | |
| void | swap (BlockVector &u, BlockVector &v) |
Additional Inherited Members | |
| Protected Attributes inherited from BlockVectorBase< Vector > | |
| std::vector< Vector > | components |
| BlockIndices | block_indices |
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.
Definition at line 61 of file petsc_block_vector.h.
Typedef the base class for simpler access to its own alias.
Definition at line 67 of file petsc_block_vector.h.
Typedef the type of the underlying vector.
Definition at line 72 of file petsc_block_vector.h.
| using PETScWrappers::MPI::BlockVector::value_type = BaseClass::value_type |
Import the alias from the base class.
Definition at line 77 of file petsc_block_vector.h.
|
default |
Default constructor. Generate an empty vector without any blocks.
|
inlineexplicit |
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 293 of file petsc_block_vector.h.
|
inline |
Copy constructor. Set all the properties of the parallel vector to those of the given argument and copy the elements.
Definition at line 312 of file petsc_block_vector.h.
|
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 303 of file petsc_block_vector.h.
|
inlineexplicit |
Create a BlockVector with parallel_partitioning.size() blocks, each initialized with the given IndexSet.
Definition at line 322 of file petsc_block_vector.h.
|
inline |
Same as above, but include ghost elements
Definition at line 329 of file petsc_block_vector.h.
|
overridedefault |
Destructor. Clears memory
|
inline |
Copy operator: fill all components of the vector that are locally stored with the given scalar value.
Definition at line 338 of file petsc_block_vector.h.
|
inline |
Copy operator for arguments of the same type.
Definition at line 345 of file petsc_block_vector.h.
|
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 omit_zeroing_entries==false, the vector is filled with zeros.
Definition at line 366 of file petsc_block_vector.h.
|
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 omit_zeroing_entries==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 381 of file petsc_block_vector.h.
|
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(), omit_zeroing_entries).
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 399 of file petsc_block_vector.h.
|
inline |
Reinitialize the BlockVector using IndexSets. See the constructor with the same arguments for details.
Definition at line 410 of file petsc_block_vector.h.
|
inline |
Same as above but include ghost entries.
Definition at line 426 of file petsc_block_vector.h.
| void BlockVector< Number >::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.
Definition at line 29 of file petsc_parallel_block_vector.cc.
|
inline |
Return if this vector is a ghosted vector (and thus read-only).
Definition at line 453 of file petsc_block_vector.h.
|
inline |
Return a reference to the MPI communicator object in use with this vector.
Definition at line 447 of file petsc_block_vector.h.
|
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 analogous to 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 465 of file petsc_block_vector.h.
|
inline |
Print to a stream.
Definition at line 475 of file petsc_block_vector.h.
|
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.
Definition at line 501 of file petsc_block_vector.h.
1.8.11
