![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/multigrid/multigrid.h>
Public Member Functions | |
PreconditionMG (const DoFHandler< dim > &dof_handler, Multigrid< VectorType > &mg, const TransferType &transfer) | |
PreconditionMG (const std::vector< const DoFHandler< dim > * > &dof_handler, Multigrid< VectorType > &mg, const TransferType &transfer) | |
bool | empty () const |
template<typename OtherVectorType > | |
void | vmult (OtherVectorType &dst, const OtherVectorType &src) const |
template<typename OtherVectorType > | |
void | vmult_add (OtherVectorType &dst, const OtherVectorType &src) const |
template<typename OtherVectorType > | |
void | Tvmult (OtherVectorType &dst, const OtherVectorType &src) const |
template<typename 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 |
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) |
Multigrid< VectorType > & | get_multigrid () |
const Multigrid< VectorType > & | get_multigrid () const |
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 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::vector< SmartPointer< const DoFHandler< dim >, PreconditionMG< dim, VectorType, TransferType > > > | dof_handler_vector |
std::vector< const DoFHandler< dim > * > | dof_handler_vector_raw |
SmartPointer< Multigrid< VectorType >, PreconditionMG< dim, VectorType, TransferType > > | multigrid |
SmartPointer< const TransferType, PreconditionMG< dim, VectorType, TransferType > > | transfer |
const bool | uses_dof_handler_vector |
mg::Signals | signals |
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 |
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 TransferType
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 500 of file multigrid.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
PreconditionMG< dim, VectorType, TransferType >::PreconditionMG | ( | const DoFHandler< dim > & | dof_handler, |
Multigrid< VectorType > & | mg, | ||
const TransferType & | transfer ) |
Constructor. Arguments are the multigrid object, pre-smoother, post-smoother and coarse grid solver.
PreconditionMG< dim, VectorType, TransferType >::PreconditionMG | ( | const std::vector< const DoFHandler< dim > * > & | dof_handler, |
Multigrid< VectorType > & | mg, | ||
const TransferType & | transfer ) |
Same as above in case every component of a block vector uses its own DoFHandler.
bool PreconditionMG< dim, VectorType, TransferType >::empty | ( | ) | const |
Dummy function needed by other classes.
void PreconditionMG< dim, VectorType, TransferType >::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, TransferType >::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, TransferType >::Tvmult | ( | OtherVectorType & | dst, |
const OtherVectorType & | src ) const |
Transposed preconditioning operator.
Not implemented, but the definition may be needed.
void PreconditionMG< dim, VectorType, TransferType >::Tvmult_add | ( | OtherVectorType & | dst, |
const OtherVectorType & | src ) const |
Transposed preconditioning operator.
Not implemented, but the definition may be needed.
IndexSet PreconditionMG< dim, VectorType, TransferType >::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, TransferType >::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.
MPI_Comm PreconditionMG< dim, VectorType, TransferType >::get_mpi_communicator | ( | ) | const |
Return the underlying MPI communicator.
boost::signals2::connection PreconditionMG< dim, VectorType, TransferType >::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, TransferType >::connect_transfer_to_global | ( | const std::function< void(bool)> & | slot | ) |
Connect a function to mg::Signals::transfer_to_global.
Multigrid< VectorType > & PreconditionMG< dim, VectorType, TransferType >::get_multigrid | ( | ) |
Return the Multigrid object passed to the constructor.
const Multigrid< VectorType > & PreconditionMG< dim, VectorType, TransferType >::get_multigrid | ( | ) | const |
Return the Multigrid object passed to the constructor.
|
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 135 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 155 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 300 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 203 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 309 of file subscriptor.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 52 of file subscriptor.cc.
|
private |
Associated DoFHandler
.
Definition at line 615 of file multigrid.h.
|
private |
Storage for the pointers to the DoFHandler objects without SmartPointer wrapper.
Definition at line 621 of file multigrid.h.
|
private |
The multigrid object.
Definition at line 628 of file multigrid.h.
|
private |
Object for grid transfer.
Definition at line 635 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 641 of file multigrid.h.
|
private |
Signals used by this object
Definition at line 646 of file multigrid.h.
|
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 218 of file subscriptor.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 240 of file subscriptor.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 248 of file subscriptor.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 271 of file subscriptor.h.