#include <deal.II/multigrid/mg_matrix.h>
|
| Matrix ()=default |
|
template<typename MatrixType > |
| Matrix (const MGLevelObject< MatrixType > &M) |
|
template<typename MatrixType > |
void | initialize (const MGLevelObject< MatrixType > &M) |
|
void | reset () |
|
const LinearOperator< VectorType > & | operator[] (unsigned int level) const |
|
virtual void | vmult (const unsigned int level, VectorType &dst, const VectorType &src) const override |
|
virtual void | vmult_add (const unsigned int level, VectorType &dst, const VectorType &src) const override |
|
virtual void | Tvmult (const unsigned int level, VectorType &dst, const VectorType &src) const override |
|
virtual void | Tvmult_add (const unsigned int level, VectorType &dst, const VectorType &src) const override |
|
virtual unsigned int | get_minlevel () const override |
|
virtual unsigned int | get_maxlevel () const override |
|
std::size_t | memory_consumption () const |
|
virtual void | vmult (const unsigned int level, Vector< double > &dst, const Vector< double > &src) const=0 |
|
virtual void | vmult_add (const unsigned int level, Vector< double > &dst, const Vector< double > &src) const=0 |
|
virtual void | Tvmult (const unsigned int level, Vector< double > &dst, const Vector< double > &src) const=0 |
|
virtual void | Tvmult_add (const unsigned int level, Vector< double > &dst, const Vector< double > &src) const=0 |
|
template<class Archive > |
void | serialize (Archive &ar, const unsigned int version) |
|
|
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 |
|
template<typename VectorType = Vector<double>>
class mg::Matrix< VectorType >
Multilevel matrix. This matrix stores an MGLevelObject of LinearOperator objects. It implements the interface defined in MGMatrixBase, so that it can be used as a matrix in Multigrid.
Definition at line 46 of file mg_matrix.h.
◆ map_value_type
◆ map_iterator
◆ Matrix() [1/2]
template<typename VectorType = Vector<double>>
Default constructor for an empty object.
◆ Matrix() [2/2]
template<typename VectorType >
template<typename MatrixType >
◆ initialize()
template<typename VectorType >
template<typename MatrixType >
Initialize the object such that the level multiplication uses the matrices in M
Definition at line 205 of file mg_matrix.h.
◆ reset()
template<typename VectorType >
◆ operator[]()
template<typename VectorType >
◆ vmult() [1/2]
template<typename VectorType >
void mg::Matrix< VectorType >::vmult |
( |
const unsigned int |
level, |
|
|
VectorType & |
dst, |
|
|
const VectorType & |
src |
|
) |
| const |
|
overridevirtual |
◆ vmult_add() [1/2]
template<typename VectorType >
void mg::Matrix< VectorType >::vmult_add |
( |
const unsigned int |
level, |
|
|
VectorType & |
dst, |
|
|
const VectorType & |
src |
|
) |
| const |
|
overridevirtual |
◆ Tvmult() [1/2]
template<typename VectorType >
void mg::Matrix< VectorType >::Tvmult |
( |
const unsigned int |
level, |
|
|
VectorType & |
dst, |
|
|
const VectorType & |
src |
|
) |
| const |
|
overridevirtual |
◆ Tvmult_add() [1/2]
template<typename VectorType >
void mg::Matrix< VectorType >::Tvmult_add |
( |
const unsigned int |
level, |
|
|
VectorType & |
dst, |
|
|
const VectorType & |
src |
|
) |
| const |
|
overridevirtual |
◆ get_minlevel()
template<typename VectorType >
unsigned int mg::Matrix< VectorType >::get_minlevel |
|
overridevirtual |
◆ get_maxlevel()
template<typename VectorType >
unsigned int mg::Matrix< VectorType >::get_maxlevel |
|
overridevirtual |
◆ memory_consumption()
template<typename VectorType >
std::size_t mg::Matrix< VectorType >::memory_consumption |
|
inline |
Memory used by this object.
Definition at line 313 of file mg_matrix.h.
◆ vmult() [2/2]
Matrix-vector-multiplication on a certain level.
◆ vmult_add() [2/2]
Adding matrix-vector-multiplication on a certain level.
◆ Tvmult() [2/2]
Transpose matrix-vector-multiplication on a certain level.
◆ Tvmult_add() [2/2]
Adding transpose matrix-vector-multiplication on a certain level.
◆ 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 136 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 156 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 |
◆ 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 53 of file subscriptor.cc.
◆ matrices
template<typename VectorType = Vector<double>>
◆ 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 219 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 225 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 241 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 249 of file subscriptor.h.
◆ mutex
std::mutex Subscriptor::mutex |
|
staticprivateinherited |
A mutex used to ensure data consistency when printing out the list of subscribers.
Definition at line 271 of file subscriptor.h.
The documentation for this class was generated from the following file: