![]() |
Reference documentation for deal.II version Git 52fd159989 2021-02-28 09:21:27 -0700
|
#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 | 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) |
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) |
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.
|
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 MGTransferPrebuilt< VectorType >, MGTransferBlockSelect< number >, MGTransferBlockMatrixFree< dim, Number >, MGTransferGlobalCoarsening< dim, VectorType >, MGTransferSelect< number >, MGTransferBlock< number >, and MGTransferMatrixFree< dim, Number >.
|
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 MGTransferPrebuilt< VectorType >, MGTransferBlockMatrixFree< dim, Number >, MGTransferBlockSelect< number >, MGTransferGlobalCoarsening< dim, VectorType >, MGTransferSelect< number >, MGTransferBlock< number >, and MGTransferMatrixFree< dim, Number >.
|
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.
|
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 156 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 301 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 318 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 204 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 310 of file subscriptor.h.