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

Additional Inherited Members
Private Member Functions inherited from AnyData
	AnyData ()=default
	Default constructor for empty object.

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

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. 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 >
const type	read (const std::string &name) const
	Dedicated read only access by name. 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 *	try_read_ptr (const std::string &name) const

template<typename type >
const type *	try_read (const std::string &name) const
	Dedicated read only access by name without exceptions. 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.

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

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 unsigned int i) const
	Dedicated read only access to pointer object without exception.

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

const std::string &	name (const unsigned int i) const
	Name of object at index.

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.

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

Private Member Functions inherited from Subscriptor
	Subscriptor ()

	Subscriptor (const Subscriptor &)

	Subscriptor (Subscriptor &&) noexcept

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&) noexcept

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 Private Member Functions inherited from AnyData
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)

Static Private Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

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

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.

Author: Baerbel Janssen, Guido Kanschat, 2010

Definition at line 345 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 351 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 356 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 362 of file matrix_block.h.

Member Function Documentation

◆ add()

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 851 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 862 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 873 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 890 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 898 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 906 of file matrix_block.h.

◆ name()

template<typename MatrixType>

const std::string & AnyData::name

inline

import functions from private base class

Definition at line 311 of file any_data.h.

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

deal.II/lac/matrix_block.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename MatrixType> class MatrixBlockVector< MatrixType >

Member Typedef Documentation

◆ size_type

◆ value_type

◆ ptr_type

Member Function Documentation

◆ add()

◆ reinit()

◆ clear()

◆ memory_consumption()

◆ block() [1/2]

◆ block() [2/2]

◆ matrix()

◆ name()

template<typename MatrixType>
class MatrixBlockVector< MatrixType >