MGTransferBlock< number > Class Template Reference

#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_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 > &mg_dof, MGLevelObject< BlockVector< number >> &dst, const BlockVector< number2 > &src) const
template<int dim, typename number2 , int spacedim>
void	copy_from_mg (const DoFHandler< dim, spacedim > &mg_dof, 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 > &mg_dof, BlockVector< number2 > &dst, const MGLevelObject< BlockVector< number >> &src) const
std::size_t	memory_consumption () const
Public Member Functions inherited from MGTransferBase< BlockVector< number > >
virtual	~MGTransferBase () override=default
Public Member Functions inherited from Subscriptor
	Subscriptor ()
	Subscriptor (const Subscriptor &)
	Subscriptor (Subscriptor &&) noexcept
virtual	~Subscriptor ()
Subscriptor &	operator= (const Subscriptor &)
Subscriptor &	operator= (Subscriptor &&) noexcept
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)

Private Attributes
std::vector< number >	factors
SmartPointer< VectorMemory< Vector< number > >, MGTransferBlock< number > >	memory
Private Attributes inherited from MGTransferBlockBase
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< 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

Additional Inherited Members
Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
Private Member Functions inherited from MGTransferBlockBase
	MGTransferBlockBase ()
	MGTransferBlockBase (const MGConstrainedDoFs &mg_constrained_dofs)
	MGTransferBlockBase (const AffineConstraints< double > &constraints, const MGConstrainedDoFs &mg_constrained_dofs)
std::size_t	memory_consumption () const
template<int dim, int spacedim>
void	build_matrices (const DoFHandler< dim, spacedim > &dof, const DoFHandler< dim, spacedim > &mg_dof)
Static Private Member Functions inherited from MGTransferBlockBase
static ::ExceptionBase &	ExcMatricesNotBuilt ()

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.

Author

Guido Kanschat, 2001, 2002

Definition at line 195 of file mg_transfer_block.h.

Constructor & Destructor Documentation

MGTransferBlock()

template<typename number >

MGTransferBlock< number >::MGTransferBlock

(

)

Default constructor.

Definition at line 61 of file multigrid.cc.

~MGTransferBlock()

template<typename number >

MGTransferBlock< number >::~MGTransferBlock ( )

overridevirtual

Destructor.

Definition at line 67 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 76 of file multigrid.cc.

build_matrices()

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.

Definition at line 566 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 86 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 > &	mg_dof,
		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 184 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 > &	mg_dof,
		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 > &	mg_dof,
		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

Memory used by this object.

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

---

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

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