BlockSparsityPatternBase< SparsityPatternType > Class Template Reference

#include <deal.II/lac/block_sparsity_pattern.h>

Inheritance diagram for BlockSparsityPatternBase< SparsityPatternType >:

Public Types
using	size_type = types::global_dof_index

Public Member Functions
	BlockSparsityPatternBase ()
	BlockSparsityPatternBase (const size_type n_block_rows, const size_type n_block_columns)
	BlockSparsityPatternBase (const BlockSparsityPatternBase &bsp)
void	reinit (const size_type n_block_rows, const size_type n_block_columns)
BlockSparsityPatternBase &	operator= (const BlockSparsityPatternBase &)
void	collect_sizes ()
SparsityPatternType &	block (const size_type row, const size_type column)
const SparsityPatternType &	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)
template<typename ForwardIterator >
void	add_entries (const size_type row, ForwardIterator begin, ForwardIterator end, const bool indices_are_sorted=false)
virtual void	add_row_entries (const size_type &row, const ArrayView< const size_type > &columns, const bool indices_are_sorted=false) override
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
void	print_svg (std::ostream &out) const
std::size_t	memory_consumption () const
virtual void	add_entries (const ArrayView< const std::pair< size_type, size_type > > &entries)
size_type	n_rows () const
size_type	n_cols () const
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
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

Static Public Member Functions
static ::ExceptionBase &	ExcNeedsCollectSizes ()
static ::ExceptionBase &	ExcIncompatibleRowNumbers (int arg1, int arg2, int arg3, int arg4)
static ::ExceptionBase &	ExcIncompatibleColNumbers (int arg1, int arg2, int arg3, int arg4)
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Static Public Attributes
static const size_type	invalid_entry = SparsityPattern::invalid_entry

Protected Member Functions
virtual void	resize (const size_type rows, const size_type cols)

Protected Attributes
size_type	block_rows
size_type	block_columns
Table< 2, std::unique_ptr< SparsityPatternType > >	sub_objects
BlockIndices	row_indices
BlockIndices	column_indices
size_type	rows
size_type	cols

Private Types
using	map_value_type = decltype(counter_map)::value_type
using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
size_type	compute_n_rows () const
size_type	compute_n_cols () const
void	check_no_subscribers () const noexcept

Private Attributes
std::vector< size_type >	counter_within_block
std::vector< std::vector< size_type > >	block_column_indices
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

Static Private Attributes
static std::mutex	mutex

Friends
template<typename number >
class	BlockSparseMatrix

Detailed Description

template<typename SparsityPatternType>
class BlockSparsityPatternBase< SparsityPatternType >

This is the base class for block versions of the sparsity pattern and dynamic sparsity pattern classes. It has not much functionality, but only administrates an array of sparsity pattern objects and delegates work to them. It has mostly the same interface as has the SparsityPattern, and DynamicSparsityPattern, and simply transforms calls to its member functions to calls to the respective member functions of the member sparsity patterns.

The largest difference between the SparsityPattern and DynamicSparsityPattern classes and this class is that mostly, the matrices have different properties and you will want to work on the blocks making up the matrix rather than the whole matrix. You can access the different blocks using the block(row,col) function.

Attention: this object is not automatically notified if the size of one of its subobjects' size is changed. After you initialize the sizes of the subobjects, you will therefore have to call the collect_sizes() function of this class! Note that, of course, all sub-matrices in a (block-)row have to have the same number of rows, and that all sub-matrices in a (block-)column have to have the same number of columns.

You will in general not want to use this class, but one of the derived classes.

Todo

Handle optimization of diagonal elements of the underlying SparsityPattern correctly.

See also

Block (linear algebra)

Definition at line 79 of file block_sparsity_pattern.h.

Member Typedef Documentation

size_type

template<typename SparsityPatternType >

using BlockSparsityPatternBase< SparsityPatternType >::size_type = types::global_dof_index

Declare type for container size.

Definition at line 85 of file block_sparsity_pattern.h.

map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 229 of file subscriptor.h.

map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 234 of file subscriptor.h.

Constructor & Destructor Documentation

BlockSparsityPatternBase() [1/3]

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::BlockSparsityPatternBase

(

)

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.

Definition at line 24 of file block_sparsity_pattern.cc.

