Reference documentation for deal.II version 9.2.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
MGMatrixBlockVector< MatrixType > Class Template Reference

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

Inheritance diagram for MGMatrixBlockVector< MatrixType >:
[legend]

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_typeblock (size_type i) const
 
value_typeblock (size_type i)
 
const value_typeblock_in (size_type i) const
 
value_typeblock_in (size_type i)
 
const value_typeblock_out (size_type i) const
 
value_typeblock_out (size_type i)
 
const value_typeblock_up (size_type i) const
 
value_typeblock_up (size_type i)
 
const value_typeblock_down (size_type i) const
 
value_typeblock_down (size_type i)
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (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)
 

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

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (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.

Author
Baerbel Janssen, Guido Kanschat, 2010

Definition at line 444 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 450 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 455 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 914 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 923 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 931 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 1035 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 1057 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 1083 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 1123 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 955 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 963 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 971 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 979 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 987 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 995 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 1003 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 1011 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 1019 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 1027 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 1109 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 597 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 600 of file matrix_block.h.

◆ matrices

template<typename MatrixType>
AnyData MGMatrixBlockVector< MatrixType >::matrices
private

The level matrices.

Definition at line 603 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 605 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 607 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 609 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 611 of file matrix_block.h.


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