![]() |
Reference documentation for deal.II version Git c9feb145b3 2021-03-01 21:22:52 +0100
|
#include <deal.II/multigrid/multigrid.h>
Public Member Functions | |
PreconditionMG (const DoFHandler< dim > &dof_handler, Multigrid< VectorType > &mg, const TRANSFER &transfer) | |
PreconditionMG (const std::vector< const DoFHandler< dim > *> &dof_handler, Multigrid< VectorType > &mg, const TRANSFER &transfer) | |
bool | empty () const |
template<class OtherVectorType > | |
void | vmult (OtherVectorType &dst, const OtherVectorType &src) const |
template<class OtherVectorType > | |
void | vmult_add (OtherVectorType &dst, const OtherVectorType &src) const |
template<class OtherVectorType > | |
void | Tvmult (OtherVectorType &dst, const OtherVectorType &src) const |
template<class OtherVectorType > | |
void | Tvmult_add (OtherVectorType &dst, const OtherVectorType &src) const |
IndexSet | locally_owned_range_indices (const unsigned int block=0) const |
IndexSet | locally_owned_domain_indices (const unsigned int block=0) const |
const MPI_Comm & | get_mpi_communicator () const |
boost::signals2::connection | connect_transfer_to_mg (const std::function< void(bool)> &slot) |
boost::signals2::connection | connect_transfer_to_global (const std::function< void(bool)> &slot) |
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 | |
std::vector< SmartPointer< const DoFHandler< dim >, PreconditionMG< dim, VectorType, TRANSFER > > > | dof_handler_vector |
std::vector< const DoFHandler< dim > * > | dof_handler_vector_raw |
SmartPointer< Multigrid< VectorType >, PreconditionMG< dim, VectorType, TRANSFER > > | multigrid |
SmartPointer< const TRANSFER, PreconditionMG< dim, VectorType, TRANSFER > > | transfer |
const bool | uses_dof_handler_vector |
mg::Signals | signals |
Multi-level preconditioner. Here, we collect all information needed for multi-level preconditioning and provide the standard interface for LAC iterative methods.
Furthermore, it needs functions void copy_to_mg(const VectorType&)
to store src
in the right hand side of the multi-level method and void copy_from_mg(VectorType&)
to store the result of the v-cycle in dst
.
If VectorType is in fact a block vector and the TRANSFER object supports use of a separate DoFHandler for each block, this class also allows to be initialized with a separate DoFHandler for each block.
Definition at line 467 of file multigrid.h.
PreconditionMG< dim, VectorType, TRANSFER >::PreconditionMG | ( | const DoFHandler< dim > & | dof_handler, |
Multigrid< VectorType > & | mg, | ||
const TRANSFER & | transfer | ||
) |
Constructor. Arguments are the multigrid object, pre-smoother, post- smoother and coarse grid solver.
PreconditionMG< dim, VectorType, TRANSFER >::PreconditionMG | ( | const std::vector< const DoFHandler< dim > *> & | dof_handler, |
Multigrid< VectorType > & | mg, | ||
const TRANSFER & | transfer | ||
) |
Same as above in case every component of a block vector uses its own DoFHandler.
bool PreconditionMG< dim, VectorType, TRANSFER >::empty | ( | ) | const |
Dummy function needed by other classes.
void PreconditionMG< dim, VectorType, TRANSFER >::vmult | ( | OtherVectorType & | dst, |
const OtherVectorType & | src | ||
) | const |
Preconditioning operator. Calls the vcycle
function of the MG
object passed to the constructor.
This is the operator used by LAC iterative solvers.
void PreconditionMG< dim, VectorType, TRANSFER >::vmult_add | ( | OtherVectorType & | dst, |
const OtherVectorType & | src | ||
) | const |
Preconditioning operator. Calls the vcycle
function of the MG
object passed to the constructor.
void PreconditionMG< dim, VectorType, TRANSFER >::Tvmult | ( | OtherVectorType & | dst, |
const OtherVectorType & | src | ||
) | const |
Transposed preconditioning operator.
Not implemented, but the definition may be needed.
void PreconditionMG< dim, VectorType, TRANSFER >::Tvmult_add | ( | OtherVectorType & | dst, |
const OtherVectorType & | src | ||
) | const |
Transposed preconditioning operator.
Not implemented, but the definition may be needed.
IndexSet PreconditionMG< dim, VectorType, TRANSFER >::locally_owned_range_indices | ( | const unsigned int | block = 0 | ) | const |
Return the partitioning of the range space of this preconditioner, i.e., the partitioning of the vectors that are result from matrix-vector products. By default, the respective information for the first DoFHandler object are returned.
IndexSet PreconditionMG< dim, VectorType, TRANSFER >::locally_owned_domain_indices | ( | const unsigned int | block = 0 | ) | const |
Return the partitioning of the domain space of this preconditioner, i.e., the partitioning of the vectors this matrix has to be multiplied with. By default, the respective information for the first DoFHandler object are returned.
const MPI_Comm& PreconditionMG< dim, VectorType, TRANSFER >::get_mpi_communicator | ( | ) | const |
Return the MPI communicator object in use with this preconditioner.
boost::signals2::connection PreconditionMG< dim, VectorType, TRANSFER >::connect_transfer_to_mg | ( | const std::function< void(bool)> & | slot | ) |
Connect a function to mg::Signals::transfer_to_mg.
boost::signals2::connection PreconditionMG< dim, VectorType, TRANSFER >::connect_transfer_to_global | ( | const std::function< void(bool)> & | slot | ) |
Connect a function to mg::Signals::transfer_to_global.
|
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 |
Associated DoFHandler
.
Definition at line 570 of file multigrid.h.
|
private |
Storage for the pointers to the DoFHandler objects without SmartPointer wrapper.
Definition at line 576 of file multigrid.h.
|
private |
The multigrid object.
Definition at line 582 of file multigrid.h.
|
private |
Object for grid transfer.
Definition at line 588 of file multigrid.h.
|
private |
Flag to indicate if the object is initialized with a single DoFHandler or with one for each block.
Definition at line 594 of file multigrid.h.
|
private |
Signals used by this object
Definition at line 599 of file multigrid.h.