Reference documentation for deal.II version 9.4.1
\(\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\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
MGTransferBlockSelect< number > Class Template Reference

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

Inheritance diagram for MGTransferBlockSelect< number >:
[legend]

Public Member Functions

 MGTransferBlockSelect ()
 
 MGTransferBlockSelect (const MGConstrainedDoFs &mg_constrained_dofs)
 
virtual ~MGTransferBlockSelect () override=default
 
template<int dim, int spacedim>
void build (const DoFHandler< dim, spacedim > &dof_handler, unsigned int selected)
 
void select (const unsigned int block)
 
virtual void prolongate (const unsigned int to_level, Vector< number > &dst, const Vector< number > &src) const override
 
virtual void restrict_and_add (const unsigned int from_level, Vector< number > &dst, const Vector< number > &src) const override
 
template<int dim, typename number2 , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< Vector< number > > &dst, const Vector< number2 > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_from_mg (const DoFHandler< dim, spacedim > &dof_handler, Vector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_from_mg_add (const DoFHandler< dim, spacedim > &dof_handler, Vector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< Vector< number > > &dst, const BlockVector< number2 > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_from_mg (const DoFHandler< dim, spacedim > &dof_handler, BlockVector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const
 
template<int dim, typename number2 , int spacedim>
void copy_from_mg_add (const DoFHandler< dim, spacedim > &dof_handler, BlockVector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const
 
std::size_t memory_consumption () const
 
virtual void prolongate_and_add (const unsigned int to_level, Vector< number > &dst, const Vector< number > &src) const
 

Private Member Functions

template<int dim, class OutVector , int spacedim>
void do_copy_from_mg (const DoFHandler< dim, spacedim > &dof_handler, OutVector &dst, const MGLevelObject< Vector< number > > &src, const unsigned int offset) const
 
template<int dim, class OutVector , int spacedim>
void do_copy_from_mg_add (const DoFHandler< dim, spacedim > &dof_handler, OutVector &dst, const MGLevelObject< Vector< number > > &src, const unsigned int offset) const
 
template<int dim, class InVector , int spacedim>
void do_copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< Vector< number > > &dst, const InVector &src, const unsigned int offset) const
 
template<int dim, int spacedim>
void build (const DoFHandler< dim, spacedim > &dof_handler)
 

Static Private Member Functions

static ::ExceptionBase & ExcMatricesNotBuilt ()
 

Private Attributes

unsigned int selected_block
 
std::vector< bool > selected
 
unsigned int n_mg_blocks
 
std::vector< unsigned int > mg_block
 
std::vector< std::vector< types::global_dof_index > > sizes
 
std::vector< types::global_dof_index > block_start
 
std::vector< std::vector< types::global_dof_index > > mg_block_start
 
std::vector< std::shared_ptr< BlockSparsityPattern > > prolongation_sparsities
 
std::vector< std::shared_ptr< BlockSparseMatrix< double > > > prolongation_matrices
 
std::vector< std::vector< std::vector< std::pair< unsigned int, unsigned int > > > > copy_indices
 
SmartPointer< const MGConstrainedDoFs, MGTransferBlockBase > mg_constrained_dofs
 

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)
 
void check_no_subscribers () const noexcept
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBase & ExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBase & ExcNoSubscriber (std::string arg1, std::string arg2)
 

Detailed Description

template<typename number>
class MGTransferBlockSelect< number >

Implementation of the MGTransferBase interface for block matrices and simple vectors. This class uses MGTransferBlockBase selecting a single block. The intergrid transfer operators are implemented for Vector objects, The copy functions between regular and multigrid vectors for Vector and BlockVector.

See MGTransferBase to find out which of the transfer classes is best for your needs.

Definition at line 296 of file mg_transfer_block.h.

Constructor & Destructor Documentation

◆ MGTransferBlockSelect() [1/2]

template<typename number >
MGTransferBlockSelect< number >::MGTransferBlockSelect

Constructor without constraint matrices. Use this constructor only with discontinuous finite elements or with no local refinement.

Definition at line 249 of file multigrid.cc.

◆ MGTransferBlockSelect() [2/2]

template<typename number >
MGTransferBlockSelect< number >::MGTransferBlockSelect ( const MGConstrainedDoFs &  mg_constrained_dofs)

Constructor with constraint matrices as well as mg_constrained_dofs.

Definition at line 256 of file multigrid.cc.

◆ ~MGTransferBlockSelect()

template<typename number >
virtual MGTransferBlockSelect< number >::~MGTransferBlockSelect ( )
overridevirtualdefault

Destructor.

Member Function Documentation

◆ build() [1/2]

template<typename number >
template<int dim, int spacedim>
void MGTransferBlockSelect< number >::build ( const DoFHandler< dim, spacedim > &  dof_handler,
unsigned int  selected 
)

Actually build the prolongation matrices for grouped blocks.

This function is a front-end for the same function in MGTransferBlockBase.

Parameters
dof_handlerThe DoFHandler to use.
selectedNumber of the block for which the transfer matrices should be built.

Definition at line 472 of file mg_transfer_block.cc.

◆ select()

template<typename number >
void MGTransferBlockSelect< number >::select ( const unsigned int  block)
inline

Change selected block. Handle with care!

Definition at line 464 of file mg_transfer_block.h.

◆ prolongate()

template<typename number >
void MGTransferBlockSelect< number >::prolongate ( const unsigned int  to_level,
Vector< number > &  dst,
const Vector< number > &  src 
) const
overridevirtual

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.

Implements MGTransferBase< Vector< number > >.

Definition at line 266 of file multigrid.cc.

◆ restrict_and_add()

template<typename number >
void MGTransferBlockSelect< number >::restrict_and_add ( const unsigned int  from_level,
Vector< number > &  dst,
const Vector< number > &  src 
) const
overridevirtual

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.

Implements MGTransferBase< Vector< number > >.

Definition at line 289 of file multigrid.cc.

◆ copy_to_mg() [1/2]

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_to_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
MGLevelObject< Vector< number > > &  dst,
const Vector< number2 > &  src 
) const

Transfer a single block from a vector on the global grid to a multilevel vector for the 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.

Definition at line 158 of file mg_transfer_block.cc.

◆ copy_from_mg() [1/2]

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_from_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
Vector< number2 > &  dst,
const MGLevelObject< Vector< number > > &  src 
) const

Transfer from multilevel vector to normal vector.

Copies data from active portions of an multilevel vector into the respective positions of a Vector.

◆ copy_from_mg_add() [1/2]

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_from_mg_add ( const DoFHandler< dim, spacedim > &  dof_handler,
Vector< number2 > &  dst,
const MGLevelObject< Vector< number > > &  src 
) const

Add a multi-level vector to a normal vector.

Works as the previous function, but probably not for continuous elements.

◆ copy_to_mg() [2/2]

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_to_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
MGLevelObject< Vector< number > > &  dst,
const BlockVector< number2 > &  src 
) const

