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

Inheritance diagram for MGTransferSelect< number >:

Public Member Functions
	MGTransferSelect ()

	MGTransferSelect (const AffineConstraints< double > &constraints)

virtual	~MGTransferSelect () override=default

template<int dim, int spacedim>
void	build_matrices (const DoFHandler< dim, spacedim > &dof, const DoFHandler< dim, spacedim > &mg_dof, unsigned int selected, unsigned int mg_selected, const std::vector< unsigned int > &target_component=std::vector< unsigned int >(), const std::vector< unsigned int > &mg_target_component=std::vector< unsigned int >(), const std::vector< std::set< types::global_dof_index > > &boundary_indices=std::vector< std::set< types::global_dof_index > >())

template<int dim, int spacedim>
void	build (const DoFHandler< dim, spacedim > &dof, unsigned int selected, unsigned int mg_selected, const std::vector< unsigned int > &target_component=std::vector< unsigned int >(), const std::vector< unsigned int > &mg_target_component=std::vector< unsigned int >(), const std::vector< std::set< types::global_dof_index > > &boundary_indices=std::vector< std::set< types::global_dof_index > >())

void	select (const unsigned int component, const unsigned int mg_component=numbers::invalid_unsigned_int)

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 > &mg_dof, MGLevelObject< Vector< number > > &dst, const Vector< number2 > &src) const

template<int dim, typename number2 , int spacedim>
void	copy_from_mg (const DoFHandler< dim, spacedim > &mg_dof, 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 > &mg_dof, Vector< number2 > &dst, const MGLevelObject< Vector< number > > &src) const

template<int dim, typename number2 , int spacedim>
void	copy_to_mg (const DoFHandler< dim, spacedim > &mg_dof, MGLevelObject< Vector< 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< Vector< 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< 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

Public Attributes
SmartPointer< const AffineConstraints< double > >	constraints

Private Member Functions
template<int dim, class OutVector , int spacedim>
void	do_copy_from_mg (const DoFHandler< dim, spacedim > &mg_dof, OutVector &dst, const MGLevelObject< Vector< number > > &src) const

template<int dim, class OutVector , int spacedim>
void	do_copy_from_mg_add (const DoFHandler< dim, spacedim > &mg_dof, OutVector &dst, const MGLevelObject< Vector< number > > &src) const

template<int dim, class InVector , int spacedim>
void	do_copy_to_mg (const DoFHandler< dim, spacedim > &mg_dof, MGLevelObject< Vector< number > > &dst, const InVector &src) const

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
unsigned int	selected_component

unsigned int	mg_selected_component

std::vector< IndexSet >	interface_dofs

ComponentMask	component_mask

ComponentMask	mg_component_mask

std::vector< unsigned int >	target_component

std::vector< unsigned int >	mg_target_component

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

std::vector< types::global_dof_index >	component_start

std::vector< std::vector< types::global_dof_index > >	mg_component_start

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

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

std::vector< std::vector< std::pair< types::global_dof_index, unsigned int > > >	copy_to_and_from_indices

std::vector< std::set< types::global_dof_index > >	boundary_indices

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 MGTransferSelect< number >

Implementation of the MGTransferBase interface for block matrices and simple vectors. This class uses MGTransferComponentBase selecting a single component or grouping several components into a single block. The transfer operators themselves are implemented for Vector and BlockVector objects.

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

Definition at line 190 of file mg_transfer_component.h.

Constructor & Destructor Documentation

◆ MGTransferSelect() [1/2]

template<typename number >

MGTransferSelect< number >::MGTransferSelect

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

Definition at line 198 of file multigrid.cc.

◆ MGTransferSelect() [2/2]

template<typename number >

MGTransferSelect< number >::MGTransferSelect ( const AffineConstraints< double > & constraints )

Constructor with constraint matrices.

Definition at line 205 of file multigrid.cc.

◆ ~MGTransferSelect()

template<typename number >

virtual MGTransferSelect< number >::~MGTransferSelect ( )

overridevirtualdefault

Destructor.

Member Function Documentation

◆ build_matrices() [1/2]

template<typename number >

template<int dim, int spacedim>

void MGTransferSelect< number >::build_matrices	(	const DoFHandler< dim, spacedim > &	dof,
		const DoFHandler< dim, spacedim > &	mg_dof,
		unsigned int	selected,
		unsigned int	mg_selected,
		const std::vector< unsigned int > &	target_component = `std::vector<unsigned int>()`,
		const std::vector< unsigned int > &	mg_target_component = `std::vector<unsigned int>()`,
		const std::vector< std::set< types::global_dof_index > > &	boundary_indices = `std::vector<std::set<types::global_dof_index>>()`
	)

Actually build the prolongation matrices for grouped components.

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

selected: Number of the block of the global vector to be copied from and to the multilevel vector. This number refers to the renumbering by target_component.

mg_selected: Number of the block for which the transfer matrices should be built.

If mg_target_component is present, this refers to the renumbered components.

target_component: this argument allows grouping and renumbering of components in the fine-level vector (see DoFRenumbering::component_wise).

mg_target_component: this argument allows grouping and renumbering of components in the level vectors (see DoFRenumbering::component_wise). It also affects the behavior of the selected argument

boundary_indices: holds the boundary indices on each level.

Deprecated:: Use build() instead.

Definition at line 574 of file mg_transfer_component.cc.

◆ build() [1/2]

template<typename number >

template<int dim, int spacedim>

void MGTransferSelect< number >::build	(	const DoFHandler< dim, spacedim > &	dof,
		unsigned int	selected,
		unsigned int	mg_selected,
		const std::vector< unsigned int > &	target_component = `std::vector<unsigned int>()`,
		const std::vector< unsigned int > &	mg_target_component = `std::vector<unsigned int>()`,
		const std::vector< std::set< types::global_dof_index > > &	boundary_indices = `std::vector<std::set<types::global_dof_index>>()`
	)

Actually build the prolongation matrices for grouped components.

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

selected Number of the block of the global vector to be copied from and to the multilevel vector. This number refers to the renumbering by target_component.

mg_selected Number of the block for which the transfer matrices should be built.

If mg_target_component is present, this refers to the renumbered components.

target_component this argument allows grouping and renumbering of components in the fine-level vector (see DoFRenumbering::component_wise).

mg_target_component this argument allows grouping and renumbering of components in the level vectors (see DoFRenumbering::component_wise). It also affects the behavior of the selected argument

boundary_indices holds the boundary indices on each level.

Definition at line 591 of file mg_transfer_component.cc.

◆ select()

template<typename number >

void MGTransferSelect< number >::select	(	const unsigned int	component,
		const unsigned int	mg_component = `numbers::invalid_unsigned_int`
	)

inline

Change selected component. Handle with care!

Definition at line 437 of file mg_transfer_component.h.

◆ prolongate()

template<typename number >

void MGTransferSelect< 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 215 of file multigrid.cc.

◆ restrict_and_add()

template<typename number >

void MGTransferSelect< 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 232 of file multigrid.cc.