 |
Reference documentation for deal.II version 9.4.1
|
Loading...
Searching...
No Matches
|
Reference documentation for deal.II version 9.4.1
|
#include <deal.II/lac/block_sparse_matrix.h>
Public Types | |
| using | BaseClass = BlockMatrixBase< SparseMatrix< number > > |
| using | BlockType = typename BaseClass::BlockType |
| using | value_type = typename BaseClass::value_type |
| using | pointer = typename BaseClass::pointer |
| using | const_pointer = typename BaseClass::const_pointer |
| using | reference = typename BaseClass::reference |
| using | const_reference = typename BaseClass::const_reference |
| using | size_type = typename BaseClass::size_type |
| using | iterator = typename BaseClass::iterator |
| using | const_iterator = typename BaseClass::const_iterator |
| using | real_type = typename numbers::NumberTraits< value_type >::real_type |
Public Member Functions | |
| BlockMatrixBase & | copy_from (const BlockMatrixType &source) |
| BlockType & | block (const unsigned int row, const unsigned int column) |
| const BlockType & | block (const unsigned int row, const unsigned int column) const |
| size_type | m () const |
| size_type | n () const |
| unsigned int | n_block_rows () const |
| unsigned int | n_block_cols () const |
| void | set (const size_type i, const size_type j, const value_type value) |
| void | set (const std::vector< size_type > &indices, const FullMatrix< number > &full_matrix, const bool elide_zero_values=false) |
| void | set (const std::vector< size_type > &row_indices, const std::vector< size_type > &col_indices, const FullMatrix< number > &full_matrix, const bool elide_zero_values=false) |
| void | set (const size_type row, const std::vector< size_type > &col_indices, const std::vector< number > &values, const bool elide_zero_values=false) |
| void | set (const size_type row, const size_type n_cols, const size_type *col_indices, const number *values, const bool elide_zero_values=false) |
| void | add (const size_type i, const size_type j, const value_type value) |
| void | add (const std::vector< size_type > &indices, const FullMatrix< number > &full_matrix, const bool elide_zero_values=true) |
| void | add (const std::vector< size_type > &row_indices, const std::vector< size_type > &col_indices, const FullMatrix< number > &full_matrix, const bool elide_zero_values=true) |
| void | add (const size_type row, const std::vector< size_type > &col_indices, const std::vector< number > &values, const bool elide_zero_values=true) |
| void | add (const size_type row, const size_type n_cols, const size_type *col_indices, const number *values, const bool elide_zero_values=true, const bool col_indices_are_sorted=false) |
| void | add (const value_type factor, const BlockMatrixBase< SparseMatrix< number > > &matrix) |
| value_type | operator() (const size_type i, const size_type j) const |
| value_type | el (const size_type i, const size_type j) const |
| value_type | diag_element (const size_type i) const |
| void | compress (::VectorOperation::values operation) |
| BlockMatrixBase & | operator*= (const value_type factor) |
| BlockMatrixBase & | operator/= (const value_type factor) |
| void | vmult_add (BlockVectorType &dst, const BlockVectorType &src) const |
| void | Tvmult_add (BlockVectorType &dst, const BlockVectorType &src) const |
| value_type | matrix_norm_square (const BlockVectorType &v) const |
| real_type | frobenius_norm () const |
| value_type | matrix_scalar_product (const BlockVectorType &u, const BlockVectorType &v) const |
| value_type | residual (BlockVectorType &dst, const BlockVectorType &x, const BlockVectorType &b) const |
| void | print (std::ostream &out, const bool alternative_output=false) const |
| iterator | begin () |
| iterator | begin (const size_type r) |
| const_iterator | begin () const |
| const_iterator | begin (const size_type r) const |
| iterator | end () |
| iterator | end (const size_type r) |
| const_iterator | end () const |
| const_iterator | end (const size_type r) const |
| const BlockIndices & | get_row_indices () const |
| const BlockIndices & | get_column_indices () const |
Constructors and initialization | |
| BlockSparseMatrix ()=default | |
| BlockSparseMatrix (const BlockSparsityPattern &sparsity) | |
| virtual | ~BlockSparseMatrix () override |
| BlockSparseMatrix & | operator= (const BlockSparseMatrix &) |
| BlockSparseMatrix & | operator= (const double d) |
| void | clear () |
| virtual void | reinit (const BlockSparsityPattern &sparsity) |
Information on the matrix | |
| bool | empty () const |
| size_type | get_row_length (const size_type row) const |
| size_type | n_nonzero_elements () const |
| size_type | n_actually_nonzero_elements (const double threshold=0.0) const |
| const BlockSparsityPattern & | get_sparsity_pattern () const |
| std::size_t | memory_consumption () const |
Multiplications | |
| template<typename block_number > | |
| void | vmult (BlockVector< block_number > &dst, const BlockVector< block_number > &src) const |
| template<typename block_number , typename nonblock_number > | |
| void | vmult (BlockVector< block_number > &dst, const Vector< nonblock_number > &src) const |
| template<typename block_number , typename nonblock_number > | |
| void | vmult (Vector< nonblock_number > &dst, const BlockVector< block_number > &src) const |
| template<typename nonblock_number > | |
| void | vmult (Vector< nonblock_number > &dst, const Vector< nonblock_number > &src) const |
| template<typename block_number > | |
| void | Tvmult (BlockVector< block_number > &dst, const BlockVector< block_number > &src) const |
| template<typename block_number , typename nonblock_number > | |
| void | Tvmult (BlockVector< block_number > &dst, const Vector< nonblock_number > &src) const |
| template<typename block_number , typename nonblock_number > | |
| void | Tvmult (Vector< nonblock_number > &dst, const BlockVector< block_number > &src) const |
| template<typename nonblock_number > | |
| void | Tvmult (Vector< nonblock_number > &dst, const Vector< nonblock_number > &src) const |
Preconditioning methods | |
| template<class BlockVectorType > | |
| void | precondition_Jacobi (BlockVectorType &dst, const BlockVectorType &src, const number omega=1.) const |
| template<typename number2 > | |
| void | precondition_Jacobi (Vector< number2 > &dst, const Vector< number2 > &src, const number omega=1.) const |
Static Public Member Functions | |
| static ::ExceptionBase & | ExcIncompatibleRowNumbers (int arg1, int arg2, int arg3, int arg4) |
| static ::ExceptionBase & | ExcIncompatibleColNumbers (int arg1, int arg2, int arg3, int arg4) |
Protected Member Functions | |
| void | collect_sizes () |
| void | vmult_block_block (BlockVectorType &dst, const BlockVectorType &src) const |
| void | vmult_block_nonblock (BlockVectorType &dst, const VectorType &src) const |
| void | vmult_nonblock_block (VectorType &dst, const BlockVectorType &src) const |
| void | vmult_nonblock_nonblock (VectorType &dst, const VectorType &src) const |
| void | Tvmult_block_block (BlockVectorType &dst, const BlockVectorType &src) const |
| void | Tvmult_block_nonblock (BlockVectorType &dst, const VectorType &src) const |
| void | Tvmult_nonblock_block (VectorType &dst, const BlockVectorType &src) const |
| void | Tvmult_nonblock_nonblock (VectorType &dst, const VectorType &src) const |
| void | prepare_add_operation () |
| void | prepare_set_operation () |
Protected Attributes | |
| BlockIndices | row_block_indices |
| BlockIndices | column_block_indices |
| Table< 2, SmartPointer< BlockType, BlockMatrixBase< SparseMatrix< number > > > > | sub_objects |
Private Attributes | |
| TemporaryData | temporary_data |
Input/Output | |
| SmartPointer< const BlockSparsityPattern, BlockSparseMatrix< number > > | sparsity_pattern |
| void | print_formatted (std::ostream &out, const unsigned int precision=3, const bool scientific=true, const unsigned int width=0, const char *zero_string=" ", const double denominator=1.) const |
| static ::ExceptionBase & | ExcBlockDimensionMismatch () |
Subscriptor functionality | |
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class. | |
| std::atomic< unsigned int > | counter |
| std::map< std::string, unsigned int > | counter_map |
| std::vector< std::atomic< bool > * > | validity_pointers |
| const std::type_info * | object_info |
| void | subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
| void | unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") 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 ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
| static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
| using | map_value_type = decltype(counter_map)::value_type |
| using | map_iterator = decltype(counter_map)::iterator |
| static std::mutex | mutex |
| void | check_no_subscribers () const noexcept |
Blocked sparse matrix based on the SparseMatrix class. This class implements the functions that are specific to the SparseMatrix base objects for a blocked sparse matrix, and leaves the actual work relaying most of the calls to the individual blocks to the functions implemented in the base class. See there also for a description of when this class is useful.
Definition at line 49 of file block_sparse_matrix.h.
|
inherited |
Definition at line 362 of file block_matrix_base.h.
|
inherited |
Copy the matrix given as argument into the current object.
Copying matrices is an expensive operation that we do not want to happen by accident through compiler generated code for operator=. (This would happen, for example, if one accidentally declared a function argument of the current type by value rather than by reference.) The functionality of copying matrices is implemented in this member function instead. All copy operations of objects of this type therefore require an explicit function call.
The source matrix may be a matrix of arbitrary type, as long as its data type is convertible to the data type of this matrix.
The function returns a reference to this.
|
inherited |
Access the block with the given coordinates.
|
inherited |
Access the block with the given coordinates. Version for constant objects.
|
inherited |
Return the dimension of the codomain (or range) space. Note that the matrix is of dimension \(m \times n\).
|
inherited |
Return the dimension of the domain space. Note that the matrix is of dimension \(m \times n\).
|
inherited |
Return the number of blocks in a column. Returns zero if no sparsity pattern is presently associated to this matrix.
|
inherited |
Return the number of blocks in a row. Returns zero if no sparsity pattern is presently associated to this matrix.
|
inherited |
Set the element (i,j) to value. Throws an error if the entry does not exist or if value is not a finite number. Still, it is allowed to store zero values in non-existent fields.
|
inherited |
Set all elements given in a FullMatrix into the sparse matrix locations given by indices. In other words, this function writes the elements in full_matrix into the calling matrix, using the local-to-global indexing specified by indices for both the rows and the columns of the matrix. This function assumes a quadratic sparse matrix and a quadratic full_matrix, the usual situation in FE calculations.
The optional parameter elide_zero_values can be used to specify whether zero values should be set anyway or they should be filtered away (and not change the previous content in the respective element if it exists). The default value is false, i.e., even zero values are treated.
|
inherited |
Same function as before, but now including the possibility to use rectangular full_matrices and different local-to-global indexing on rows and columns, respectively.
|
inherited |
Set several elements in the specified row of the matrix with column indices as given by col_indices to the respective value.
The optional parameter elide_zero_values can be used to specify whether zero values should be set anyway or they should be filtered away (and not change the previous content in the respective element if it exists). The default value is false, i.e., even zero values are treated.
|
inherited |
Set several elements to values given by values in a given row in columns given by col_indices into the sparse matrix.
The optional parameter elide_zero_values can be used to specify whether zero values should be inserted anyway or they should be filtered away. The default value is false, i.e., even zero values are inserted/replaced.
|
inherited |
Add value to the element (i,j). Throws an error if the entry does not exist or if value is not a finite number. Still, it is allowed to store zero values in non-existent fields.
|
inherited |
Add all elements given in a FullMatrix<double> into sparse matrix locations given by indices. In other words, this function adds the elements in full_matrix to the respective entries in calling matrix, using the local-to-global indexing specified by indices for both the rows and the columns of the matrix. This function assumes a quadratic sparse matrix and a quadratic full_matrix, the usual situation in FE calculations.
The optional parameter elide_zero_values can be used to specify whether zero values should be added anyway or these should be filtered away and only non-zero data is added. The default value is true, i.e., zero values won't be added into the matrix.
|
inherited |
Same function as before, but now including the possibility to use rectangular full_matrices and different local-to-global indexing on rows and columns, respectively.
|
inherited |
Set several elements in the specified row of the matrix with column indices as given by col_indices to the respective value.
The optional parameter elide_zero_values can be used to specify whether zero values should be added anyway or these should be filtered away and only non-zero data is added. The default value is true, i.e., zero values won't be added into the matrix.
|
inherited |
Add an array of values given by values in the given global matrix row at columns specified by col_indices in the sparse matrix.
The optional parameter elide_zero_values can be used to specify whether zero values should be added anyway or these should be filtered away and only non-zero data is added. The default value is true, i.e., zero values won't be added into the matrix.
|
inherited |
Add matrix scaled by factor to this matrix, i.e. the matrix factor*matrix is added to this. If the sparsity pattern of the calling matrix does not contain all the elements in the sparsity pattern of the input matrix, this function will throw an exception.
Depending on MatrixType, however, additional restrictions might arise. Some sparse matrix formats require matrix to be based on the same sparsity pattern as the calling matrix.
|
inherited |
Return the value of the entry (i,j). This may be an expensive operation and you should always take care where to call this function. In order to avoid abuse, this function throws an exception if the wanted element does not exist in the matrix.
|
inherited |
This function is mostly like operator()() in that it returns the value of the matrix entry (i,j). The only difference is that if this entry does not exist in the sparsity pattern, then instead of raising an exception, zero is returned. While this may be convenient in some cases, note that it is simple to write algorithms that are slow compared to an optimal solution, since the sparsity of the matrix is not used.
|
inherited |
Return the main diagonal element in the ith row. This function throws an error if the matrix is not quadratic and also if the diagonal blocks of the matrix are not quadratic.
This function is considerably faster than the operator()(), since for quadratic matrices, the diagonal entry may be the first to be stored in each row and access therefore does not involve searching for the right column number.
|
inherited |
Call the compress() function on all the subblocks of the matrix.
See Compressing distributed objects for more information.
|
inherited |
Multiply the entire matrix by a fixed factor.
|
inherited |
Divide the entire matrix by a fixed factor.
|
inherited |
Adding Matrix-vector multiplication. Add \(M*src\) on \(dst\) with \(M\) being this matrix.
|
inherited |
Adding Matrix-vector multiplication. Add MTsrc to dst with M being this matrix. This function does the same as vmult_add() but takes the transposed matrix.
|
inherited |
Return the norm of the vector v with respect to the norm induced by this matrix, i.e. vTMv). This is useful, e.g. in the finite element context, where the LT-norm of a function equals the matrix norm with respect to the mass matrix of the vector representing the nodal values of the finite element function. Note that even though the function's name might suggest something different, for historic reasons not the norm but its square is returned, as defined above by the scalar product.
Obviously, the matrix needs to be square for this operation.
|
inherited |
Return the frobenius norm of the matrix, i.e. the square root of the sum of squares of all entries in the matrix.
|
inherited |
Compute the matrix scalar product \(\left(u,Mv\right)\).
|
inherited |
Compute the residual r=b-Ax. Write the residual into dst.
|
inherited |
Print the matrix to the given stream, using the format (line,col) value, i.e. one nonzero entry of the matrix per line. The optional flag outputs the sparsity pattern in a different style according to the underlying sparse matrix type.
|
inherited |
Iterator starting at the first entry.
|
inherited |
Iterator starting at the first entry of row r.
|
inherited |
Iterator starting at the first entry.
|
inherited |
Iterator starting at the first entry of row r.
|
inherited |
Final iterator.
|
inherited |
Final iterator of row r.
|
inherited |
Final iterator.
|
inherited |
Final iterator of row r.
|
inherited |
Return a reference to the underlying BlockIndices data of the rows.
|
inherited |
Return a reference to the underlying BlockIndices data of the columns.
|
staticinherited |
Exception
|
staticinherited |
Exception
|
protectedinherited |
This function collects the sizes of the sub-objects and stores them in internal arrays, in order to be able to relay global indices into the matrix to indices into the subobjects. You must call this function each time after you have changed the size of the sub-objects.
Derived classes should call this function whenever the size of the sub- objects has changed and the X_block_indices arrays need to be updated.
Note that this function is not public since not all derived classes need to export its interface. For example, for the usual deal.II SparseMatrix class, the sizes are implicitly determined whenever reinit() is called, and individual blocks cannot be resized. For that class, this function therefore does not have to be public. On the other hand, for the PETSc classes, there is no associated sparsity pattern object that determines the block sizes, and for these the function needs to be publicly available. These classes therefore export this function.
|
protectedinherited |
Matrix-vector multiplication: let \(dst = M*src\) with \(M\) being this matrix.
Due to problems with deriving template arguments between the block and non-block versions of the vmult/Tvmult functions, the actual functions are implemented in derived classes, with implementations forwarding the calls to the implementations provided here under a unique name for which template arguments can be derived by the compiler.
|
protectedinherited |
Matrix-vector multiplication. Just like the previous function, but only applicable if the matrix has only one block column.
Due to problems with deriving template arguments between the block and non-block versions of the vmult/Tvmult functions, the actual functions are implemented in derived classes, with implementations forwarding the calls to the implementations provided here under a unique name for which template arguments can be derived by the compiler.
|
protectedinherited |
Matrix-vector multiplication. Just like the previous function, but only applicable if the matrix has only one block row.
Due to problems with deriving template arguments between the block and non-block versions of the vmult/Tvmult functions, the actual functions are implemented in derived classes, with implementations forwarding the calls to the implementations provided here under a unique name for which template arguments can be derived by the compiler.
|
protectedinherited |
Matrix-vector multiplication. Just like the previous function, but only applicable if the matrix has only one block.
Due to problems with deriving template arguments between the block and non-block versions of the vmult/Tvmult functions, the actual functions are implemented in derived classes, with implementations forwarding the calls to the implementations provided here under a unique name for which template arguments can be derived by the compiler.
|
protectedinherited |
Matrix-vector multiplication: let \(dst = M^T*src\) with \(M\) being this matrix. This function does the same as vmult() but takes the transposed matrix.
Due to problems with deriving template arguments between the block and non-block versions of the vmult/Tvmult functions, the actual functions are implemented in derived classes, with implementations forwarding the calls to the implementations provided here under a unique name for which template arguments can be derived by the compiler.
|
protectedinherited |
Matrix-vector multiplication. Just like the previous function, but only applicable if the matrix has only one block row.
Due to problems with deriving template arguments between the block and non-block versions of the vmult/Tvmult functions, the actual functions are implemented in derived classes, with implementations forwarding the calls to the implementations provided here under a unique name for which template arguments can be derived by the compiler.
|
protectedinherited |
Matrix-vector multiplication. Just like the previous function, but only applicable if the matrix has only one block column.
Due to problems with deriving template arguments between the block and non-block versions of the vmult/Tvmult functions, the actual functions are implemented in derived classes, with implementations forwarding the calls to the implementations provided here under a unique name for which template arguments can be derived by the compiler.
|
protectedinherited |
Matrix-vector multiplication. Just like the previous function, but only applicable if the matrix has only one block.
Due to problems with deriving template arguments between the block and non-block versions of the vmult/Tvmult functions, the actual functions are implemented in derived classes, with implementations forwarding the calls to the implementations provided here under a unique name for which template arguments can be derived by the compiler.
|
protectedinherited |
Some matrix types, in particular PETSc, need to synchronize set and add operations. This has to be done for all matrices in the BlockMatrix. This routine prepares adding of elements by notifying all blocks. Called by all internal routines before adding elements.
|
protectedinherited |
Notifies all blocks to let them prepare for setting elements, see prepare_add_operation().
|
protectedinherited |
Index arrays for rows and columns.
Definition at line 846 of file block_matrix_base.h.
|
protectedinherited |
Definition at line 847 of file block_matrix_base.h.
|
protectedinherited |
Array of sub-matrices.
Definition at line 852 of file block_matrix_base.h.
|
privateinherited |
A set of scratch arrays that can be used by the add() and set() functions that take pointers to data to pre-sort indices before use. Access from multiple threads is synchronized via the mutex variable that is part of the structure.
Definition at line 1064 of file block_matrix_base.h.
1.9.5