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

Inheritance diagram for MatrixBlockVector< MatrixType >:

[legend]

Public Types
using	size_type = types::global_dof_index

using	value_type = MatrixBlock<MatrixType>

using	ptr_type = std::shared_ptr<value_type>

Public Member Functions
void	add (size_type row, size_type column, const std::string &name)

void	reinit (const BlockSparsityPattern &sparsity)

void	clear (bool really_clean=false)

std::size_t	memory_consumption () const

const value_type &	block (size_type i) const

value_type &	block (size_type i)

MatrixType &	matrix (size_type i)

const std::string &	name (const unsigned int i) const

unsigned int	size () const
	Number of stored data objects.

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

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
template<typename type >
void	add (type entry, const std::string &name)
	Add a new data object.

void	merge (const AnyData &other)
	Merge the data of another AnyData to the end of this object.

template<typename type >
type	entry (const std::string &name)
	Access to stored data object by name.

template<typename type >
type	entry (const std::string &name) const
	Read-only access to stored data object by name.

template<typename type >
type	entry (const unsigned int i)

template<typename type >
type	entry (const unsigned int i) const
	Read-only access to stored data object by index.

template<typename type >
type	read (const std::string &name) const
	Dedicated read only access by name.

template<typename type >
type	read (const unsigned int i) const
	Dedicated read only access.

template<typename type >
const type *	read_ptr (const std::string &name) const
	Dedicated read only access by name for pointer data.

template<typename type >
const type *	read_ptr (const unsigned int i) const
	Dedicated read only access to pointer object.

template<typename type >
const type *	try_read_ptr (const std::string &name) const

template<typename type >
const type *	try_read_ptr (const unsigned int i) const
	Dedicated read only access to pointer object without exception.

template<typename type >
const type *	try_read (const std::string &name) const
	Dedicated read only access by name without exceptions.

template<typename type >
const type *	try_read (const unsigned int i) const
	Dedicated read only access without exception.

unsigned int	find (const std::string &name) const
	Find index of a named object.

unsigned int	try_find (const std::string &name) const
	Try to find index of a named object.

template<typename type >
bool	is_type (const unsigned int i) const
	Find out if object is of a certain type.

template<typename StreamType >
void	list (StreamType &os) const
	List the contents to a stream.

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

void	check_no_subscribers () const noexcept

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 Private Member Functions
static ::ExceptionBase &	ExcNameNotFound (std::string arg1)
	An entry with this name does not exist in the AnyData object.

static ::ExceptionBase &	ExcTypeMismatch (std::string arg1, std::string arg2)
	The requested type and the stored type are different.

static ::ExceptionBase &	ExcNameMismatch (int arg1, std::string arg2)

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Private Attributes
std::vector< std::any >	data
	The stored data.

std::vector< std::string >	names
	The names of the stored data.

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

Detailed Description

template<typename MatrixType>
class MatrixBlockVector< MatrixType >

A vector of MatrixBlock, which is implemented using shared pointers, in order to allow for copying and rearranging. Each matrix block can be identified by name.

Definition at line 351 of file matrix_block.h.

Member Typedef Documentation

◆ size_type

template<typename MatrixType >

using MatrixBlockVector< MatrixType >::size_type = types::global_dof_index

Declare type for container size.

Definition at line 357 of file matrix_block.h.

◆ value_type

template<typename MatrixType >

using MatrixBlockVector< MatrixType >::value_type = MatrixBlock<MatrixType>

The type of object stored.

Definition at line 362 of file matrix_block.h.

◆ ptr_type

template<typename MatrixType >

using MatrixBlockVector< MatrixType >::ptr_type = std::shared_ptr<value_type>

The pointer type used for storing the objects. We use a shard pointer, such that they get deleted automatically when not used anymore.

Definition at line 368 of file matrix_block.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.

Member Function Documentation

◆ add() [1/2]

template<typename MatrixType >

void MatrixBlockVector< MatrixType >::add	(	size_type	row,
		size_type	column,
		const std::string &	name )

inline

Add a new matrix block at the position (row,column) in the block system.

Definition at line 845 of file matrix_block.h.

◆ reinit()

template<typename MatrixType >

void MatrixBlockVector< MatrixType >::reinit ( const BlockSparsityPattern & sparsity )

inline

For matrices using a SparsityPattern, this function reinitializes each matrix in the vector with the correct pattern from the block system.

Definition at line 856 of file matrix_block.h.

◆ clear()

template<typename MatrixType >

void MatrixBlockVector< MatrixType >::clear ( bool really_clean = false )

inline

Clear the object.

Since often only clearing of the individual matrices is desired, but not removing the blocks themselves, there is an optional argument. If the argument is missing or false, all matrices will be empty, but the size of this object and the block positions will not change. If really_clean is true, then the object will contain no blocks at the end.

Definition at line 867 of file matrix_block.h.

◆ memory_consumption()

template<typename MatrixType >

std::size_t MatrixBlockVector< MatrixType >::memory_consumption ( ) const

The memory used by this object.

◆ block() [1/2]

template<typename MatrixType >

const MatrixBlock< MatrixType > & MatrixBlockVector< MatrixType >::block ( size_type i ) const

inline

Access a constant reference to the block at position i.

Definition at line 884 of file matrix_block.h.

◆ block() [2/2]

template<typename MatrixType >

MatrixBlock< MatrixType > & MatrixBlockVector< MatrixType >::block ( size_type i )

inline

Access a reference to the block at position i.

Definition at line 892 of file matrix_block.h.

◆ matrix()

template<typename MatrixType >

MatrixType & MatrixBlockVector< MatrixType >::matrix ( size_type i )

inline

Access the matrix at position i for read and write access.

Definition at line 900 of file matrix_block.h.

◆ name()

template<typename MatrixType >

const std::string & AnyData::name ( const unsigned int i ) const

inline

import functions from private base class

Definition at line 161 of file any_data.h.

◆ size()

template<typename MatrixType >

unsigned int AnyData::size ( ) const

inline

Number of stored data objects.

Definition at line 43 of file any_data.h.

◆ add() [2/2]

template<typename type >

void AnyData::add	(	type	entry,
		const std::string &	name )

inlineinherited

Add a new data object.

Definition at line 430 of file any_data.h.

◆ merge()

void AnyData::merge ( const AnyData & other )

inlineinherited

Merge the data of another AnyData to the end of this object.

Definition at line 439 of file any_data.h.

◆ entry() [1/4]

template<typename type >

type AnyData::entry ( const std::string & name )

inlineinherited

Access to stored data object by name.

Find the object with given name, try to convert it to type and return it. This function throws an exception if either the name does not exist or if the conversion fails. If such an exception is not desired, use try_read() instead.

Definition at line 349 of file any_data.h.

◆ entry() [2/4]

template<typename type >

type AnyData::entry ( const std::string & name ) const

inlineinherited

Read-only access to stored data object by name.

Find the object with given name, try to convert it to type and return it. This function throws an exception if either the name does not exist or if the conversion fails. If such an exception is not desired, use try_read() instead.

Definition at line 360 of file any_data.h.

◆ entry() [3/4]

template<typename type >

type AnyData::entry ( const unsigned int i )

inlineinherited

Access to stored data object by index.

Definition at line 230 of file any_data.h.

◆ entry() [4/4]

template<typename type >

type AnyData::entry ( const unsigned int i ) const

inlineinherited

Read-only access to stored data object by index.

Definition at line 242 of file any_data.h.

◆ read() [1/2]

template<typename type >

type AnyData::read ( const std::string & name ) const

inlineinherited

Dedicated read only access by name.

For a constant object, this function equals entry(). For a non-const object, it forces read only access to the data. In particular, it throws an exception if the object is not found or cannot be converted to type. If such an exception is not desired, use try_read() instead.

Warning: Do not use this function for stored objects which are pointers. Use read_ptr() instead!

Definition at line 372 of file any_data.h.

