Reference documentation for deal.II version GIT 6da2e5d553 2022-07-01 18:55: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 Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
MGTransferBlockGlobalCoarsening< dim, VectorType > Class Template Referenceabstract

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

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

Public Member Functions

 MGTransferBlockGlobalCoarsening (const MGTransferGlobalCoarsening< dim, VectorType > &transfer_operator)
 
virtual void prolongate (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< VectorType::value_type > &dst, const LinearAlgebra::distributed::BlockVector< VectorType::value_type > &src) const override
 
virtual void prolongate (const unsigned int to_level, VectorType &dst, const VectorType &src) const =0
 
virtual void prolongate_and_add (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< VectorType::value_type > &dst, const LinearAlgebra::distributed::BlockVector< VectorType::value_type > &src) const override
 
virtual void prolongate_and_add (const unsigned int to_level, VectorType &dst, const VectorType &src) const
 
virtual void restrict_and_add (const unsigned int from_level, LinearAlgebra::distributed::BlockVector< VectorType::value_type > &dst, const LinearAlgebra::distributed::BlockVector< VectorType::value_type > &src) const override
 
virtual void restrict_and_add (const unsigned int from_level, VectorType &dst, const VectorType &src) const =0
 
void copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< VectorType::value_type >> &dst, const BlockVectorType2 &src) const
 
void copy_to_mg (const std::vector< const DoFHandler< dim, spacedim > * > &dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< VectorType::value_type >> &dst, const BlockVectorType2 &src) const
 
void copy_from_mg (const DoFHandler< dim, spacedim > &dof_handler, BlockVectorType2 &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< VectorType::value_type >> &src) const
 
void copy_from_mg (const std::vector< const DoFHandler< dim, spacedim > * > &dof_handler, BlockVectorType2 &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< VectorType::value_type >> &src) const
 

Static Public Attributes

static const bool supports_dof_handler_vector
 

Protected Member Functions

const MGTransferGlobalCoarsening< dim, VectorType > & get_matrix_free_transfer (const unsigned int b) const override
 

Protected Attributes

const bool same_for_all
 

Private Attributes

const MGTransferGlobalCoarsening< dim, VectorType > & transfer_operator
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

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
 
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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

Detailed Description

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

This class works with LinearAlgebra::distributed::BlockVector and performs exactly the same transfer operations for each block as MGTransferGlobalCoarsening.

Definition at line 645 of file mg_transfer_global_coarsening.h.

Constructor & Destructor Documentation

◆ MGTransferBlockGlobalCoarsening()

template<int dim, typename VectorType >
MGTransferBlockGlobalCoarsening< dim, VectorType >::MGTransferBlockGlobalCoarsening ( const MGTransferGlobalCoarsening< dim, VectorType > &  transfer_operator)

Constructor.

Member Function Documentation

◆ get_matrix_free_transfer()

template<int dim, typename VectorType >
const MGTransferGlobalCoarsening<dim, VectorType>& MGTransferBlockGlobalCoarsening< dim, VectorType >::get_matrix_free_transfer ( const unsigned int  b) const
overrideprotectedvirtual

Return the right non-block transfer operator. Has to be implemented by the derived class.

Implements MGTransferBlockMatrixFreeBase< dim, VectorType::value_type, MGTransferGlobalCoarsening< dim, VectorType > >.

◆ prolongate() [1/2]

virtual void MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::prolongate ( const unsigned int  to_level,
LinearAlgebra::distributed::BlockVector< VectorType::value_type > &  dst,
const LinearAlgebra::distributed::BlockVector< VectorType::value_type > &  src 
) const
overridevirtualinherited

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.

Parameters
to_levelThe index of the level to prolongate to, which is the level of dst.
srcis a vector with as many elements as there are degrees of freedom on the coarser level involved.
dsthas as many elements as there are degrees of freedom on the finer level.

◆ prolongate() [2/2]

template<typename VectorType >
virtual void MGTransferBase< VectorType >::prolongate ( const unsigned int  to_level,
VectorType &  dst,
const VectorType &  src 
) const
pure virtualinherited

Prolongate a vector from level to_level-1 to level to_level. The previous content of dst is overwritten.

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

Implemented in MGTransferGlobalCoarsening< dim, VectorType >, MGTransferPrebuilt< VectorType >, MGTransferSelect< number >, MGTransferBlockSelect< number >, MGTransferMatrixFree< dim, Number >, MGTransferBlockMatrixFreeBase< dim, Number, TransferType >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >, and MGTransferBlock< number >.

