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

Inheritance diagram for MGTransferBlock< number >:

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)

template<int dim, int spacedim>
void	build_matrices (const DoFHandler< dim, spacedim > &dof, const DoFHandler< dim, spacedim > &mg_dof, 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

std::size_t	memory_consumption () const

virtual void	prolongate_and_add (const unsigned int to_level, BlockVector< number > &dst, const BlockVector< number > &src) const

Private 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 Private Member Functions
static ::ExceptionBase &	ExcMatricesNotBuilt ()

Private Attributes
std::vector< number >	factors

SmartPointer< VectorMemory< Vector< number > >, MGTransferBlock< number > >	memory

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)

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)

void	check_no_subscribers () const noexcept

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

◆ build_matrices() [1/2]

template<typename number >

template<int dim, int spacedim>

void MGTransferBlock< number >::build_matrices	(	const DoFHandler< dim, spacedim > &	dof,
		const DoFHandler< dim, spacedim > &	mg_dof,
		const std::vector< bool > &	selected
	)

Build the prolongation matrices for each level.

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

Deprecated:: Use the build() function instead.

Definition at line 582 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.

◆ memory_consumption()

template<typename number >

std::size_t MGTransferBlockBase::memory_consumption ( ) const

Memory used by this object.

Definition at line 78 of file multigrid.cc.

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

◆ build_matrices() [2/2]

template<int dim, int spacedim>

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

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.

Deprecated:: Use build() instead.

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 301 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 307 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 114 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 119 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 129 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 134 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 139 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 144 of file mg_transfer_block.h.

◆ prolongation_sparsities

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

privateinherited

Definition at line 152 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 160 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 169 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 176 of file mg_transfer_block.h.

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

include/deal.II/multigrid/mg_transfer_block.h
source/multigrid/mg_transfer_block.cc
source/multigrid/multigrid.cc

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Subscriptor functionality

Detailed Description

Constructor & Destructor Documentation

◆ MGTransferBlock()

◆ ~MGTransferBlock()

Member Function Documentation

◆ initialize()

◆ build() [1/2]

◆ build_matrices() [1/2]

◆ prolongate()

◆ restrict_and_add()

◆ copy_to_mg()

◆ copy_from_mg()

◆ copy_from_mg_add()

◆ memory_consumption()

◆ prolongate_and_add()

◆ build() [2/2]

◆ build_matrices() [2/2]

Member Data Documentation

◆ factors

◆ memory

◆ selected

◆ n_mg_blocks

◆ mg_block

◆ sizes

◆ block_start

◆ mg_block_start

◆ prolongation_sparsities

◆ prolongation_matrices

◆ copy_indices

◆ mg_constrained_dofs