deal.II version GIT relicensing-1927-g3de9220933 2024-10-03 08:40:00+00:00
|
#include <deal.II/multigrid/mg_transfer.h>
Public Member Functions | |
MGTransferPrebuilt ()=default | |
MGTransferPrebuilt (const MGConstrainedDoFs &mg_constrained_dofs) | |
virtual | ~MGTransferPrebuilt () override=default |
void | initialize_constraints (const MGConstrainedDoFs &mg_constrained_dofs) |
void | clear () |
template<int dim, int spacedim> | |
void | build (const DoFHandler< dim, spacedim > &dof_handler) |
virtual void | prolongate (const unsigned int to_level, VectorType &dst, const VectorType &src) const override |
virtual void | restrict_and_add (const unsigned int from_level, VectorType &dst, const VectorType &src) const override |
std::size_t | memory_consumption () const |
void | print_matrices (std::ostream &os) const |
template<int dim, class InVector , int spacedim> | |
void | copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< VectorType > &dst, const InVector &src) const |
template<int dim, class OutVector , int spacedim> | |
void | copy_from_mg (const DoFHandler< dim, spacedim > &dof_handler, OutVector &dst, const MGLevelObject< VectorType > &src) const |
template<int dim, class OutVector , int spacedim> | |
void | copy_from_mg_add (const DoFHandler< dim, spacedim > &dof_handler, OutVector &dst, const MGLevelObject< VectorType > &src) const |
void | set_component_to_block_map (const std::vector< unsigned int > &map) |
void | print_indices (std::ostream &os) const |
virtual void | prolongate_and_add (const unsigned int to_level, VectorType &dst, const VectorType &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 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 & | ExcNoProlongation () |
static ::ExceptionBase & | ExcMatricesNotBuilt () |
static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Protected Member Functions | |
template<int dim, int spacedim> | |
void | fill_and_communicate_copy_indices (const DoFHandler< dim, spacedim > &dof_handler) |
Protected Attributes | |
std::vector< types::global_dof_index > | sizes |
std::vector< std::vector< std::pair< types::global_dof_index, types::global_dof_index > > > | copy_indices |
std::vector< std::vector< std::pair< types::global_dof_index, types::global_dof_index > > > | copy_indices_global_mine |
std::vector< std::vector< std::pair< types::global_dof_index, types::global_dof_index > > > | copy_indices_level_mine |
bool | perform_plain_copy |
std::vector< unsigned int > | component_to_block_map |
ObserverPointer< const MGConstrainedDoFs > | mg_constrained_dofs |
Private Types | |
using | map_value_type = decltype(counter_map)::value_type |
using | map_iterator = decltype(counter_map)::iterator |
Private Member Functions | |
template<int dim, int spacedim> | |
void | assert_built (const DoFHandler< dim, spacedim > &dof_handler) const |
void | check_no_subscribers () const noexcept |
Private Attributes | |
std::vector< std::shared_ptr< typename internal::MatrixSelector< VectorType >::Sparsity > > | prolongation_sparsities |
std::vector< std::shared_ptr< typename internal::MatrixSelector< VectorType >::Matrix > > | prolongation_matrices |
std::vector< std::vector< bool > > | interface_dofs |
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 |
Implementation of the MGTransferBase interface for which the transfer operations are prebuilt upon construction of the object of this class as matrices. This is the fast way, since it only needs to build the operation once by looping over all cells and storing the result in a matrix for each level, but requires additional memory.
See MGTransferBase to find out which of the transfer classes is best for your needs.
Definition at line 628 of file mg_transfer.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.
|
default |
Constructor without constraint matrices. Use this constructor only with discontinuous finite elements or with no local refinement.
MGTransferPrebuilt< VectorType >::MGTransferPrebuilt | ( | const MGConstrainedDoFs & | mg_constrained_dofs | ) |
Constructor with constraints. Equivalent to the default constructor followed by initialize_constraints().
Definition at line 48 of file mg_transfer_prebuilt.cc.
|
overridevirtualdefault |
Destructor.
void MGTransferPrebuilt< VectorType >::initialize_constraints | ( | const MGConstrainedDoFs & | mg_constrained_dofs | ) |
Initialize the constraints to be used in build().
Definition at line 58 of file mg_transfer_prebuilt.cc.
void MGTransferPrebuilt< VectorType >::clear | ( | ) |
Reset the object to the state it had right after the default constructor.
Definition at line 68 of file mg_transfer_prebuilt.cc.
void MGTransferPrebuilt< VectorType >::build | ( | const DoFHandler< dim, spacedim > & | dof_handler | ) |
Actually build the information required for the transfer operations. Needs to be called before prolongate() or restrict_and_add() can be used.
Definition at line 151 of file mg_transfer_prebuilt.cc.
|
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.
Implements MGTransferBase< VectorType >.
Definition at line 80 of file mg_transfer_prebuilt.cc.
|
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.
Implements MGTransferBase< VectorType >.
Definition at line 107 of file mg_transfer_prebuilt.cc.
std::size_t MGTransferPrebuilt< VectorType >::memory_consumption | ( | ) | const |
Memory used by this object.
Definition at line 358 of file mg_transfer_prebuilt.cc.
void MGTransferPrebuilt< VectorType >::print_matrices | ( | std::ostream & | os | ) | const |
Print all the matrices for debugging purposes.
Definition at line 344 of file mg_transfer_prebuilt.cc.
|
inherited |
Transfer from a vector on the global grid to vectors defined on each of the levels separately for the 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.
|
inherited |
Transfer from multi-level vector to normal vector.
Copies data from active portions of an MGVector into the respective positions of a Vector<number>
. In order to keep the result consistent, constrained degrees of freedom are set to zero.
|
inherited |
Add a multi-level vector to a normal vector.
Works as the previous function, but probably not for continuous elements.
|
inherited |
If this object operates on BlockVector objects, we need to describe how the individual vector components are mapped to the blocks of a vector. For example, for a Stokes system, we have dim+1 vector components for velocity and pressure, but we may want to use block vectors with only two blocks for all velocities in one block, and the pressure variables in the other.
By default, if this function is not called, block vectors have as many blocks as the finite element has vector components. However, this can be changed by calling this function with an array that describes how vector components are to be grouped into blocks. The meaning of the argument is the same as the one given to the DoFTools::count_dofs_per_component function.
|
inherited |
Print the copy index fields for debugging purposes.
Definition at line 114 of file mg_level_global_transfer.cc.
|
protectedinherited |
Internal function to fill
copy_indices*. Called by derived classes.
Definition at line 50 of file mg_level_global_transfer.cc.
|
privateinherited |
This function is called to make sure that build() has been invoked.
|
virtualinherited |
Prolongate a vector from level to_level-1
to level to_level
, summing into the previous content of dst
.
Reimplemented in MGTransferBlockMatrixFreeBase< dim, Number, TransferType >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMF< dim, Number > >, and MGTransferMF< dim, Number >.
Definition at line 45 of file mg_base.cc.
|
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.
|
private |
Sparsity patterns for transfer matrices.
Definition at line 732 of file mg_transfer.h.
|
private |
The actual prolongation matrix. column indices belong to the dof indices of the mother cell, i.e. the coarse level. while row indices belong to the child cell, i.e. the fine level.
Definition at line 741 of file mg_transfer.h.
|
private |
Degrees of freedom on the refinement edge excluding those on the boundary.
Definition at line 747 of file mg_transfer.h.
|
protectedinherited |
Sizes of the multi-level vectors.
Definition at line 337 of file mg_transfer.h.
|
protectedinherited |
Mapping for the copy_to_mg() and copy_from_mg() functions. Here only index pairs locally owned
The data is organized as follows: one vector per level. Each element of these vectors contains first the global index, then the level index.
Definition at line 348 of file mg_transfer.h.
|
protectedinherited |
Additional degrees of freedom for the copy_to_mg() function. These are the ones where the global degree of freedom is locally owned and the level degree of freedom is not.
Organization of the data is like for copy_indices_mine
.
Definition at line 359 of file mg_transfer.h.
|
protectedinherited |
Additional degrees of freedom for the copy_from_mg() function. These are the ones where the level degree of freedom is locally owned and the global degree of freedom is not.
Organization of the data is like for copy_indices_mine
.
Definition at line 370 of file mg_transfer.h.
|
protectedinherited |
This variable stores whether the copy operation from the global to the level vector is actually a plain copy to the finest level. This means that the grid has no adaptive refinement and the numbering on the finest multigrid level is the same as in the global case.
Definition at line 378 of file mg_transfer.h.
|
protectedinherited |
The vector that stores what has been given to the set_component_to_block_map() function.
Definition at line 384 of file mg_transfer.h.
|
protectedinherited |
The mg_constrained_dofs of the level systems.
Definition at line 389 of file mg_transfer.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.