![]() |
Reference documentation for deal.II version 8.1.0
|
#include <block_sparsity_pattern.h>
Public Member Functions | |
BlockCompressedSparsityPattern () | |
BlockCompressedSparsityPattern (const size_type n_rows, const size_type n_columns) | |
BlockCompressedSparsityPattern (const std::vector< size_type > &row_block_sizes, const std::vector< size_type > &col_block_sizes) | |
BlockCompressedSparsityPattern (const BlockIndices &row_indices, const BlockIndices &col_indices) | |
void | reinit (const std::vector< size_type > &row_block_sizes, const std::vector< size_type > &col_block_sizes) |
void | reinit (const BlockIndices &row_indices, const BlockIndices &col_indices) |
![]() | |
BlockSparsityPatternBase () | |
BlockSparsityPatternBase (const size_type n_block_rows, const size_type n_block_columns) | |
BlockSparsityPatternBase (const BlockSparsityPatternBase &bsp) | |
~BlockSparsityPatternBase () | |
void | reinit (const size_type n_block_rows, const size_type n_block_columns) |
BlockSparsityPatternBase & | operator= (const BlockSparsityPatternBase &) |
void | collect_sizes () |
CompressedSparsityPattern & | block (const size_type row, const size_type column) |
const CompressedSparsityPattern & | block (const size_type row, const size_type column) const |
const BlockIndices & | get_row_indices () const |
const BlockIndices & | get_column_indices () const |
void | compress () |
size_type | n_block_rows () const |
size_type | n_block_cols () const |
bool | empty () const |
size_type | max_entries_per_row () const |
void | add (const size_type i, const size_type j) |
void | add_entries (const size_type row, ForwardIterator begin, ForwardIterator end, const bool indices_are_sorted=false) |
size_type | n_rows () const |
size_type | n_cols () const |
bool | exists (const size_type i, const size_type j) const |
unsigned int | row_length (const size_type row) const |
size_type | n_nonzero_elements () const |
void | print (std::ostream &out) const |
void | print_gnuplot (std::ostream &out) const |
DeclException4 (ExcIncompatibleRowNumbers, int, int, int, int,<< "The blocks ["<< arg1<< ','<< arg2<< "] and ["<< arg3<< ','<< arg4<< "] have differing row numbers.") | |
DeclException4 (ExcIncompatibleColNumbers, int, int, int, int,<< "The blocks ["<< arg1<< ','<< arg2<< "] and ["<< arg3<< ','<< arg4<< "] have differing column numbers.") | |
DeclException0 (ExcInvalidConstructorCall) | |
![]() | |
Subscriptor () | |
Subscriptor (const Subscriptor &) | |
virtual | ~Subscriptor () |
Subscriptor & | operator= (const Subscriptor &) |
void | subscribe (const char *identifier=0) const |
void | unsubscribe (const char *identifier=0) const |
unsigned int | n_subscriptions () const |
void | list_subscribers () const |
DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.") | |
DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1) | |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Additional Inherited Members | |
![]() | |
typedef types::global_dof_index | size_type |
![]() | |
static const size_type | invalid_entry |
![]() | |
size_type | rows |
size_type | columns |
Table< 2, SmartPointer< CompressedSparsityPattern, BlockSparsityPatternBase< CompressedSparsityPattern > > > | sub_objects |
BlockIndices | row_indices |
BlockIndices | column_indices |
This class extends the base class to implement an array of compressed sparsity patterns that can be used to initialize objects of type BlockSparsityPattern. It does not add additional member functions, but rather acts as a typedef
to introduce the name of this class, without requiring the user to specify the templated name of the base class. For information on the interface of this class refer to the base class. The individual blocks are based on the CompressedSparsityPattern class.
This class is an example of the "dynamic" type of Sparsity patterns.
Note: There are several, exchangeable variations of this class, see Sparsity patterns, section 'Dynamic block sparsity patterns' for more information.
Note: This class used to be called CompressedBlockSparsityPattern. However, since it's a block wrapper around the CompressedSparsityPattern class, this is a misnomer and the class has been renamed.
Usage of this class is very similar to CompressedSparsityPattern, but since the use of block indices causes some additional complications, we give a short example.
After the the DoFHandler dof
and the ConstraintMatrix constraints
have been set up with a system element, we must count the degrees of freedom in each matrix block:
Now, we are ready to set up the BlockCompressedSparsityPattern.
It is filled as if it were a normal pattern
In the end, it is copied to a normal BlockSparsityPattern for later use.
Definition at line 661 of file block_sparsity_pattern.h.
BlockCompressedSparsityPattern::BlockCompressedSparsityPattern | ( | ) |
Initialize the matrix empty, that is with no memory allocated. This is useful if you want such objects as member variables in other classes. You can make the structure usable by calling the reinit() function.
BlockCompressedSparsityPattern::BlockCompressedSparsityPattern | ( | const size_type | n_rows, |
const size_type | n_columns | ||
) |
Initialize the matrix with the given number of block rows and columns. The blocks themselves are still empty, and you have to call collect_sizes() after you assign them sizes.
BlockCompressedSparsityPattern::BlockCompressedSparsityPattern | ( | const std::vector< size_type > & | row_block_sizes, |
const std::vector< size_type > & | col_block_sizes | ||
) |
Initialize the pattern with two BlockIndices for the block structures of matrix rows and columns. This function is equivalent to calling the previous constructor with the length of the two index vector and then entering the index values.
BlockCompressedSparsityPattern::BlockCompressedSparsityPattern | ( | const BlockIndices & | row_indices, |
const BlockIndices & | col_indices | ||
) |
Initialize the pattern with two BlockIndices for the block structures of matrix rows and columns.
void BlockCompressedSparsityPattern::reinit | ( | const std::vector< size_type > & | row_block_sizes, |
const std::vector< size_type > & | col_block_sizes | ||
) |
Resize the matrix to a tensor product of matrices with dimensions defined by the arguments.
The matrix will have as many block rows and columns as there are entries in the two arguments. The block at position (i,j) will have the dimensions row_block_sizes[i]
times col_block_sizes[j]
.
void BlockCompressedSparsityPattern::reinit | ( | const BlockIndices & | row_indices, |
const BlockIndices & | col_indices | ||
) |
Resize the matrix to a tensor product of matrices with dimensions defined by the arguments. The two BlockIndices objects must be initialized and the sparsity pattern will have the same block structure afterwards.