Reference documentation for deal.II version GIT relicensing-478-g3275795167 2024-04-24 07:10:02+00:00
|
#include <deal.II/multigrid/mg_transfer_global_coarsening.h>
Classes | |
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 | interpolate (VectorType &dst, const VectorType &src) const override |
void | 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 |
void | prolongate_and_add (VectorType &dst, const VectorType &src) const |
void | restrict_and_add (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 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 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 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::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::vector< Number > | weights |
AlignedVector< VectorizedArrayType > | weights_compressed |
unsigned int | n_components |
SmartPointer< 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 |
Friends | |
class | internal::MGTwoLevelTransferImplementation |
class | MGTransferMF< dim, Number > |
Class for transfer between two multigrid levels for p- or global coarsening.
The implementation of this class is explained in detail in [153].
Definition at line 406 of file mg_transfer_global_coarsening.h.
using MGTwoLevelTransfer< dim, VectorType >::Number = typename VectorType::value_type |
The scalar type used by the vector-type template argument.
Definition at line 419 of file mg_transfer_global_coarsening.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 425 of file mg_transfer_global_coarsening.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.
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
). The transfer can be only performed on active levels.
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 transfer operator between the given DoFHandler objects ( dof_handler_fine
and dof_handler_coarse
). Depending on the underlying Triangulation objects polynomial or geometrical global coarsening is performed.
numbers::invalid_unsigned_int
), polynomial transfers can also be performed on coarse-grid levels, i.e., levels without hanging nodes.
|
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< VectorType >.
|
overridevirtual |
Enable inplace vector operations if external and internal vectors are compatible.
Implements MGTwoLevelTransferBase< VectorType >.
|
overridevirtual |
Return the memory consumption of the allocated memory in this class.
Implements MGTwoLevelTransferBase< VectorType >.
|
overrideprotected |
|
overrideprotected |
|
inherited |
Perform prolongation on a solution vector.
|
inherited |
Perform restriction on a residual vector.
|
protectedpure virtualinherited |
Perform prolongation on vectors with correct ghosting.
|
protectedpure virtualinherited |
Perform restriction on vectors with correct ghosting.
|
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.
|
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.
|
friend |
Definition at line 646 of file mg_transfer_global_coarsening.h.
|
friend |
Definition at line 646 of file mg_transfer_global_coarsening.h.
|
private |
Transfer schemes.
Definition at line 603 of file mg_transfer_global_coarsening.h.
|
private |
Helper class for reading from and writing to global coarse vectors and for applying constraints.
Definition at line 611 of file mg_transfer_global_coarsening.h.
|
private |
Helper class for reading from and writing to global fine vectors.
Definition at line 618 of file mg_transfer_global_coarsening.h.
|
private |
Weights for continuous elements.
Definition at line 623 of file mg_transfer_global_coarsening.h.
|
private |
Weights for continuous elements, compressed into 3^dim doubles per cell if possible.
Definition at line 629 of file mg_transfer_global_coarsening.h.
|
private |
Number of components.
Definition at line 634 of file mg_transfer_global_coarsening.h.
|
private |
Pointer to the DoFHandler object used during initialization.
Definition at line 639 of file mg_transfer_global_coarsening.h.
|
private |
Muligird level used during initialization.
Definition at line 644 of file mg_transfer_global_coarsening.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 339 of file mg_transfer_global_coarsening.h.
|
inherited |
Partitioner needed by the intermediate vector.
Definition at line 345 of file mg_transfer_global_coarsening.h.
|
inherited |
Partitioner needed by the intermediate vector.
Definition at line 350 of file mg_transfer_global_coarsening.h.
|
mutableprotectedinherited |
Internal vector on which the actual prolongation/restriction is performed.
Definition at line 356 of file mg_transfer_global_coarsening.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 365 of file mg_transfer_global_coarsening.h.
|
protectedinherited |
Bool indicating whether fine vector has relevant ghost values.
Definition at line 370 of file mg_transfer_global_coarsening.h.
|
protectedinherited |
Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 377 of file mg_transfer_global_coarsening.h.
|
protectedinherited |
Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 383 of file mg_transfer_global_coarsening.h.
|
mutableprotectedinherited |
Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 389 of file mg_transfer_global_coarsening.h.
|
mutableprotectedinherited |
Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.
Definition at line 395 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 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.