Transfer a block from a vector on the global grid to multilevel vectors. Only the values for the active degrees of freedom of the block selected are transferred. 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.

Definition at line 132 of file mg_transfer_block.cc.

◆ copy_from_mg() [2/2]

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_from_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
BlockVector< number2 > &  dst,
const MGLevelObject< Vector< number > > &  src 
) const

Transfer from multilevel vector to normal vector.

Copies data from active portions of a multilevel vector into the respective positions of a global BlockVector.

◆ copy_from_mg_add() [2/2]

template<typename number >
template<int dim, typename number2 , int spacedim>
void MGTransferBlockSelect< number >::copy_from_mg_add ( const DoFHandler< dim, spacedim > &  dof_handler,
BlockVector< number2 > &  dst,
const MGLevelObject< Vector< number > > &  src 
) const

Add a multi-level vector to a normal vector.

Works as the previous function, but probably not for continuous elements.

◆ memory_consumption()

template<typename number >
std::size_t MGTransferBlockSelect< number >::memory_consumption ( ) const

Memory used by this object.

◆ do_copy_from_mg()

template<typename number >
template<int dim, class OutVector , int spacedim>
void MGTransferBlockSelect< number >::do_copy_from_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
OutVector &  dst,
const MGLevelObject< Vector< number > > &  src,
const unsigned int  offset 
) const
private

Implementation of the public function.

◆ do_copy_from_mg_add()

template<typename number >
template<int dim, class OutVector , int spacedim>
void MGTransferBlockSelect< number >::do_copy_from_mg_add ( const DoFHandler< dim, spacedim > &  dof_handler,
OutVector &  dst,
const MGLevelObject< Vector< number > > &  src,
const unsigned int  offset 
) const
private

Implementation of the public function.

◆ do_copy_to_mg()

template<typename number >
template<int dim, class InVector , int spacedim>
void MGTransferBlockSelect< number >::do_copy_to_mg ( const DoFHandler< dim, spacedim > &  dof_handler,
MGLevelObject< Vector< number > > &  dst,
const InVector &  src,
const unsigned int  offset 
) const
private

Actual implementation of copy_to_mg().

◆ prolongate_and_add()

void MGTransferBase< Vector< number > >::prolongate_and_add ( const unsigned int  to_level,
Vector< number > &  dst,
const Vector< number > &  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.

◆ build() [2/2]

template<int dim, int spacedim>
void MGTransferBlockBase::build ( const DoFHandler< dim, spacedim > &  dof_handler)
protectedinherited

Actually build the prolongation matrices for each level.

This function is only called by derived classes. These can also set the member variables selected and others to restrict the transfer matrices to certain blocks.

Definition at line 207 of file mg_transfer_block.cc.

Member Data Documentation

◆ selected_block

template<typename number >
unsigned int MGTransferBlockSelect< number >::selected_block
private

Selected block.

Definition at line 456 of file mg_transfer_block.h.

◆ selected

std::vector<bool> MGTransferBlockBase::selected
protectedinherited

Flag of selected blocks.

The transfer operators only act on the blocks having a true entry here.

Definition at line 100 of file mg_transfer_block.h.

◆ n_mg_blocks

unsigned int MGTransferBlockBase::n_mg_blocks
protectedinherited

Number of blocks of multigrid vector.

Definition at line 105 of file mg_transfer_block.h.

◆ mg_block

std::vector<unsigned int> MGTransferBlockBase::mg_block
protectedinherited

For each block of the whole block vector, list to what block of the multigrid vector it is mapped. Since depending on selected, there may be fewer multilevel blocks than original blocks, some of the entries may be illegal unsigned integers.

Definition at line 115 of file mg_transfer_block.h.

◆ sizes

std::vector<std::vector<types::global_dof_index> > MGTransferBlockBase::sizes
mutableprotectedinherited

Sizes of the multi-level vectors.

Definition at line 120 of file mg_transfer_block.h.

◆ block_start

std::vector<types::global_dof_index> MGTransferBlockBase::block_start
protectedinherited

Start index of each block.

Definition at line 125 of file mg_transfer_block.h.

◆ mg_block_start

std::vector<std::vector<types::global_dof_index> > MGTransferBlockBase::mg_block_start
protectedinherited

Start index of each block on all levels.

Definition at line 130 of file mg_transfer_block.h.

◆ prolongation_sparsities

std::vector<std::shared_ptr<BlockSparsityPattern> > MGTransferBlockBase::prolongation_sparsities
privateinherited

Definition at line 138 of file mg_transfer_block.h.

◆ prolongation_matrices

std::vector<std::shared_ptr<BlockSparseMatrix<double> > > MGTransferBlockBase::prolongation_matrices
protectedinherited

The actual prolongation matrix. column indices belong to the dof indices of the mother cell, i.e. the coarse level. while row indices belong to the child cell, i.e. the fine level.

Definition at line 146 of file mg_transfer_block.h.

◆ copy_indices

std::vector<std::vector<std::vector<std::pair<unsigned int, unsigned int> > > > MGTransferBlockBase::copy_indices
protectedinherited

Mapping for the copy_to/from_mg-functions. The indices into this vector are (in this order): global block number, level number. The data is first the global index inside the block, then the level index inside the block.

Definition at line 155 of file mg_transfer_block.h.

◆ mg_constrained_dofs

SmartPointer<const MGConstrainedDoFs, MGTransferBlockBase> MGTransferBlockBase::mg_constrained_dofs
protectedinherited

The mg_constrained_dofs of the level systems.

Definition at line 162 of file mg_transfer_block.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.5