BlockSparsityPatternBase() [2/3]

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::BlockSparsityPatternBase	(	const size_type	n_block_rows,
		const size_type	n_block_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.

Definition at line 32 of file block_sparsity_pattern.cc.

BlockSparsityPatternBase() [3/3]

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::BlockSparsityPatternBase

(

const BlockSparsityPatternBase< SparsityPatternType > &

bsp

)

Copy constructor. This constructor is only allowed to be called if the sparsity pattern to be copied is empty, i.e. there are no block allocated at present. This is for the same reason as for the SparsityPattern, see there for the details.

Definition at line 43 of file block_sparsity_pattern.cc.

Member Function Documentation

reinit()

template<typename SparsityPatternType >

void BlockSparsityPatternBase< SparsityPatternType >::reinit	(	const size_type	n_block_rows,
		const size_type	n_block_columns )

Resize the matrix, by setting the number of block rows and columns. This deletes all blocks and replaces them with uninitialized ones, i.e. ones for which also the sizes are not yet set. You have to do that by calling the reinit() functions of the blocks themselves. Do not forget to call collect_sizes() after that on this object.

The reason that you have to set sizes of the blocks yourself is that the sizes may be varying, the maximum number of elements per row may be varying, etc. It is simpler not to reproduce the interface of the SparsityPattern class here but rather let the user call whatever function they desire.

Definition at line 59 of file block_sparsity_pattern.cc.

operator=()

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType > & BlockSparsityPatternBase< SparsityPatternType >::operator=

(

const BlockSparsityPatternBase< SparsityPatternType > &

bsp

)

Copy operator. For this the same holds as for the copy constructor: it is declared, defined and fine to be called, but the latter only for empty objects.

Definition at line 77 of file block_sparsity_pattern.cc.

collect_sizes()

template<typename SparsityPatternType >

void BlockSparsityPatternBase< SparsityPatternType >::collect_sizes

(

)

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.

Definition at line 124 of file block_sparsity_pattern.cc.

block() [1/2]

template<typename SparsityPatternType >

SparsityPatternType & BlockSparsityPatternBase< SparsityPatternType >::block ( const size_type row, const size_type column )

inline

Access the block with the given coordinates.

Definition at line 780 of file block_sparsity_pattern.h.

block() [2/2]

template<typename SparsityPatternType >

const SparsityPatternType & BlockSparsityPatternBase< SparsityPatternType >::block ( const size_type row, const size_type column ) const

inline

Access the block with the given coordinates. Version for constant objects.

Definition at line 792 of file block_sparsity_pattern.h.

get_row_indices()

template<typename SparsityPatternType >

const BlockIndices & BlockSparsityPatternBase< SparsityPatternType >::get_row_indices ( ) const

inline

Grant access to the object describing the distribution of row indices to the individual blocks.

Definition at line 805 of file block_sparsity_pattern.h.

get_column_indices()

template<typename SparsityPatternType >

const BlockIndices & BlockSparsityPatternBase< SparsityPatternType >::get_column_indices ( ) const

inline

Grant access to the object describing the distribution of column indices to the individual blocks.

Definition at line 814 of file block_sparsity_pattern.h.

compress()

template<typename SparsityPatternType >

void BlockSparsityPatternBase< SparsityPatternType >::compress

(

)

This function compresses the sparsity structures that this object represents. It simply calls compress for all sub-objects.

Definition at line 169 of file block_sparsity_pattern.cc.

n_block_rows()

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::size_type BlockSparsityPatternBase< SparsityPatternType >::n_block_rows ( ) const

inline

Return the number of blocks in a column.

Definition at line 1043 of file block_sparsity_pattern.h.

n_block_cols()

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::size_type BlockSparsityPatternBase< SparsityPatternType >::n_block_cols ( ) const

inline

Return the number of blocks in a row.

Definition at line 1034 of file block_sparsity_pattern.h.

empty()

template<typename SparsityPatternType >

bool BlockSparsityPatternBase< SparsityPatternType >::empty

(

)

const

Return whether the object is empty. It is empty if no memory is allocated, which is the same as that both dimensions are zero. This function is just the concatenation of the respective call to all sub-matrices.

Definition at line 180 of file block_sparsity_pattern.cc.

max_entries_per_row()

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::size_type BlockSparsityPatternBase< SparsityPatternType >::max_entries_per_row

(

)

const

Return the maximum number of entries per row. It returns the maximal number of entries per row accumulated over all blocks in a row, and the maximum over all rows.

Definition at line 193 of file block_sparsity_pattern.cc.

add()

template<typename SparsityPatternType >

void BlockSparsityPatternBase< SparsityPatternType >::add ( const size_type i, const size_type j )

inline

Add a nonzero entry to the matrix. This function may only be called for non-compressed sparsity patterns.

If the entry already exists, nothing bad happens.

This function simply finds out to which block (i,j) belongs and then relays to that block.

Definition at line 823 of file block_sparsity_pattern.h.

add_entries() [1/2]

template<typename SparsityPatternType >

template<typename ForwardIterator >

void BlockSparsityPatternBase< SparsityPatternType >::add_entries	(	const size_type	row,
		ForwardIterator	begin,
		ForwardIterator	end,
		const bool	indices_are_sorted = false )

Add several nonzero entries to the specified matrix row. This function may only be called for non-compressed sparsity patterns.

If some of the entries already exist, nothing bad happens.

This function simply finds out to which blocks (row,col) for col in the iterator range belong and then relays to those blocks.

Definition at line 842 of file block_sparsity_pattern.h.

add_row_entries()

template<typename SparsityPatternType >

void BlockSparsityPatternBase< SparsityPatternType >::add_row_entries ( const size_type & row, const ArrayView< const size_type > & columns, const bool indices_are_sorted = false )

overridevirtual

Add several nonzero entries to the specified matrix row. This function may only be called for non-compressed sparsity patterns and works the same way as the overload which takes iterators.

Implements SparsityPatternBase.

Definition at line 986 of file block_sparsity_pattern.h.

exists()

template<typename SparsityPatternType >

bool BlockSparsityPatternBase< SparsityPatternType >::exists ( const size_type i, const size_type j ) const

inline

Check if a value at a certain position may be non-zero.

Definition at line 998 of file block_sparsity_pattern.h.

row_length()

template<typename SparsityPatternType >

unsigned int BlockSparsityPatternBase< SparsityPatternType >::row_length ( const size_type row ) const

inline

Number of entries in a specific row, added up over all the blocks that form this row.

Definition at line 1016 of file block_sparsity_pattern.h.

n_nonzero_elements()

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::size_type BlockSparsityPatternBase< SparsityPatternType >::n_nonzero_elements

(

)

const

Return the number of nonzero elements of this matrix. Actually, it returns the number of entries in the sparsity pattern; if any of the entries should happen to be zero, it is counted anyway.

This function may only be called if the matrix struct is compressed. It does not make too much sense otherwise anyway.

In the present context, it is the sum of the values as returned by the sub-objects.

Definition at line 212 of file block_sparsity_pattern.cc.

print()

template<typename SparsityPatternType >

void BlockSparsityPatternBase< SparsityPatternType >::print

(

std::ostream &

out

)

const

Print the sparsity of the matrix. The output consists of one line per row of the format [i,j1,j2,j3,...]. i is the row number and jn are the allocated columns in this row.

Definition at line 225 of file block_sparsity_pattern.cc.

print_gnuplot()

template<typename SparsityPatternType >

void BlockSparsityPatternBase< SparsityPatternType >::print_gnuplot

(

std::ostream &

out

)

const

Print the sparsity of the matrix in a format that gnuplot understands and which can be used to plot the sparsity pattern in a graphical way. This is the same functionality implemented for usual sparsity patterns, see SparsityPattern::print_gnuplot().

Definition at line 282 of file block_sparsity_pattern.cc.

print_svg()

template<typename SparsityPatternType >

void BlockSparsityPatternBase< SparsityPatternType >::print_svg

(

std::ostream &

out

)

const

Print the sparsity of the matrix in svg format. This is the same functionality implemented for usual sparsity patterns, see SparsityPattern::print_svg().

Definition at line 309 of file block_sparsity_pattern.cc.

memory_consumption()

template<typename SparsityPatternType >

std::size_t BlockSparsityPatternBase< SparsityPatternType >::memory_consumption

(

)

const

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 350 of file block_sparsity_pattern.cc.

compute_n_rows()

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::size_type BlockSparsityPatternBase< SparsityPatternType >::compute_n_rows ( ) const

private

Internal utility function for computing the number of rows.

Definition at line 96 of file block_sparsity_pattern.cc.

compute_n_cols()

template<typename SparsityPatternType >

BlockSparsityPatternBase< SparsityPatternType >::size_type BlockSparsityPatternBase< SparsityPatternType >::compute_n_cols ( ) const

private

Internal utility function for computing the number of columns.

Definition at line 110 of file block_sparsity_pattern.cc.

add_entries() [2/2]

template<typename SparsityPatternType >

void SparsityPatternBase::add_entries ( const ArrayView< const std::pair< size_type, size_type > > & entries )

virtual

General function for adding new entries from an unsorted list of pairs.

This function is useful when multiple entries need to be added which do not correspond to a particular row, e.g., when assembling a flux sparsity pattern.

Reimplemented from SparsityPatternBase.

Definition at line 109 of file sparsity_pattern_base.cc.

n_rows()

template<typename SparsityPatternType >

size_type SparsityPatternBase::n_rows

(

)

const

Return number of rows of this matrix, which equals the dimension of the image space. It is the sum of rows of the (block-)rows of sub-matrices.

n_cols()

template<typename SparsityPatternType >

size_type SparsityPatternBase::n_cols

(

)

const

Return number of columns of this matrix, which equals the dimension of the range space. It is the sum of columns of the (block-)columns of sub-matrices.

resize()

virtual void SparsityPatternBase::resize ( const size_type rows, const size_type cols )

protectedvirtualinherited

Internal function for updating the stored size of the sparsity pattern.

subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const

inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 135 of file subscriptor.cc.

unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const

inherited

Unsubscribes a user from the object.

Note

The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 155 of file subscriptor.cc.

n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const

inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

list_subscribers() [1/2]

template<typename StreamType >

void Subscriptor::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 203 of file subscriptor.cc.

serialize()

template<class Archive >

void Subscriptor::serialize ( Archive & ar, const unsigned int version )

inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 309 of file subscriptor.h.

check_no_subscribers()

void Subscriptor::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note

Since this function is just a consistency check it does nothing in release mode.

If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 52 of file subscriptor.cc.

Friends And Related Symbol Documentation

BlockSparseMatrix

template<typename SparsityPatternType >

template<typename number >

friend class BlockSparseMatrix

friend

Typedef describing sparse matrices that consist of multiple blocks.

Typedef for the type used to describe sparse matrices that consist of multiple blocks.

Definition at line 422 of file block_sparsity_pattern.h.

Member Data Documentation

invalid_entry

template<typename SparsityPatternType >

const size_type BlockSparsityPatternBase< SparsityPatternType >::invalid_entry = SparsityPattern::invalid_entry

static

Define a value which is used to indicate that a certain value in the colnums array is unused, i.e. does not represent a certain column number index.

This value is only an alias to the respective value of the SparsityPattern class.

Definition at line 95 of file block_sparsity_pattern.h.

block_rows

template<typename SparsityPatternType >

size_type BlockSparsityPatternBase< SparsityPatternType >::block_rows

protected

Number of block rows.

Definition at line 370 of file block_sparsity_pattern.h.

block_columns

template<typename SparsityPatternType >

size_type BlockSparsityPatternBase< SparsityPatternType >::block_columns

protected

Number of block columns.

Definition at line 375 of file block_sparsity_pattern.h.

sub_objects

template<typename SparsityPatternType >

Table<2, std::unique_ptr<SparsityPatternType> > BlockSparsityPatternBase< SparsityPatternType >::sub_objects

protected

Array of sparsity patterns.

Definition at line 380 of file block_sparsity_pattern.h.

row_indices

template<typename SparsityPatternType >

BlockIndices BlockSparsityPatternBase< SparsityPatternType >::row_indices

protected

Object storing and managing the transformation of row indices to indices of the sub-objects.

Definition at line 386 of file block_sparsity_pattern.h.

column_indices

template<typename SparsityPatternType >

BlockIndices BlockSparsityPatternBase< SparsityPatternType >::column_indices

protected

Object storing and managing the transformation of column indices to indices of the sub-objects.

Definition at line 392 of file block_sparsity_pattern.h.

counter_within_block

template<typename SparsityPatternType >

std::vector<size_type> BlockSparsityPatternBase< SparsityPatternType >::counter_within_block

private

Temporary vector for counting the elements written into the individual blocks when doing a collective add or set.

Definition at line 411 of file block_sparsity_pattern.h.

block_column_indices

template<typename SparsityPatternType >

std::vector<std::vector<size_type> > BlockSparsityPatternBase< SparsityPatternType >::block_column_indices

private

Temporary vector for column indices on each block when writing local to global data on each sparse matrix.

Definition at line 417 of file block_sparsity_pattern.h.

rows

size_type SparsityPatternBase::rows

protectedinherited

Number of rows that this sparsity pattern shall represent.

Definition at line 121 of file sparsity_pattern_base.h.

cols

size_type SparsityPatternBase::cols

protectedinherited

Number of columns that this sparsity pattern shall represent.

Definition at line 126 of file sparsity_pattern_base.h.

counter

std::atomic<unsigned int> Subscriptor::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 218 of file subscriptor.h.

counter_map

std::map<std::string, unsigned int> Subscriptor::counter_map

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 224 of file subscriptor.h.

validity_pointers

std::vector<std::atomic<bool> *> Subscriptor::validity_pointers

mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 240 of file subscriptor.h.

object_info

const std::type_info* Subscriptor::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 248 of file subscriptor.h.

mutex

std::mutex Subscriptor::mutex

staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 271 of file subscriptor.h.

---

The documentation for this class was generated from the following files:

• include/deal.II/lac/block_sparsity_pattern.h
• source/lac/block_sparsity_pattern.cc