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 | List of all members
MGTransferBlockMatrixFreeBase< dim, Number, TransferType > Class Template Referenceabstract

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

Inheritance diagram for MGTransferBlockMatrixFreeBase< dim, Number, TransferType >:
[legend]

Public Member Functions

 MGTransferBlockMatrixFreeBase (const bool same_for_all)
 
virtual void prolongate (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const override
 
virtual void prolongate_and_add (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const override
 
virtual void restrict_and_add (const unsigned int from_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const override
 
template<typename BlockVectorType2 , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &dst, const BlockVectorType2 &src) const
 
template<typename BlockVectorType2 , int spacedim>
void copy_to_mg (const std::vector< const DoFHandler< dim, spacedim > * > &dof_handler, MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &dst, const BlockVectorType2 &src) const
 
template<typename BlockVectorType2 , int spacedim>
void copy_from_mg (const DoFHandler< dim, spacedim > &dof_handler, BlockVectorType2 &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &src) const
 
template<typename BlockVectorType2 , int spacedim>
void copy_from_mg (const std::vector< const DoFHandler< dim, spacedim > * > &dof_handler, BlockVectorType2 &dst, const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &src) const
 
virtual void prolongate_and_add (const unsigned int to_level, LinearAlgebra::distributed::BlockVector< Number > &dst, const LinearAlgebra::distributed::BlockVector< Number > &src) const
 

Static Public Attributes

static const bool supports_dof_handler_vector = true
 

Protected Member Functions

virtual const TransferType & get_matrix_free_transfer (const unsigned int b) const =0
 

Protected Attributes

const bool same_for_all
 

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
 
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
 
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 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 Number, typename TransferType>
class MGTransferBlockMatrixFreeBase< dim, Number, TransferType >

Base class of MGTransferBlockMatrixFree. While MGTransferBlockMatrixFree contains all the setup routines of the transfer operators for the blocks, this class simply applies them, e.g., for restricting and prolongating.

Definition at line 320 of file mg_transfer_matrix_free.h.

Constructor & Destructor Documentation

◆ MGTransferBlockMatrixFreeBase()

template<int dim, typename Number , typename TransferType >
MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::MGTransferBlockMatrixFreeBase ( const bool  same_for_all)
inline

Definition at line 324 of file mg_transfer_matrix_free.h.

Member Function Documentation

◆ prolongate()

template<int dim, typename Number , typename TransferType >
virtual void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::prolongate ( const unsigned int  to_level,
LinearAlgebra::distributed::BlockVector< Number > &  dst,
const LinearAlgebra::distributed::BlockVector< Number > &  src 
) const
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.

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.

Implements MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >.

◆ prolongate_and_add() [1/2]

template<int dim, typename Number , typename TransferType >
virtual void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::prolongate_and_add ( const unsigned int  to_level,
LinearAlgebra::distributed::BlockVector< Number > &  dst,
const LinearAlgebra::distributed::BlockVector< Number > &  src 
) const
overridevirtual

◆ restrict_and_add()

template<int dim, typename Number , typename TransferType >
virtual void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::restrict_and_add ( const unsigned int  from_level,
LinearAlgebra::distributed::BlockVector< Number > &  dst,
const LinearAlgebra::distributed::BlockVector< Number > &  src 
) const
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.

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.

Implements MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >.

◆ copy_to_mg() [1/2]

template<int dim, typename Number , typename TransferType >
template<typename BlockVectorType2 , int spacedim>
void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::copy_to_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &  dst,
const BlockVectorType2 &  src 
) const

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]

template<int dim, typename Number , typename TransferType >
template<typename BlockVectorType2 , int spacedim>
void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::copy_to_mg ( const std::vector< const DoFHandler< dim, spacedim > * > &  dof_handler,
MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &  dst,
const BlockVectorType2 &  src 
) const

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

◆ copy_from_mg() [1/2]

template<int dim, typename Number , typename TransferType >
template<typename BlockVectorType2 , int spacedim>
void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::copy_from_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
BlockVectorType2 &  dst,
const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &  src 
) const

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

◆ copy_from_mg() [2/2]

template<int dim, typename Number , typename TransferType >
template<typename BlockVectorType2 , int spacedim>
void MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::copy_from_mg ( const std::vector< const DoFHandler< dim, spacedim > * > &  dof_handler,
BlockVectorType2 &  dst,
const MGLevelObject< LinearAlgebra::distributed::BlockVector< Number >> &  src 
) const

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

◆ get_matrix_free_transfer()

template<int dim, typename Number , typename TransferType >
virtual const TransferType& MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::get_matrix_free_transfer ( const unsigned int  b) const
protectedpure virtual

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

Implemented in MGTransferBlockMatrixFree< dim, Number >, and MGTransferBlockGlobalCoarsening< dim, VectorType >.

◆ prolongate_and_add() [2/2]

void MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >::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.

Definition at line 205 of file mg_base.cc.

Member Data Documentation

◆ supports_dof_handler_vector

template<int dim, typename Number , typename TransferType >
const bool MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::supports_dof_handler_vector = true
static

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

template<int dim, typename Number , typename TransferType >
const bool MGTransferBlockMatrixFreeBase< dim, Number, TransferType >::same_for_all
protected

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: