#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

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

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

const bool	edge_flux_matrices
	Flag for storing flux_matrices_up and flux_matrices_down. More...

AnyData	matrices
	The level matrices. More...

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

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

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

AnyData	flux_matrices_up
	The DG flux from the lower level to a level. 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

using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

static std::mutex	mutex

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 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 441 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 447 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 452 of file matrix_block.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 911 of file matrix_block.h.

Member Function Documentation

◆ size()

template<typename MatrixType >

unsigned int MGMatrixBlockVector< MatrixType >::size

inline

The number of blocks.

Definition at line 920 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 928 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 1032 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 1054 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 1080 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 1120 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 952 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 960 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 968 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 976 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 984 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 992 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 1000 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 1008 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 1016 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 1024 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 1106 of file matrix_block.h.

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 594 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 597 of file matrix_block.h.

◆ matrices

template<typename MatrixType >

AnyData MGMatrixBlockVector< MatrixType >::matrices

private

The level matrices.

Definition at line 600 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 602 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 604 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 606 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 608 of file matrix_block.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

Private Attributes

Subscriptor functionality

Detailed Description

Member Typedef Documentation

◆ size_type

◆ value_type

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

Member Data Documentation

◆ edge_matrices

◆ edge_flux_matrices

◆ matrices

◆ matrices_in

◆ matrices_out

◆ flux_matrices_down

◆ flux_matrices_up