![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/multigrid/mg_matrix.h>
Public Member Functions | |
MGMatrixSelect (const unsigned int row=0, const unsigned int col=0, MGLevelObject< MatrixType > *matrix=0) | |
void | set_matrix (MGLevelObject< MatrixType > *M) |
void | select_block (const unsigned int row, const unsigned int col) |
virtual void | vmult (const unsigned int level, Vector< number > &dst, const Vector< number > &src) const |
virtual void | vmult_add (const unsigned int level, Vector< number > &dst, const Vector< number > &src) const |
virtual void | Tvmult (const unsigned int level, Vector< number > &dst, const Vector< number > &src) const |
virtual void | Tvmult_add (const unsigned int level, Vector< number > &dst, const Vector< number > &src) const |
virtual unsigned int | get_minlevel () const=0 |
virtual unsigned int | get_maxlevel () const=0 |
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 | check_no_subscribers () const noexcept |
Private Attributes | |
SmartPointer< MGLevelObject< MatrixType >, MGMatrixSelect< MatrixType, number > > | matrix |
unsigned int | row |
unsigned int | col |
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 |
Multilevel matrix selecting from block matrices. This class implements the interface defined by MGMatrixBase. The template parameter MatrixType
should be a block matrix class like BlockSparseMatrix or BlockSparseMatrixEZ
. Then, this class stores a pointer to a MGLevelObject of this matrix class. In each vmult
, the block selected on initialization will be multiplied with the vector provided.
Definition at line 123 of file mg_matrix.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
MGMatrixSelect< MatrixType, number >::MGMatrixSelect | ( | const unsigned int | row = 0, |
const unsigned int | col = 0, | ||
MGLevelObject< MatrixType > * | matrix = 0 ) |
Constructor. row
and col
are the coordinate of the selected block. The other argument is handed over to the SmartPointer
constructor.
Definition at line 322 of file mg_matrix.h.
void MGMatrixSelect< MatrixType, number >::set_matrix | ( | MGLevelObject< MatrixType > * | M | ) |
Set the matrix object to be used. The matrix object must exist longer as the MGMatrixSelect
object, since only a pointer is stored.
Definition at line 334 of file mg_matrix.h.
void MGMatrixSelect< MatrixType, number >::select_block | ( | const unsigned int | row, |
const unsigned int | col ) |
Select the block for multiplication.
Definition at line 343 of file mg_matrix.h.
|
virtual |
Matrix-vector-multiplication on a certain level.
Implements MGMatrixBase< Vector< number > >.
Definition at line 354 of file mg_matrix.h.
|
virtual |
Adding matrix-vector-multiplication on a certain level.
Implements MGMatrixBase< Vector< number > >.
Definition at line 368 of file mg_matrix.h.
|
virtual |
Transpose matrix-vector-multiplication on a certain level.
Implements MGMatrixBase< Vector< number > >.
Definition at line 382 of file mg_matrix.h.
|
virtual |
Adding transpose matrix-vector-multiplication on a certain level.
Implements MGMatrixBase< Vector< number > >.
Definition at line 396 of file mg_matrix.h.
|
pure virtualinherited |
Return the minimal level for which matrices are stored.
|
pure virtualinherited |
Return the minimal level for which matrices are stored.
|
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.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.
|
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.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 203 of file subscriptor.cc.
|
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.
|
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.
Definition at line 52 of file subscriptor.cc.
|
private |
Pointer to the matrix objects on each level.
Definition at line 184 of file mg_matrix.h.
|
private |
Row coordinate of selected block.
Definition at line 188 of file mg_matrix.h.
|
private |
Column coordinate of selected block.
Definition at line 192 of file mg_matrix.h.
|
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.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.
|
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.
|
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.
|
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.