◆ prolongate_and_add() [1/2]

virtual void MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::prolongate_and_add ( const unsigned int  to_level,
LinearAlgebra::distributed::BlockVector< VectorType::value_type > &  dst,
const LinearAlgebra::distributed::BlockVector< VectorType::value_type > &  src 
) const
overridevirtualinherited

◆ prolongate_and_add() [2/2]

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 MGTransferGlobalCoarsening< dim, VectorType >.

Definition at line 47 of file mg_base.cc.

◆ restrict_and_add() [1/2]

virtual void MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::restrict_and_add ( const unsigned int  from_level,
LinearAlgebra::distributed::BlockVector< VectorType::value_type > &  dst,
const LinearAlgebra::distributed::BlockVector< VectorType::value_type > &  src 
) const
overridevirtualinherited

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.

Parameters
from_levelThe index of the level to restrict from, which is the level of src.
srcis a vector with as many elements as there are degrees of freedom on the finer level involved.
dsthas as many elements as there are degrees of freedom on the coarser level.

◆ restrict_and_add() [2/2]

template<typename VectorType >
virtual void MGTransferBase< VectorType >::restrict_and_add ( const unsigned int  from_level,
VectorType &  dst,
const VectorType &  src 
) const
pure virtualinherited

Restrict a vector from level from_level to level from_level-1 and add this restriction to dst. 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.

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

Implemented in MGTransferGlobalCoarsening< dim, VectorType >, MGTransferPrebuilt< VectorType >, MGTransferSelect< number >, MGTransferBlockSelect< number >, MGTransferMatrixFree< dim, Number >, MGTransferBlockMatrixFreeBase< dim, Number, TransferType >, MGTransferBlockMatrixFreeBase< dim, Number, MGTransferMatrixFree< dim, Number > >, and MGTransferBlock< number >.

◆ copy_to_mg() [1/2]

void MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::copy_to_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
MGLevelObject< LinearAlgebra::distributed::BlockVector< VectorType::value_type >> &  dst,
const BlockVectorType2 &  src 
) const
inherited

Transfer from a block-vector on the global grid to block-vectors defined on each of the levels separately for 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.

This function will initialize dst accordingly if needed as required by the Multigrid class.

◆ copy_to_mg() [2/2]

void MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::copy_to_mg ( const std::vector< const DoFHandler< dim, spacedim > * > &  dof_handler,
MGLevelObject< LinearAlgebra::distributed::BlockVector< VectorType::value_type >> &  dst,
const BlockVectorType2 &  src 
) const
inherited

Same as above for the case that each block has its own DoFHandler.

◆ copy_from_mg() [1/2]

void MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::copy_from_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
BlockVectorType2 &  dst,
const MGLevelObject< LinearAlgebra::distributed::BlockVector< VectorType::value_type >> &  src 
) const
inherited

Transfer from multi-level block-vector to normal vector.

◆ copy_from_mg() [2/2]

void MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::copy_from_mg ( const std::vector< const DoFHandler< dim, spacedim > * > &  dof_handler,
BlockVectorType2 &  dst,
const MGLevelObject< LinearAlgebra::distributed::BlockVector< VectorType::value_type >> &  src 
) const
inherited

Same as above for the case that each block has its own DoFHandler.

Member Data Documentation

◆ transfer_operator

template<int dim, typename VectorType >
const MGTransferGlobalCoarsening<dim, VectorType>& MGTransferBlockGlobalCoarsening< dim, VectorType >::transfer_operator
private

Non-block version of transfer operation.

Definition at line 666 of file mg_transfer_global_coarsening.h.

◆ supports_dof_handler_vector

const bool MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::supports_dof_handler_vector
staticinherited

This class can both be used with a single DoFHandler or a separate DoFHandler for each block.

Definition at line 431 of file mg_transfer_matrix_free.h.

◆ same_for_all

const bool MGTransferBlockMatrixFreeBase< dim, VectorType::value_type , MGTransferGlobalCoarsening< dim, VectorType > >::same_for_all
protectedinherited

A flag to indicate whether the same DoFHandler is used for all the components or if each block has its own DoFHandler.

Definition at line 445 of file mg_transfer_matrix_free.h.


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