◆ read() [2/2]

template<typename type >

type AnyData::read ( const unsigned int i ) const

inlineinherited

Dedicated read only access.

Definition at line 256 of file any_data.h.

◆ read_ptr() [1/2]

template<typename type >

const type * AnyData::read_ptr ( const std::string & name ) const

inlineinherited

Dedicated read only access by name for pointer data.

If the stored data object is a pointer to a constant object, the logic of access becomes fairly complicated. Namely, the standard read function may fail, depending on whether it was a const pointer or a regular pointer. This function fixes the logic and ascertains that the object does not become mutable by accident.

Definition at line 383 of file any_data.h.

◆ read_ptr() [2/2]

template<typename type >

const type * AnyData::read_ptr ( const unsigned int i ) const

inlineinherited

Dedicated read only access to pointer object.

Definition at line 270 of file any_data.h.

◆ try_read_ptr() [1/2]

template<typename type >

const type * AnyData::try_read_ptr ( const std::string & name ) const

inlineinherited

Perform the same action as read_ptr(), but do not throw an exception if the pointer does not exist. Return a null pointer instead.

Definition at line 397 of file any_data.h.

◆ try_read_ptr() [2/2]

template<typename type >

const type * AnyData::try_read_ptr ( const unsigned int i ) const

inlineinherited

Dedicated read only access to pointer object without exception.

Definition at line 284 of file any_data.h.

◆ try_read() [1/2]

template<typename type >

const type * AnyData::try_read ( const std::string & name ) const

inlineinherited

Dedicated read only access by name without exceptions.

This function tries to find the name in the list and return a pointer to the associated object. If either the name is not found or the object cannot be converted to the return type, a null pointer is returned.

Definition at line 412 of file any_data.h.

◆ try_read() [2/2]

template<typename type >

const type * AnyData::try_read ( const unsigned int i ) const

inlineinherited

Dedicated read only access without exception.

Definition at line 298 of file any_data.h.

◆ find()

unsigned int AnyData::find ( const std::string & name ) const

inlineinherited

Find index of a named object.

Try to find the object and return its index in the list. Throw an exception if the object has not been found.

Definition at line 330 of file any_data.h.

◆ try_find()

unsigned int AnyData::try_find ( const std::string & name ) const

inlineinherited

Try to find index of a named object.

Try to find the object and return its index in the list. returns numbers::invalid_unsigned_int if the name was not found.

Definition at line 317 of file any_data.h.

◆ is_type()

template<typename type >

bool AnyData::is_type ( const unsigned int i ) const

inlineinherited

Find out if object is of a certain type.

Definition at line 341 of file any_data.h.

◆ list()

template<typename StreamType >

void AnyData::list ( StreamType & os ) const

inlineinherited

List the contents to a stream.

Definition at line 451 of file any_data.h.

◆ 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.

Member Data Documentation

◆ data

std::vector<std::any> AnyData::data

privateinherited

The stored data.

Definition at line 215 of file any_data.h.

◆ names

std::vector<std::string> AnyData::names

privateinherited

The names of the stored data.

Definition at line 217 of file any_data.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 file:

include/deal.II/lac/matrix_block.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ size_type

◆ value_type

◆ ptr_type

◆ map_value_type

◆ map_iterator

Member Function Documentation

◆ add() [1/2]

◆ reinit()

◆ clear()

◆ memory_consumption()

◆ block() [1/2]

◆ block() [2/2]

◆ matrix()

◆ name()

◆ size()

◆ add() [2/2]

◆ merge()

◆ entry() [1/4]

◆ entry() [2/4]

◆ entry() [3/4]

◆ entry() [4/4]

◆ read() [1/2]

◆ read() [2/2]

◆ read_ptr() [1/2]

◆ read_ptr() [2/2]

◆ try_read_ptr() [1/2]

◆ try_read_ptr() [2/2]

◆ try_read() [1/2]

◆ try_read() [2/2]

◆ find()

◆ try_find()

◆ is_type()

◆ list()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ data

◆ names

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex