Reference documentation for deal.II version 9.3.3
\(\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 | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | List of all members
MGTransferBlockBase Class Reference

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

Inheritance diagram for MGTransferBlockBase:
[legend]

Public Member Functions

 MGTransferBlockBase ()
 
 MGTransferBlockBase (const MGConstrainedDoFs &mg_constrained_dofs)
 
std::size_t memory_consumption () const
 

Protected Member Functions

template<int dim, int spacedim>
void build (const DoFHandler< dim, spacedim > &dof_handler)
 
template<int dim, int spacedim>
void build_matrices (const DoFHandler< dim, spacedim > &dof, const DoFHandler< dim, spacedim > &mg_dof)
 

Static Protected Member Functions

static ::ExceptionBaseExcMatricesNotBuilt ()
 

Protected Attributes

std::vector< boolselected
 
unsigned int n_mg_blocks
 
std::vector< unsigned intmg_block
 
std::vector< std::vector< types::global_dof_index > > sizes
 
std::vector< types::global_dof_indexblock_start
 
std::vector< std::vector< types::global_dof_index > > mg_block_start
 
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, MGTransferBlockBasemg_constrained_dofs
 

Private Attributes

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

Detailed Description

Implementation of matrix generation for MGTransferBlock.

This is the base class for MGTransfer objects for systems of equations where multigrid is applied only to one or some blocks, where a GlossBlock comprises all degrees of freedom generated by one base element.

Definition at line 60 of file mg_transfer_block.h.

Constructor & Destructor Documentation

◆ MGTransferBlockBase() [1/2]

MGTransferBlockBase::MGTransferBlockBase ( )

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

Definition at line 39 of file multigrid.cc.

◆ MGTransferBlockBase() [2/2]

MGTransferBlockBase::MGTransferBlockBase ( const MGConstrainedDoFs mg_constrained_dofs)

Constructor with constraint matrices as well as mg_constrained_dofs.

Definition at line 45 of file multigrid.cc.

Member Function Documentation

◆ memory_consumption()

std::size_t MGTransferBlockBase::memory_consumption ( ) const

Memory used by this object.

Definition at line 174 of file multigrid.cc.

◆ build()

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

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 218 of file mg_transfer_block.cc.

◆ build_matrices()

template<int dim, int spacedim>
void MGTransferBlockBase::build_matrices ( const DoFHandler< dim, spacedim > &  dof,
const DoFHandler< dim, spacedim > &  mg_dof 
)
protected

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.

Deprecated:
Use build() instead.

Definition at line 207 of file mg_transfer_block.cc.

Member Data Documentation

◆ selected

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

Flag of selected blocks.

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

Definition at line 114 of file mg_transfer_block.h.

◆ n_mg_blocks

unsigned int MGTransferBlockBase::n_mg_blocks
protected

Number of blocks of multigrid vector.

Definition at line 119 of file mg_transfer_block.h.

◆ mg_block

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

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 129 of file mg_transfer_block.h.

◆ sizes

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

Sizes of the multi-level vectors.

Definition at line 134 of file mg_transfer_block.h.

◆ block_start

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

Start index of each block.

Definition at line 139 of file mg_transfer_block.h.

◆ mg_block_start

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

Start index of each block on all levels.

Definition at line 144 of file mg_transfer_block.h.

◆ prolongation_sparsities

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

Definition at line 152 of file mg_transfer_block.h.

◆ prolongation_matrices

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

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 160 of file mg_transfer_block.h.

◆ copy_indices

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

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 169 of file mg_transfer_block.h.

◆ mg_constrained_dofs

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

The mg_constrained_dofs of the level systems.

Definition at line 176 of file mg_transfer_block.h.


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