deal.II version GIT relicensing-1972-g22a7b89abe 2024-10-11 21:20:00+00:00
|
#include <deal.II/multigrid/mg_transfer_global_coarsening.h>
Public Types | |
using | Number = typename VectorType::value_type |
Public Member Functions | |
MGTwoLevelTransferBase () | |
void | prolongate_and_add (VectorType &dst, const VectorType &src) const |
void | restrict_and_add (VectorType &dst, const VectorType &src) const |
virtual void | interpolate (VectorType &dst, const VectorType &src) const =0 |
virtual std::pair< bool, bool > | enable_inplace_operations_if_possible (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_coarse, const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_fine)=0 |
virtual std::size_t | memory_consumption () 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 ObserverPointer 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) |
Public Attributes | |
std::shared_ptr< const Utilities::MPI::Partitioner > | partitioner_coarse |
std::shared_ptr< const Utilities::MPI::Partitioner > | partitioner_fine |
Protected Attributes | |
bool | fine_element_is_continuous |
LinearAlgebra::distributed::Vector< Number > | vec_coarse |
LinearAlgebra::distributed::Vector< Number > | vec_fine |
bool | vec_fine_needs_ghost_update |
std::shared_ptr< const Utilities::MPI::Partitioner > | partitioner_coarse_embedded |
std::shared_ptr< const Utilities::MPI::Partitioner > | partitioner_fine_embedded |
AlignedVector< Number > | buffer_coarse_embedded |
AlignedVector< Number > | buffer_fine_embedded |
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 |
An abstract base class for transfer operators between two multigrid levels. The implementation of restriction and prolongation between levels is delegated to derived classes, which implement prolongate_and_add_internal() and restrict_and_add_internal() accordingly.
Definition at line 219 of file mg_transfer_global_coarsening.h.
using MGTwoLevelTransferBase< VectorType >::Number = typename VectorType::value_type |
The scalar type used by the vector-type template argument.
Definition at line 232 of file mg_transfer_global_coarsening.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 230 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 235 of file subscriptor.h.
MGTwoLevelTransferBase< VectorType >::MGTwoLevelTransferBase | ( | ) |
Default constructor.
void MGTwoLevelTransferBase< VectorType >::prolongate_and_add | ( | VectorType & | dst, |
const VectorType & | src | ||
) | const |
Perform prolongation on a solution vector.
void MGTwoLevelTransferBase< VectorType >::restrict_and_add | ( | VectorType & | dst, |
const VectorType & | src | ||
) | const |
Perform restriction on a residual vector.
|
pure virtual |
Perform interpolation of a solution vector from the fine level to the coarse level. This function is different from restriction, where a weighted residual is transferred to a coarser level (transposition of prolongation matrix). In other words, restriction acts on right hand side vectors, whereas interpolation acts on solution vectors.
Implemented in MGTwoLevelTransfer< dim, VectorType >, and MGTwoLevelTransferNonNested< dim, VectorType >.
|
pure virtual |
Enable inplace vector operations if external and internal vectors are compatible. The returned pair indicates if the operation was successful on the coarse and the fine level.
Implemented in MGTwoLevelTransfer< dim, VectorType >, MGTwoLevelTransfer< dim, LinearAlgebra::distributed::Vector >, and MGTwoLevelTransferNonNested< dim, VectorType >.
|
pure virtual |
Return the memory consumption of the allocated memory in this class.
Implemented in MGTwoLevelTransfer< dim, VectorType >, MGTwoLevelTransfer< dim, LinearAlgebra::distributed::Vector >, and MGTwoLevelTransferNonNested< dim, VectorType >.
|
protectedpure virtual |
Perform prolongation on vectors with correct ghosting.
|
protectedpure virtual |
Perform restriction on vectors with correct ghosting.
|
protected |
A wrapper around update_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.
|
protected |
A wrapper around compress() optimized in case the present vector has the same parallel layout of one of the external partitioners.
|
protected |
A wrapper around zero_out_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.
|
protected |
Enable inplace vector operations if external and internal vectors are compatible.
|
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 130 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 150 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 198 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.
|
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.
|
protected |
Flag if the finite elements on the fine cells are continuous. If yes, the multiplicity of DoF sharing a vertex/line as well as constraints have to be taken into account via weights.
Definition at line 341 of file mg_transfer_global_coarsening.h.
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_coarse |
Partitioner needed by the intermediate vector.
Definition at line 347 of file mg_transfer_global_coarsening.h.
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_fine |
Partitioner needed by the intermediate vector.
Definition at line 352 of file mg_transfer_global_coarsening.h.
|
mutableprotected |
Internal vector on which the actual prolongation/restriction is performed.
Definition at line 358 of file mg_transfer_global_coarsening.h.
|
mutableprotected |
Internal vector needed for collecting all degrees of freedom of the fine cells. It is only initialized if the fine-level DoF indices touch DoFs other than the locally active ones (which we always assume can be accessed by the given vectors in the prolongate/restrict functions), otherwise it is left at size zero.
Definition at line 367 of file mg_transfer_global_coarsening.h.
|
protected |
Bool indicating whether fine vector has relevant ghost values.
Definition at line 372 of file mg_transfer_global_coarsening.h.
|
protected |
Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 379 of file mg_transfer_global_coarsening.h.
|
protected |
Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 385 of file mg_transfer_global_coarsening.h.
|
mutableprotected |
Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 391 of file mg_transfer_global_coarsening.h.
|
mutableprotected |
Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 397 of file mg_transfer_global_coarsening.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 219 of file subscriptor.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 225 of file subscriptor.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.
Definition at line 241 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 249 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 272 of file subscriptor.h.