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

Inheritance diagram for MGMatrixBlockVector< MatrixType >:

Public Types
using	size_type = types::global_dof_index

using	value_type = MGLevelObject<MatrixBlock<MatrixType>>

Public Member Functions
	MGMatrixBlockVector (const bool edge_matrices=false, const bool edge_flux_matrices=false)

unsigned int	size () const

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

void	reinit_matrix (const MGLevelObject< BlockSparsityPattern > &sparsity)

void	reinit_edge (const MGLevelObject< BlockSparsityPattern > &sparsity)

void	reinit_edge_flux (const MGLevelObject< BlockSparsityPattern > &sparsity)

void	clear (bool really_clean=false)

const value_type &	block (size_type i) const

value_type &	block (size_type i)

const value_type &	block_in (size_type i) const

value_type &	block_in (size_type i)

const value_type &	block_out (size_type i) const

value_type &	block_out (size_type i)

const value_type &	block_up (size_type i) const

value_type &	block_up (size_type i)

const value_type &	block_down (size_type i) const

value_type &	block_down (size_type i)

std::size_t	memory_consumption () 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 &	ExcInUse (int arg1, std::string arg2, std::string arg3)

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

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

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
void	clear_object (AnyData &)
	Clear one of the matrix objects.

void	check_no_subscribers () const noexcept

Private Attributes
const bool	edge_matrices
	Flag for storing matrices_in and matrices_out.

const bool	edge_flux_matrices
	Flag for storing flux_matrices_up and flux_matrices_down.

AnyData	matrices
	The level matrices.

AnyData	matrices_in
	The matrix from the interior of a level to the refinement edge.

AnyData	matrices_out
	The matrix from the refinement edge to the interior of a level.

AnyData	flux_matrices_down
	The DG flux from a level to the lower level.

AnyData	flux_matrices_up
	The DG flux from the lower level to a level.

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 MGMatrixBlockVector< MatrixType >

A vector of MGLevelObject<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 440 of file matrix_block.h.

Member Typedef Documentation

◆ size_type

template<typename MatrixType >

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

Declare type for container size.

Definition at line 446 of file matrix_block.h.

◆ value_type

template<typename MatrixType >

using MGMatrixBlockVector< MatrixType >::value_type = MGLevelObject<MatrixBlock<MatrixType>>

The type of object stored.

Definition at line 451 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.

Constructor & Destructor Documentation

◆ MGMatrixBlockVector()

template<typename MatrixType >

MGMatrixBlockVector< MatrixType >::MGMatrixBlockVector	(	const bool	edge_matrices = false,
		const bool	edge_flux_matrices = false )

inline

Constructor, determining which matrices should be stored.

If edge_matrices is true, then objects for edge matrices for discretizations with degrees of freedom on faces are allocated.

If edge_flux_matrices is true, then objects for DG fluxes on the refinement edge are allocated.

Definition at line 910 of file matrix_block.h.

Member Function Documentation

◆ size()

template<typename MatrixType >

unsigned int MGMatrixBlockVector< MatrixType >::size ( ) const

inline

The number of blocks.

Definition at line 919 of file matrix_block.h.

◆ add()

template<typename MatrixType >

void MGMatrixBlockVector< 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. The third argument allows to give the matrix a name for later identification.

Definition at line 927 of file matrix_block.h.

◆ reinit_matrix()

template<typename MatrixType >

void MGMatrixBlockVector< MatrixType >::reinit_matrix ( const MGLevelObject< BlockSparsityPattern > & sparsity )

inline

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

This function reinitializes the level matrices.

Definition at line 1031 of file matrix_block.h.

◆ reinit_edge()

template<typename MatrixType >

void MGMatrixBlockVector< MatrixType >::reinit_edge ( const MGLevelObject< BlockSparsityPattern > & sparsity )

inline

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

This function reinitializes the matrices for degrees of freedom on the refinement edge.

Definition at line 1053 of file matrix_block.h.

◆ reinit_edge_flux()

template<typename MatrixType >

void MGMatrixBlockVector< MatrixType >::reinit_edge_flux ( const MGLevelObject< BlockSparsityPattern > & sparsity )

inline

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

This function reinitializes the flux matrices over the refinement edge.

Definition at line 1079 of file matrix_block.h.

◆ clear()

template<typename MatrixType >

void MGMatrixBlockVector< 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 1119 of file matrix_block.h.

◆ block() [1/2]

template<typename MatrixType >

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

inline

Access a constant reference to the matrix block at position i.

Definition at line 951 of file matrix_block.h.

