deal.II version GIT relicensing-2291-g668cd86249 2024-12-24 11:30:00+00:00
\(\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\}}\)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
MGMatrixBlockVector< MatrixType > Class Template Reference
Finite elements | Finite elements » Finite element access/FEValues classes » Handling vector valued problems

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

Inheritance diagram for MGMatrixBlockVector< MatrixType >:
Inheritance graph
[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_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)
 
EnableObserverPointer functionality

Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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 422 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 428 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 433 of file matrix_block.h.

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 238 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 243 of file enable_observer_pointer.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 892 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 901 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 909 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 1013 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 1035 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 1061 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 1101 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 933 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 941 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 949 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 957 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 965 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 973 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 981 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 989 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 997 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 1005 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 1087 of file matrix_block.h.

◆ subscribe()

void EnableObserverPointer::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 131 of file enable_observer_pointer.cc.

◆ unsubscribe()

void EnableObserverPointer::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 151 of file enable_observer_pointer.cc.

◆ n_subscriptions()

unsigned int EnableObserverPointer::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 322 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >
void EnableObserverPointer::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 339 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >
void EnableObserverPointer::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 331 of file enable_observer_pointer.h.

◆ check_no_subscribers()

void EnableObserverPointer::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 53 of file enable_observer_pointer.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 575 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 578 of file matrix_block.h.

◆ matrices

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

The level matrices.

Definition at line 581 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 583 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 585 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 587 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 589 of file matrix_block.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::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 227 of file enable_observer_pointer.h.

◆ counter_map

std::map<std::string, unsigned int> EnableObserverPointer::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 233 of file enable_observer_pointer.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.

Definition at line 249 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::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 257 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::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 280 of file enable_observer_pointer.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8