Reference documentation for deal.II version 9.3.0
\(\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 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 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
 
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 , int spacedim>
void interpolate_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< VectorType > &dst, const InVector &src) 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 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 Attributes

const MGLevelObject< MGTwoLevelTransfer< dim, VectorType > > & transfer
 
const std::function< void(const unsigned int, VectorType &)> initialize_dof_vector
 

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 tensor-product finite elements based on FE_Q and FE_DGQ elements. Systems involving multiple components of one of these element, as well as, systems with different elements or other elements are currently not implemented.

Definition at line 380 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 386 of file mg_transfer_global_coarsening.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

◆ 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 >.

◆ 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()

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

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.

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

◆ prolongate_and_add()

template<typename VectorType>
void MGTransferBase< VectorType >::prolongate_and_add ( const unsigned int  to_level,
VectorType dst,
const VectorType src 
) const
virtualinherited

Prolongate a vector from level to_level-1 to level to_level, summing into the previous content of dst.

  • src is a vector with as many elements as there are degrees of freedom on the coarser level involved.
  • dst has as many elements as there are degrees of freedom on the finer level.

Reimplemented in MGTransferBlockMatrixFree< dim, Number >, and MGTransferMatrixFree< dim, Number >.

Definition at line 47 of file mg_base.cc.

◆ 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 301 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 318 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 310 of file subscriptor.h.

Member Data Documentation

◆ transfer

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

Collection of the two-level transfer operators.

Definition at line 464 of file mg_transfer_global_coarsening.h.

◆ initialize_dof_vector

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

Function to initialize internal level vectors.

Definition at line 470 of file mg_transfer_global_coarsening.h.


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