◆ block() [2/2]

template<typename MatrixType >

MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block ( size_type i )

inline

Access a reference to the matrix block at position i.

Definition at line 959 of file matrix_block.h.

◆ block_in() [1/2]

template<typename MatrixType >

const MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block_in ( size_type i ) const

inline

Access a constant reference to the edge matrix block at position i.

Definition at line 967 of file matrix_block.h.

◆ block_in() [2/2]

template<typename MatrixType >

MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block_in ( size_type i )

inline

Access a reference to the edge matrix block at position i.

Definition at line 975 of file matrix_block.h.

◆ block_out() [1/2]

template<typename MatrixType >

const MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block_out ( size_type i ) const

inline

Access a constant reference to the edge matrix block at position i.

Definition at line 983 of file matrix_block.h.

◆ block_out() [2/2]

template<typename MatrixType >

MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block_out ( size_type i )

inline

Access a reference to the edge matrix block at position i.

Definition at line 991 of file matrix_block.h.

◆ block_up() [1/2]

template<typename MatrixType >

const MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block_up ( size_type i ) const

inline

Access a constant reference to the edge flux matrix block at position i.

Definition at line 999 of file matrix_block.h.

◆ block_up() [2/2]

template<typename MatrixType >

MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block_up ( size_type i )

inline

Access a reference to the edge flux matrix block at position i.

Definition at line 1007 of file matrix_block.h.

◆ block_down() [1/2]

template<typename MatrixType >

const MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block_down ( size_type i ) const

inline

Access a constant reference to the edge flux matrix block at position i.

Definition at line 1015 of file matrix_block.h.

◆ block_down() [2/2]

template<typename MatrixType >

MGLevelObject< MatrixBlock< MatrixType > > & MGMatrixBlockVector< MatrixType >::block_down ( size_type i )

inline

Access a reference to the edge flux matrix block at position i.

Definition at line 1023 of file matrix_block.h.

◆ memory_consumption()

template<typename MatrixType >

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

The memory used by this object.

◆ clear_object()

template<typename MatrixType >

void MGMatrixBlockVector< MatrixType >::clear_object ( AnyData & mo )

inlineprivate

Clear one of the matrix objects.

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

◆ edge_matrices

template<typename MatrixType >

const bool MGMatrixBlockVector< MatrixType >::edge_matrices

private

Flag for storing matrices_in and matrices_out.

Definition at line 593 of file matrix_block.h.

◆ edge_flux_matrices

template<typename MatrixType >

const bool MGMatrixBlockVector< MatrixType >::edge_flux_matrices

private

Flag for storing flux_matrices_up and flux_matrices_down.

Definition at line 596 of file matrix_block.h.

◆ matrices

template<typename MatrixType >

AnyData MGMatrixBlockVector< MatrixType >::matrices

private

The level matrices.

Definition at line 599 of file matrix_block.h.

◆ matrices_in

template<typename MatrixType >

AnyData MGMatrixBlockVector< MatrixType >::matrices_in

private

The matrix from the interior of a level to the refinement edge.

Definition at line 601 of file matrix_block.h.

◆ matrices_out

template<typename MatrixType >

AnyData MGMatrixBlockVector< MatrixType >::matrices_out

private

The matrix from the refinement edge to the interior of a level.

Definition at line 603 of file matrix_block.h.

◆ flux_matrices_down

template<typename MatrixType >

AnyData MGMatrixBlockVector< MatrixType >::flux_matrices_down

private

The DG flux from a level to the lower level.

Definition at line 605 of file matrix_block.h.

◆ flux_matrices_up

template<typename MatrixType >

AnyData MGMatrixBlockVector< MatrixType >::flux_matrices_up

private

The DG flux from the lower level to a level.

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

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ size_type

◆ value_type

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ MGMatrixBlockVector()

Member Function Documentation

◆ size()

◆ add()

◆ reinit_matrix()

◆ reinit_edge()

◆ reinit_edge_flux()

◆ clear()

◆ block() [1/2]

◆ block() [2/2]

◆ block_in() [1/2]

◆ block_in() [2/2]

◆ block_out() [1/2]

◆ block_out() [2/2]

◆ block_up() [1/2]

◆ block_up() [2/2]

◆ block_down() [1/2]

◆ block_down() [2/2]

◆ memory_consumption()

◆ clear_object()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ edge_matrices

◆ edge_flux_matrices

◆ matrices

◆ matrices_in

◆ matrices_out

◆ flux_matrices_down

◆ flux_matrices_up

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex