![]() |
deal.II version GIT relicensing-6816-g8d70a4508a 2026-09-28 16:30:01+00:00
|
#include <deal.II/multigrid/mg_transfer_matrix_free.h>
Class for transfer between two multigrid levels for geometric or polynomial coarsening strategies. It relies on a list of DoF indices associated with the cells on the coarse and fine side of the transfer, and implements a cell-by-cell (matrix-free) interpolation setup with the reference-cell embedding matrices.
The implementation of this class is explained in detail in [181].
There are two possible ways to use this class. In the first option, the transfer is built from the underlying DoFHandler and AffineConstraints objects on the coarse and fine side, collecting an explicit copy of all indices on both sides. This works for a relatively wide set of FiniteElement combinations, including p-adaptive schemes using hp::FECollection. The second, more setup-efficient approach is to build the transfer between two multigrid levels for polynomial coarsening (p-coarsening) from two MatrixFree objects that might already exist from other parts of the code. In this case, we require that both objects share the same triangulation (but differ through their DoFHandler descriptions) and are described by the respective DoFHandler/AffineConstraints pair used for constructing the MatrixFree object. This second variant is more efficient because no queries to the DoFHandler need to be made, reducing both the setup time and the overall memory consumption. Note that not all options are supported for the second entry point, and we fall back to the first option in such a case.
Definition at line 370 of file mg_transfer_matrix_free.h.
Classes | |
| struct | MatrixFreeRelatedData |
| struct | MGTransferScheme |
Public Types | |
| using | Number = typename VectorType::value_type |
| using | VectorizedArrayType = VectorizedArray< Number > |
Public Member Functions | |
| void | reinit_geometric_transfer (const DoFHandler< dim > &dof_handler_fine, const DoFHandler< dim > &dof_handler_coarse, const AffineConstraints< Number > &constraint_fine=AffineConstraints< Number >(), const AffineConstraints< Number > &constraint_coarse=AffineConstraints< Number >(), const unsigned int mg_level_fine=numbers::invalid_unsigned_int, const unsigned int mg_level_coarse=numbers::invalid_unsigned_int) |
| void | reinit_polynomial_transfer (const DoFHandler< dim > &dof_handler_fine, const DoFHandler< dim > &dof_handler_coarse, const AffineConstraints< Number > &constraint_fine=AffineConstraints< Number >(), const AffineConstraints< Number > &constraint_coarse=AffineConstraints< Number >(), const unsigned int mg_level_fine=numbers::invalid_unsigned_int, const unsigned int mg_level_coarse=numbers::invalid_unsigned_int) |
| void | reinit (const DoFHandler< dim > &dof_handler_fine, const DoFHandler< dim > &dof_handler_coarse, const AffineConstraints< Number > &constraint_fine=AffineConstraints< Number >(), const AffineConstraints< Number > &constraint_coarse=AffineConstraints< Number >(), const unsigned int mg_level_fine=numbers::invalid_unsigned_int, const unsigned int mg_level_coarse=numbers::invalid_unsigned_int) |
| void | reinit (const MatrixFree< dim, Number > &matrix_free_fine, const unsigned int dof_handler_index_fine, const MatrixFree< dim, Number > &matrix_free_coarse, const unsigned int dof_handler_index_coarse) |
| void | interpolate (VectorType &dst, const VectorType &src) const override |
| 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) override |
| std::size_t | memory_consumption () const override |
| std::pair< const DoFHandler< dim > *, unsigned int > | get_dof_handler_fine () const override |
| void | prolongate_and_add (VectorType &dst, const VectorType &src) const override |
| void | restrict_and_add (VectorType &dst, const VectorType &src) const override |
| template<class Archive > | |
| void | serialize (Archive &ar, const unsigned int version) |
Querying the observer pointers an object has. | |
| unsigned int | n_subscriptions () const |
| template<typename StreamType > | |
| void | list_subscribers (StreamType &stream) const |
| void | list_subscribers () const |
Static Public Member Functions | |
| static bool | fast_polynomial_transfer_supported (const unsigned int fe_degree_fine, const unsigned int fe_degree_coarse) |
| 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 Member Functions | |
| void | prolongate_and_add_internal (VectorType &dst, const VectorType &src) const override |
| void | restrict_and_add_internal (VectorType &dst, const VectorType &src) const override |
| void | update_ghost_values (const VectorType &vec) const |
| void | compress (VectorType &vec, const VectorOperation::values op) const |
| void | zero_out_ghost_values (const VectorType &vec) const |
| template<std::size_t width, typename IndexType > | |
| std::pair< bool, bool > | internal_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, bool &vec_fine_needs_ghost_update, internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArray< Number, width >, IndexType > &constraint_info_coarse, std::vector< unsigned int > &dof_indices_fine) |
Protected Attributes | |
| bool | fine_element_is_continuous |
| VectorType | vec_coarse |
| VectorType | 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 Member Functions | |
EnableObserverPointer functionality | |
Classes derived from EnableObserverPointer 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 |
| void | check_no_subscribers () const noexcept |
Private Attributes | |
| std::vector< MGTransferScheme > | schemes |
| internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArrayType, types::global_dof_index > | constraint_info_coarse |
| internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArrayType, types::global_dof_index > | constraint_info_fine |
| std::unique_ptr< MatrixFreeRelatedData > | matrix_free_data |
| std::vector< unsigned int > | weights_start |
| AlignedVector< VectorizedArrayType > | weights |
| std::vector< unsigned char > | weights_are_compressed |
| unsigned int | n_components |
| ObserverPointer< const DoFHandler< dim > > | dof_handler_fine |
| unsigned int | mg_level_fine |
| 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 |
| using MGTwoLevelTransfer< dim, VectorType >::Number = typename VectorType::value_type |
The scalar type used by the vector-type template argument.
Definition at line 389 of file mg_transfer_matrix_free.h.
| using MGTwoLevelTransfer< dim, VectorType >::VectorizedArrayType = VectorizedArray<Number> |
A data type representing a vectorized array of the same kind of objects stored in the VectorType.
Definition at line 395 of file mg_transfer_matrix_free.h.
| void MGTwoLevelTransfer< dim, VectorType >::reinit_geometric_transfer | ( | const DoFHandler< dim > & | dof_handler_fine, |
| const DoFHandler< dim > & | dof_handler_coarse, | ||
| const AffineConstraints< Number > & | constraint_fine = AffineConstraints< Number >(), |
||
| const AffineConstraints< Number > & | constraint_coarse = AffineConstraints< Number >(), |
||
| const unsigned int | mg_level_fine = numbers::invalid_unsigned_int, |
||
| const unsigned int | mg_level_coarse = numbers::invalid_unsigned_int |
||
| ) |
Set up global coarsening between the given DoFHandler objects ( dof_handler_fine and dof_handler_coarse). In case the optional arguments mg_level_fine and mg_level_coarse are set, a local-smoothing multigrid approach is possible, otherwise a global-coarsening approach connecting two different triangulations on active cells is selected.
| void MGTwoLevelTransfer< dim, VectorType >::reinit_polynomial_transfer | ( | const DoFHandler< dim > & | dof_handler_fine, |
| const DoFHandler< dim > & | dof_handler_coarse, | ||
| const AffineConstraints< Number > & | constraint_fine = AffineConstraints< Number >(), |
||
| const AffineConstraints< Number > & | constraint_coarse = AffineConstraints< Number >(), |
||
| const unsigned int | mg_level_fine = numbers::invalid_unsigned_int, |
||
| const unsigned int | mg_level_coarse = numbers::invalid_unsigned_int |
||
| ) |
Set up polynomial coarsening between the given DoFHandler objects ( dof_handler_fine and dof_handler_coarse). Polynomial transfers can be only performed on active levels (numbers::invalid_unsigned_int) or on coarse-grid levels, i.e., levels without hanging nodes.
| void MGTwoLevelTransfer< dim, VectorType >::reinit | ( | const DoFHandler< dim > & | dof_handler_fine, |
| const DoFHandler< dim > & | dof_handler_coarse, | ||
| const AffineConstraints< Number > & | constraint_fine = AffineConstraints< Number >(), |
||
| const AffineConstraints< Number > & | constraint_coarse = AffineConstraints< Number >(), |
||
| const unsigned int | mg_level_fine = numbers::invalid_unsigned_int, |
||
| const unsigned int | mg_level_coarse = numbers::invalid_unsigned_int |
||
| ) |
Set up the transfer operator between the given DoFHandler objects ( dof_handler_fine and dof_handler_coarse). Depending on the underlying Triangulation objects, either a polynomial or geometric global coarsening algorithm is selected.
numbers::invalid_unsigned_int), polynomial transfers can also be performed on coarse-grid levels, i.e., levels without hanging nodes.| void MGTwoLevelTransfer< dim, VectorType >::reinit | ( | const MatrixFree< dim, Number > & | matrix_free_fine, |
| const unsigned int | dof_handler_index_fine, | ||
| const MatrixFree< dim, Number > & | matrix_free_coarse, | ||
| const unsigned int | dof_handler_index_coarse | ||
| ) |
Set up polynomial coarsening between the DoFHandler objects underlying two MatrixFree objects and the respective numbers for the DoFHandler objects within MatrixFree. This reinit() function allows for a more efficient setup of the transfer operator and reduces the overall memory consumption of a multigrid cycle in case the same MatrixFree objects are also used for smoothers and residual evaluation on the two involved levels.
|
static |
Check if a fast templated version of the polynomial transfer between fe_degree_fine and fe_degree_coarse is available.
|
overridevirtual |
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.
Implements MGTwoLevelTransferBase< dim, VectorType >.
|
overridevirtual |
Enable inplace vector operations if external and internal vectors are compatible.
Implements MGTwoLevelTransferBase< dim, VectorType >.
|
overridevirtual |
Return the memory consumption of the allocated memory in this class.
Implements MGTwoLevelTransferBase< dim, VectorType >.
|
overridevirtual |
Return the DoFHandler associated with the fine level and the level index.
Implements MGTwoLevelTransferBase< dim, VectorType >.
|
overrideprotectedvirtual |
Perform prolongation on vectors with correct ghosting.
Implements internal::MGTwoLevelTransferCore< dim, VectorType >.
|
overrideprotectedvirtual |
Perform restriction on vectors with correct ghosting.
Implements internal::MGTwoLevelTransferCore< dim, VectorType >.
|
overridevirtualinherited |
Perform prolongation on a solution vector.
Implements MGTwoLevelTransferBase< dim, VectorType >.
|
overridevirtualinherited |
Perform restriction on a residual vector.
Implements MGTwoLevelTransferBase< dim, VectorType >.
|
protectedinherited |
A wrapper around update_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.
|
protectedinherited |
A wrapper around compress() optimized in case the present vector has the same parallel layout of one of the external partitioners.
|
protectedinherited |
A wrapper around zero_out_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.
|
protectedinherited |
Enable inplace vector operations if external and internal vectors are compatible.
|
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 318 of file enable_observer_pointer.h.
|
inlineinherited |
List the subscribers to the input stream.
Definition at line 335 of file enable_observer_pointer.h.
|
inherited |
List the subscribers to deallog.
Definition at line 200 of file enable_observer_pointer.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 327 of file enable_observer_pointer.h.
|
privateinherited |
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 enable_observer_pointer.cc.
|
privateinherited |
Unsubscribes a user from the object.
identifier and the validity pointer must be the same as the one supplied to subscribe(). Definition at line 154 of file enable_observer_pointer.cc.
|
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 58 of file enable_observer_pointer.cc.
|
friend |
Definition at line 678 of file mg_transfer_matrix_free.h.
|
friend |
Definition at line 678 of file mg_transfer_matrix_free.h.
|
friend |
Definition at line 678 of file mg_transfer_matrix_free.h.
|
friend |
Definition at line 678 of file mg_transfer_matrix_free.h.
|
friend |
Definition at line 688 of file mg_transfer_matrix_free.h.
|
private |
Transfer schemes.
Definition at line 588 of file mg_transfer_matrix_free.h.
|
private |
Helper class for reading from and writing to global coarse vectors and for applying constraints.
Definition at line 596 of file mg_transfer_matrix_free.h.
|
private |
Helper class for reading from and writing to global fine vectors.
Definition at line 603 of file mg_transfer_matrix_free.h.
|
private |
In case this class is built with MatrixFree objects (see the respective reinit() function), we set up this data structure and skip the other fields of the class.
Definition at line 643 of file mg_transfer_matrix_free.h.
|
private |
CRS-like pointer to the start into the weights array, as that array can be compressed or in full format.
Definition at line 649 of file mg_transfer_matrix_free.h.
|
private |
Weights for continuous elements, either in full format or compressed into 3^dim doubles per cell if possible.
Definition at line 655 of file mg_transfer_matrix_free.h.
|
private |
Store whether the weights are in compressed format or not, in the ordering of the weights_start array.
Definition at line 661 of file mg_transfer_matrix_free.h.
|
private |
Number of components.
Definition at line 666 of file mg_transfer_matrix_free.h.
|
private |
Pointer to the DoFHandler object used during initialization.
Definition at line 671 of file mg_transfer_matrix_free.h.
|
private |
Multigrid level used during initialization.
Definition at line 676 of file mg_transfer_matrix_free.h.
|
protectedinherited |
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 290 of file mg_transfer_matrix_free.h.
|
mutableprotectedinherited |
Internal vector on which the actual prolongation/restriction is performed.
Definition at line 297 of file mg_transfer_matrix_free.h.
|
mutableprotectedinherited |
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 306 of file mg_transfer_matrix_free.h.
|
protectedinherited |
Bool indicating whether fine vector has relevant ghost values.
Definition at line 311 of file mg_transfer_matrix_free.h.
|
protectedinherited |
Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 318 of file mg_transfer_matrix_free.h.
|
protectedinherited |
Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 325 of file mg_transfer_matrix_free.h.
|
mutableprotectedinherited |
Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 331 of file mg_transfer_matrix_free.h.
|
mutableprotectedinherited |
Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 337 of file mg_transfer_matrix_free.h.
|
inherited |
Partitioner needed by the intermediate vector.
Definition at line 142 of file mg_transfer_matrix_free.h.
|
inherited |
Partitioner needed by the intermediate vector.
Definition at line 147 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 212 of file enable_observer_pointer.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 218 of file enable_observer_pointer.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.
Definition at line 224 of file enable_observer_pointer.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 232 of file enable_observer_pointer.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 239 of file enable_observer_pointer.h.