Reference documentation for deal.II version Git 497f915867 2021-09-17 22:46:48 +0200
\(\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 Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
MGTransferBlock< number > Class Template Reference

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

Inheritance diagram for MGTransferBlock< number >:
[legend]

Public Member Functions

 MGTransferBlock ()
 
virtual ~MGTransferBlock () override
 
void initialize (const std::vector< number > &factors, VectorMemory< Vector< number >> &memory)
 
template<int dim, int spacedim>
void build (const DoFHandler< dim, spacedim > &dof_handler, const std::vector< bool > &selected)
 
virtual void prolongate (const unsigned int to_level, BlockVector< number > &dst, const BlockVector< number > &src) const override
 
virtual void restrict_and_add (const unsigned int from_level, BlockVector< number > &dst, const BlockVector< number > &src) const override
 
template<int dim, typename number2 , int spacedim>
void copy_to_mg (const DoFHandler< dim, spacedim > &dof_handler, MGLevelObject< BlockVector< 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< BlockVector< 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< BlockVector< number >> &src) const
 
virtual void prolongate_and_add (const unsigned int to_level, BlockVector< number > &dst, const BlockVector< number > &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 Member Functions

std::size_t memory_consumption () const
 
template<int dim, int spacedim>
void build (const DoFHandler< dim, spacedim > &dof_handler)
 

Static Private Member Functions

static ::ExceptionBaseExcMatricesNotBuilt ()
 

Private Attributes

std::vector< number > factors
 
SmartPointer< VectorMemory< Vector< number > >, MGTransferBlock< number > > memory
 
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
 

Detailed Description

template<typename number>
class MGTransferBlock< number >

Implementation of the MGTransferBase interface for block matrices and block vectors.

Warning
This class is in an untested state. If you use it and you encounter problems, please contact Guido Kanschat.

In addition to the functionality of MGTransferPrebuilt, the operation may be restricted to certain blocks of the vector.

If the restricted mode is chosen, block vectors used in the transfer routines may only have as many blocks as there are trues in the selected-field.

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

Definition at line 183 of file mg_transfer_block.h.

Constructor & Destructor Documentation

◆ MGTransferBlock()

template<typename number >
MGTransferBlock< number >::MGTransferBlock ( )

Default constructor.

Definition at line 53 of file multigrid.cc.

◆ ~MGTransferBlock()

template<typename number >
MGTransferBlock< number >::~MGTransferBlock ( )
overridevirtual

Destructor.

Definition at line 59 of file multigrid.cc.

Member Function Documentation

◆ initialize()

template<typename number >
void MGTransferBlock< number >::initialize ( const std::vector< number > &  factors,
VectorMemory< Vector< number >> &  memory 
)

Initialize additional factors and memory if the restriction of the blocks is to be weighted differently.

Definition at line 68 of file multigrid.cc.

◆ build() [1/2]

template<typename number >
template<int dim, int spacedim>
void MGTransferBlock< number >::build ( const DoFHandler< dim, spacedim > &  dof_handler,
const std::vector< bool > &  selected 
)

Build the prolongation matrices for each level.

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

Definition at line 560 of file mg_transfer_block.cc.

◆ prolongate()

template<typename number >
void MGTransferBlock< number >::prolongate ( const unsigned int  to_level,
BlockVector< number > &  dst,
const BlockVector< 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< BlockVector< number > >.

Definition at line 78 of file multigrid.cc.

◆ restrict_and_add()

template<typename number >
void MGTransferBlock< number >::restrict_and_add ( const unsigned int  from_level,
BlockVector< number > &  dst,
const BlockVector< 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< BlockVector< number > >.

Definition at line 111 of file multigrid.cc.

◆ copy_to_mg()

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

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

The action for discontinuous elements is as follows: on an active mesh cell, the global vector entries are simply copied to the corresponding entries of the level vector. Then, these values are restricted down to the coarsest level.

Definition at line 183 of file mg_transfer_block.cc.

◆ copy_from_mg()

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

Transfer from multi-level vector to normal vector.

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

◆ copy_from_mg_add()

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

Add a multi-level vector to a normal vector.

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

◆ prolongate_and_add()

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

◆ memory_consumption()

std::size_t MGTransferBlockBase::memory_consumption ( ) const
inherited

Memory used by this object.

Definition at line 174 of file multigrid.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

◆ factors

template<typename number >
std::vector<number> MGTransferBlock< number >::factors
private

Optional multiplication factors for each block. Requires initialization of memory.

Definition at line 273 of file mg_transfer_block.h.

◆ memory

template<typename number >
SmartPointer<VectorMemory<Vector<number> >, MGTransferBlock<number> > MGTransferBlock< number >::memory
private

Memory pool required if additional multiplication using factors is desired.

Definition at line 279 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_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: