Reference documentation for deal.II version GIT c415589cf0 2022-08-14 18:50:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
MGTransferGlobalCoarsening< dim, VectorType > Class Template Reference

#include <deal.II/multigrid/mg_transfer_global_coarsening.h>

Inheritance diagram for MGTransferGlobalCoarsening< dim, VectorType >:
[legend]

Public Types

using Number = typename VectorType::value_type
 

Public Member Functions

 MGTransferGlobalCoarsening (const MGLevelObject< MGTwoLevelTransfer< dim, VectorType >> &transfer, const std::function< void(const unsigned int, VectorType &)> &initialize_dof_vector={})
 
void build (const std::vector< std::shared_ptr< const Utilities::MPI::Partitioner >> &external_partitioners={})
 
void build (const std::function< void(const unsigned int, VectorType &)> &initialize_dof_vector)
 
void prolongate (const unsigned int to_level, VectorType &dst, const VectorType &src) const override
 
void prolongate_and_add (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
 
template<class InVector , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< VectorType > &dst, const InVector &src) const
 
template<class OutVector , int spacedim>
void copy_from_mg (const DoFHandler< dim, spacedim > &dof_handler, OutVector &dst, const MGLevelObject< VectorType > &src) const
 
template<class InVector >
void interpolate_to_mg (MGLevelObject< VectorType > &dst, const InVector &src) const
 
template<class InVector , int spacedim>
void interpolate_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< VectorType > &dst, const InVector &src) const
 
std::size_t memory_consumption () const
 
unsigned int min_level () const
 
unsigned int max_level () 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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Private Types

using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 

Private Member Functions

void initialize_dof_vector (const unsigned int level, VectorType &vector) const
 
void check_no_subscribers () const noexcept
 

Private Attributes

MGLevelObject< MGTwoLevelTransfer< dim, VectorType > > transfer
 
std::vector< std::shared_ptr< const Utilities::MPI::Partitioner > > external_partitioners
 
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
 

Detailed Description

template<int dim, typename VectorType>
class MGTransferGlobalCoarsening< dim, VectorType >

Implementation of the MGTransferBase. In contrast to other multigrid transfer operators, the user can provide separate transfer operators of type MGTwoLevelTransfer between each level.

This class currently only works for the tensor-product finite elements FE_Q and FE_DGQ and simplex elements FE_SimplexP and FE_SimplexDGP as well as for systems involving multiple components of one of these elements. Other elements are currently not implemented.

The implementation of this class is explained in detail in [120].

Definition at line 481 of file mg_transfer_global_coarsening.h.

Member Typedef Documentation

◆ Number

template<int dim, typename VectorType >
using MGTransferGlobalCoarsening< dim, VectorType >::Number = typename VectorType::value_type

Value type.

Definition at line 487 of file mg_transfer_global_coarsening.h.

◆ map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 230 of file subscriptor.h.

◆ map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 235 of file subscriptor.h.

Constructor & Destructor Documentation

◆ MGTransferGlobalCoarsening()

template<int dim, typename VectorType >
MGTransferGlobalCoarsening< dim, VectorType >::MGTransferGlobalCoarsening ( const MGLevelObject< MGTwoLevelTransfer< dim, VectorType >> &  transfer,
const std::function< void(const unsigned int, VectorType &)> &  initialize_dof_vector = {} 
)

Constructor taking a collection of transfer operators (with the coarsest level kept empty in transfer) and an optional function that initializes the internal level vectors within the function call copy_to_mg() if used in the context of PreconditionMG.

Member Function Documentation

◆ build() [1/2]

template<int dim, typename VectorType >
void MGTransferGlobalCoarsening< dim, VectorType >::build ( const std::vector< std::shared_ptr< const Utilities::MPI::Partitioner >> &  external_partitioners = {})

Similar function to MGTransferMatrixFree::build() with the difference that the information for the prolongation for each level has already been built. So this function only tries to optimize the data structures of the two-level transfer operators, e.g., by enabling inplace vector operations, by checking if external_partitioners and the internal ones are compatible.

◆ build() [2/2]

template<int dim, typename VectorType >
void MGTransferGlobalCoarsening< dim, VectorType >::build ( const std::function< void(const unsigned int, VectorType &)> &  initialize_dof_vector)

Same as above but taking a lambda for initializing vector instead of partitioners.

◆ prolongate()

template<int dim, typename VectorType >
void MGTransferGlobalCoarsening< dim, VectorType >::prolongate ( const unsigned int  to_level,
VectorType &  dst,
const VectorType &  src 
) const
overridevirtual

Perform prolongation.

Implements MGTransferBase< VectorType >.

◆ prolongate_and_add()

template<int dim, typename VectorType >
void MGTransferGlobalCoarsening< dim, VectorType >::prolongate_and_add ( const unsigned int  to_level,
VectorType &  dst,
const VectorType &  src 
) const
overridevirtual

Perform prolongation.

Reimplemented from MGTransferBase< VectorType >.

◆ restrict_and_add()

template<int dim, typename VectorType >
virtual void MGTransferGlobalCoarsening< dim, VectorType >::restrict_and_add ( const unsigned int  from_level,
VectorType &  dst,
const VectorType &  src 
) const
overridevirtual

Perform restriction.

Implements MGTransferBase< VectorType >.

◆ copy_to_mg()

template<int dim, typename VectorType >
template<class InVector , int spacedim>
void MGTransferGlobalCoarsening< dim, VectorType >::copy_to_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
MGLevelObject< VectorType > &  dst,
const InVector &  src 
) const

Initialize internal vectors and copy src vector to the finest multigrid level.

Note
DoFHandler is not needed here, but is required by the interface.

◆ copy_from_mg()

template<int dim, typename VectorType >
template<class OutVector , int spacedim>
void MGTransferGlobalCoarsening< dim, VectorType >::copy_from_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
OutVector &  dst,
const MGLevelObject< VectorType > &  src 
) const

Initialize internal vectors and copy the values on the finest multigrid level to dst vector.

Note
DoFHandler is not needed here, but is required by the interface.

◆ interpolate_to_mg() [1/2]

template<int dim, typename VectorType >
template<class InVector >
void MGTransferGlobalCoarsening< dim, VectorType >::interpolate_to_mg ( MGLevelObject< VectorType > &  dst,
const InVector &  src 
) const

Interpolate fine-mesh field src to each multigrid level in dof_handler and store the result in dst. This function is different from restriction, where a weighted residual is transferred to a coarser level (transposition of prolongation matrix).

The argument dst has to be initialized with the correct size according to the number of levels of the triangulation.

If an inner vector of dst is empty or has incorrect locally owned size, it will be resized to locally relevant degrees of freedom on each level.

◆ interpolate_to_mg() [2/2]

template<int dim, typename VectorType >
template<class InVector , int spacedim>
void MGTransferGlobalCoarsening< dim, VectorType >::interpolate_to_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
MGLevelObject< VectorType > &  dst,
const InVector &  src 
) const

Like the above function but with a user-provided DoFHandler as additional argument. However, this DoFHandler is not used internally, but is required to be able to use MGTransferGlobalCoarsening and MGTransferMatrixFree as template argument.

◆ memory_consumption()

template<int dim, typename VectorType >
std::size_t MGTransferGlobalCoarsening< dim, VectorType >::memory_consumption ( ) const

Return the memory consumption of the allocated memory in this class.

Note
Counts also the memory consumption of the underlying two-level transfer operators.

◆ min_level()

template<int dim, typename VectorType >
unsigned int MGTransferGlobalCoarsening< dim, VectorType >::min_level ( ) const

Minimum level.

◆ max_level()

template<int dim, typename VectorType >
unsigned int MGTransferGlobalCoarsening< dim, VectorType >::max_level ( ) const

Maximum level.

◆ initialize_dof_vector()

template<int dim, typename VectorType >
void MGTransferGlobalCoarsening< dim, VectorType >::initialize_dof_vector ( const unsigned int  level,
VectorType &  vector 
) const
private

Function to initialize internal level vectors.

◆ subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
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 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const
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.

◆ list_subscribers() [1/2]

template<typename StreamType >
void Subscriptor::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

template<class Archive >
void Subscriptor::serialize ( Archive &  ar,
const unsigned int  version 
)
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.

◆ check_no_subscribers()

void Subscriptor::check_no_subscribers ( ) const
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.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file subscriptor.cc.

Member Data Documentation

◆ transfer

template<int dim, typename VectorType >
MGLevelObject<MGTwoLevelTransfer<dim, VectorType> > MGTransferGlobalCoarsening< dim, VectorType >::transfer
private

Collection of the two-level transfer operators.

Definition at line 628 of file mg_transfer_global_coarsening.h.

◆ external_partitioners

template<int dim, typename VectorType >
std::vector<std::shared_ptr<const Utilities::MPI::Partitioner> > MGTransferGlobalCoarsening< dim, VectorType >::external_partitioners
private

External partitioners used during initialize_dof_vector().

Definition at line 634 of file mg_transfer_global_coarsening.h.

◆ counter

std::atomic<unsigned int> Subscriptor::counter
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.

◆ counter_map

std::map<std::string, unsigned int> Subscriptor::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 225 of file subscriptor.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> Subscriptor::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 241 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::object_info
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.

◆ mutex

std::mutex Subscriptor::mutex
staticprivateinherited

A mutex used to ensure data consistency when printing out the list of subscribers.

Definition at line 271 of file subscriptor.h.


The documentation for this class was generated from the following file: