deal.II version GIT relicensing-2238-gc05b561aad 2024-12-10 20:50:00+00:00
|
#include <deal.II/multigrid/mg_base.h>
Public Member Functions | |
virtual | ~MGTransferBase () override=default |
virtual void | prolongate (const unsigned int to_level, VectorType &dst, const VectorType &src) const =0 |
virtual void | prolongate_and_add (const unsigned int to_level, VectorType &dst, const VectorType &src) const |
virtual void | restrict_and_add (const unsigned int from_level, VectorType &dst, const VectorType &src) const =0 |
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 | check_no_subscribers () const noexcept |
Private Attributes | |
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 |
Base class used to declare the operations needed by a concrete class implementing prolongation and restriction of vectors in the multigrid context. This class is abstract and has no implementation of these operations.
There are several derived classes, reflecting the fact that vector types and numbering of the fine-grid discretization and of the multi-level implementation are independent.
If you use multigrid for a single PDE or for your complete system of equations, you will use MGTransferPrebuilt together with Multigrid. The vector types used on the fine grid as well as for the multilevel operations may be Vector or BlockVector. In both cases, MGTransferPrebuilt will operate on all components of the solution.
For mixed systems, it may be required to do multigrid only for a single component or for some components. The classes MGTransferSelect and MGTransferBlock handle these cases.
MGTransferSelect is used if you use multigrid (on Vector objects) for a single component, possibly grouped using mg_target_component
.
The class MGTransferBlock handles the case where your multigrid method operates on BlockVector objects. These can contain all or a consecutive set of the blocks of the complete system. Since most smoothers cannot operate on block structures, it is not clear whether this case is really useful. Therefore, a tested implementation of this case will be supplied when needed.
|
privateinherited |
The data type used in counter_map.
Definition at line 238 of file enable_observer_pointer.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 243 of file enable_observer_pointer.h.
|
overridevirtualdefault |
Destructor. Does nothing here, but needs to be declared virtual anyway.
|
pure virtual |
Prolongate a vector from level to_level-1
to level to_level
. The previous content of dst
is overwritten.
Implemented in MGTransferBlock< number >, MGTransferBlockMatrixFreeBase< dim, Number, TransferType >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMF< dim, Number, ::MemorySpace::Host > >, MGTransferBlockSelect< number >, MGTransferSelect< number >, MGTransferPrebuilt< VectorType >, MGTransferMF< dim, Number, MemorySpace >, and MGTransferMF< dim, Number, MemorySpace::Host >.
|
virtual |
Prolongate a vector from level to_level-1
to level to_level
, summing into the previous content of dst
.
Reimplemented in MGTransferBlockMatrixFreeBase< dim, Number, TransferType >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMF< dim, Number, ::MemorySpace::Host > >, MGTransferMF< dim, Number, MemorySpace >, and MGTransferMF< dim, Number, MemorySpace::Host >.
Definition at line 45 of file mg_base.cc.
|
pure virtual |
Restrict a vector from level from_level
to level from_level-1
and add this restriction to dst
. If the region covered by cells on level from_level
is smaller than that of level from_level-1
(local refinement), then some degrees of freedom in dst
are active and will not be altered. For the other degrees of freedom, the result of the restriction is added.
Implemented in MGTransferBlock< number >, MGTransferBlockMatrixFreeBase< dim, Number, TransferType >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMF< dim, Number, ::MemorySpace::Host > >, MGTransferBlockSelect< number >, MGTransferSelect< number >, MGTransferPrebuilt< VectorType >, MGTransferMF< dim, Number, MemorySpace >, and MGTransferMF< dim, Number, MemorySpace::Host >.
|
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.
|
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 151 of file enable_observer_pointer.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 322 of file enable_observer_pointer.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 339 of file enable_observer_pointer.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 199 of file enable_observer_pointer.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 331 of file enable_observer_pointer.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 53 of file enable_observer_pointer.cc.
|
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.
|
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.
|
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.
|
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.
|
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.