![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/multigrid/mg_transfer_matrix_free.h>
Public Member Functions | |
MGTransferBlockMatrixFreeBase (const bool same_for_all) | |
virtual void | prolongate (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const override |
virtual void | prolongate_and_add (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const override |
virtual void | restrict_and_add (const unsigned int from_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const override |
template<typename BlockVectorType2 > | |
void | copy_to_mg (const DoFHandler< dim > &dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number > > &dst, const BlockVectorType2 &src) const |
template<typename BlockVectorType2 > | |
void | copy_to_mg (const std::vector< const DoFHandler< dim > * > &dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number > > &dst, const BlockVectorType2 &src) const |
template<typename BlockVectorType2 > | |
void | copy_from_mg (const DoFHandler< dim > &dof_handler, BlockVectorType2 &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number > > &src) const |
template<typename BlockVectorType2 > | |
void | copy_from_mg (const std::vector< const DoFHandler< dim > * > &dof_handler, BlockVectorType2 &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number > > &src) 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) |
Static Public Attributes | |
static const bool | supports_dof_handler_vector = true |
Protected Member Functions | |
virtual const TransferType & | get_matrix_free_transfer (const unsigned int b) const =0 |
Protected Attributes | |
const bool | same_for_all |
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 of MGTransferBlockMatrixFree. While MGTransferBlockMatrixFree contains all the setup routines of the transfer operators for the blocks, this class simply applies them, e.g., for restricting and prolongating.
Definition at line 316 of file mg_transfer_matrix_free.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.
|
inline |
Definition at line 320 of file mg_transfer_matrix_free.h.
|
overridevirtual |
Prolongate a vector from level to_level-1
to level to_level
using the embedding matrices of the underlying finite element. The previous content of dst
is overwritten.
to_level | The index of the level to prolongate to, which is the level of dst . |
src | is a vector with as many elements as there are degrees of freedom on the coarser level involved. |
dst | has as many elements as there are degrees of freedom on the finer level. |
Implements MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >.
|
overridevirtual |
Prolongate a vector from level to_level-1
to level to_level
, summing into the previous content of dst
.
Reimplemented from MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >.
|
overridevirtual |
Restrict a vector from level from_level
to level from_level-1
using the transpose operation of the prolongate() method. 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.
from_level | The index of the level to restrict from, which is the level of src . |
src | is a vector with as many elements as there are degrees of freedom on the finer level involved. |
dst | has as many elements as there are degrees of freedom on the coarser level. |
Implements MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >.
void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::copy_to_mg | ( | const DoFHandler< dim > & | dof_handler, |
MGLevelObject< LinearAlgebra::distributed::BlockVector< Number > > & | dst, | ||
const BlockVectorType2 & | src ) const |
Transfer from a block-vector on the global grid to block-vectors defined on each of the levels separately for active degrees of freedom. In particular, for a globally refined mesh only the finest level in dst
is filled as a plain copy of src
. All the other level objects are left untouched.
This function will initialize dst
accordingly if needed as required by the Multigrid class.
void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::copy_to_mg | ( | const std::vector< const DoFHandler< dim > * > & | dof_handler, |
MGLevelObject< LinearAlgebra::distributed::BlockVector< Number > > & | dst, | ||
const BlockVectorType2 & | src ) const |
Same as above for the case that each block has its own DoFHandler.
void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::copy_from_mg | ( | const DoFHandler< dim > & | dof_handler, |
BlockVectorType2 & | dst, | ||
const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number > > & | src ) const |
Transfer from multi-level block-vector to normal vector.
void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::copy_from_mg | ( | const std::vector< const DoFHandler< dim > * > & | dof_handler, |
BlockVectorType2 & | dst, | ||
const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number > > & | src ) const |
Same as above for the case that each block has its own DoFHandler.
|
protectedpure virtual |
Return the right non-block transfer operator. Has to be implemented by the derived class.
Implemented in MGTransferBlockMatrixFree< dim, Number >, and MGTransferBlockMF< 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 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.
|
static |
This class can both be used with a single DoFHandler or a separate DoFHandler for each block.
Definition at line 427 of file mg_transfer_matrix_free.h.
|
protected |
A flag to indicate whether the same DoFHandler is used for all the components or if each block has its own DoFHandler.
Definition at line 441 of file mg_transfer_matrix_free.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.