![]() |
Reference documentation for deal.II version Git ac854ef673 2021-03-06 10:09:45 +0100
|
#include <deal.II/multigrid/mg_coarse.h>
Public Member Functions | |
MGCoarseGridIterativeSolver () | |
MGCoarseGridIterativeSolver (SolverType &solver, const MatrixType &matrix, const PreconditionerType &precondition) | |
void | initialize (SolverType &solver, const MatrixType &matrix, const PreconditionerType &precondition) |
void | clear () |
virtual void | operator() (const unsigned int level, VectorType &dst, const VectorType &src) const override |
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 Attributes | |
SmartPointer< SolverType, MGCoarseGridIterativeSolver< VectorType, SolverType, MatrixType, PreconditionerType > > | solver |
SmartPointer< const MatrixType, MGCoarseGridIterativeSolver< VectorType, SolverType, MatrixType, PreconditionerType > > | matrix |
SmartPointer< const PreconditionerType, MGCoarseGridIterativeSolver< VectorType, SolverType, MatrixType, PreconditionerType > > | preconditioner |
Coarse grid multigrid operator for an iterative solver.
This class provides a wrapper for a deal.II iterative solver with a given matrix and preconditioner as a coarse grid operator.
Definition at line 92 of file mg_coarse.h.
MGCoarseGridIterativeSolver< VectorType, SolverType, MatrixType, PreconditionerType >::MGCoarseGridIterativeSolver | ( | ) |
Default constructor.
MGCoarseGridIterativeSolver< VectorType, SolverType, MatrixType, PreconditionerType >::MGCoarseGridIterativeSolver | ( | SolverType & | solver, |
const MatrixType & | matrix, | ||
const PreconditionerType & | precondition | ||
) |
Constructor. Only a reference to these objects is stored, so their lifetime needs to exceed the usage in this class.
void MGCoarseGridIterativeSolver< VectorType, SolverType, MatrixType, PreconditionerType >::initialize | ( | SolverType & | solver, |
const MatrixType & | matrix, | ||
const PreconditionerType & | precondition | ||
) |
Initialize with new data, see the corresponding constructor for more details.
void MGCoarseGridIterativeSolver< VectorType, SolverType, MatrixType, PreconditionerType >::clear | ( | ) |
Clear all pointers.
|
overridevirtual |
Implementation of the abstract function. Calls the solve method of the given solver with matrix, vectors, and preconditioner.
Implements MGCoarseGridBase< VectorType >.
|
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.
|
private |
Reference to the solver.
Definition at line 141 of file mg_coarse.h.
|
private |
Reference to the matrix.
Definition at line 151 of file mg_coarse.h.
|
private |
Reference to the preconditioner.
Definition at line 161 of file mg_coarse.h.