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

Inheritance diagram for MatrixBlockVector< MatrixType >:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Private Member Functions
static ::ExceptionBase &	ExcNameNotFound (std::string arg1)
	An entry with this name does not exist in the AnyData object. More...

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

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

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

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

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)

void	check_no_subscribers () const noexcept

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

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 352 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 358 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 363 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 369 of file matrix_block.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 846 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 857 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 868 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 885 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 893 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 901 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 163 of file any_data.h.

◆ size()

template<typename MatrixType >

unsigned int AnyData::size ( ) const

inline

Number of stored data objects.

Definition at line 45 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 432 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 441 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 351 of file any_data.h.

◆ entry() [2/4]

template<typename type >

const 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 362 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 232 of file any_data.h.

◆ entry() [4/4]

template<typename type >

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

inlineinherited

Read-only access to stored data object by index.

Definition at line 244 of file any_data.h.

◆ read() [1/2]

template<typename type >

const 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 374 of file any_data.h.

◆ read() [2/2]

template<typename type >

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

inlineinherited

Dedicated read only access.

Definition at line 258 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 385 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 272 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 399 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 286 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 414 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 300 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 332 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 319 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 343 of file any_data.h.

◆ list()

template<class StreamType >

void AnyData::list ( StreamType & os ) const

inlineinherited

List the contents to a stream.

Definition at line 453 of file any_data.h.

Member Data Documentation

◆ data

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

privateinherited

The stored data.

Definition at line 217 of file any_data.h.

◆ names

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

privateinherited

The names of the stored data.

Definition at line 219 of file any_data.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 Member Functions

Static Private Member Functions

Private Attributes

Subscriptor functionality

Detailed Description

Member Typedef Documentation

◆ size_type

◆ value_type

◆ ptr_type

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()

Member Data Documentation

◆ data

◆ names