MGTransferSelect< number > Class Template Reference

#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 (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
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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 ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Public Attributes
ObserverPointer< const AffineConstraints< double > >	constraints

Private Types
using	map_value_type = decltype(counter_map)::value_type
using	map_iterator = decltype(counter_map)::iterator

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
void	check_no_subscribers () const noexcept
template<int dim, int spacedim>
void	build (const DoFHandler< dim, spacedim > &dof_handler)

Static Private Member Functions
static ::ExceptionBase &	ExcMatricesNotBuilt ()

Private Attributes
unsigned int	selected_component
unsigned int	mg_selected_component
std::vector< IndexSet >	interface_dofs
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
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

Static Private Attributes
static std::mutex	mutex

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 174 of file mg_transfer_component.h.

Member Typedef Documentation

map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 238 of file enable_observer_pointer.h.

map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 243 of file enable_observer_pointer.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 196 of file multigrid.cc.

MGTransferSelect() [2/2]

template<typename number >

MGTransferSelect< number >::MGTransferSelect

(

const AffineConstraints< double > &

constraints

)

Constructor with constraint matrices.

Definition at line 203 of file multigrid.cc.

~MGTransferSelect()

template<typename number >

virtual MGTransferSelect< number >::~MGTransferSelect ( )

overridevirtualdefault

Destructor.

Member Function Documentation

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 563 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 380 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 213 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 230 of file multigrid.cc.

copy_to_mg() [1/2]

template<typename number >

template<int dim, typename number2 , int spacedim>

void MGTransferSelect< number >::copy_to_mg	(	const DoFHandler< dim, spacedim > &	mg_dof,
		MGLevelObject< Vector< number > > &	dst,
		const Vector< 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.

copy_from_mg() [1/2]

template<typename number >

template<int dim, typename number2 , int spacedim>

void MGTransferSelect< number >::copy_from_mg	(	const DoFHandler< dim, spacedim > &	mg_dof,
		Vector< number2 > &	dst,
		const MGLevelObject< Vector< number > > &	src
	)		const

Transfer from multilevel vector to normal vector.

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

copy_from_mg_add() [1/2]

template<typename number >

template<int dim, typename number2 , int spacedim>

void MGTransferSelect< number >::copy_from_mg_add	(	const DoFHandler< dim, spacedim > &	mg_dof,
		Vector< number2 > &	dst,
		const MGLevelObject< Vector< number > > &	src
	)		const

Add a multi-level vector to a normal vector.

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

copy_to_mg() [2/2]

template<typename number >

template<int dim, typename number2 , int spacedim>

void MGTransferSelect< number >::copy_to_mg	(	const DoFHandler< dim, spacedim > &	mg_dof,
		MGLevelObject< Vector< 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.

copy_from_mg() [2/2]

template<typename number >

template<int dim, typename number2 , int spacedim>

void MGTransferSelect< number >::copy_from_mg	(	const DoFHandler< dim, spacedim > &	mg_dof,
		BlockVector< number2 > &	dst,
		const MGLevelObject< Vector< number > > &	src
	)		const

Transfer from multilevel vector to normal vector.

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

copy_from_mg_add() [2/2]

template<typename number >

template<int dim, typename number2 , int spacedim>

void MGTransferSelect< number >::copy_from_mg_add	(	const DoFHandler< dim, spacedim > &	mg_dof,
		BlockVector< number2 > &	dst,
		const MGLevelObject< Vector< 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 MGTransferSelect< number >::memory_consumption

(

)

const

Memory used by this object.

do_copy_from_mg()

template<typename number >

template<int dim, class OutVector , int spacedim>

void MGTransferSelect< number >::do_copy_from_mg ( const DoFHandler< dim, spacedim > &  mg_dof, OutVector &  dst, const MGLevelObject< Vector< number > > &  src  ) const

private

Implementation of the public function.

do_copy_from_mg_add()

template<typename number >

template<int dim, class OutVector , int spacedim>

void MGTransferSelect< number >::do_copy_from_mg_add ( const DoFHandler< dim, spacedim > &  mg_dof, OutVector &  dst, const MGLevelObject< Vector< number > > &  src  ) const

private

Implementation of the public function.

do_copy_to_mg()

template<typename number >

template<int dim, class InVector , int spacedim>

void MGTransferSelect< number >::do_copy_to_mg ( const DoFHandler< dim, spacedim > &  mg_dof, MGLevelObject< Vector< number > > &  dst, const InVector &  src  ) const

private

Actual implementation of copy_to_mg().

Definition at line 214 of file mg_transfer_component.cc.

prolongate_and_add()

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

subscribe()

void EnableObserverPointer::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 131 of file enable_observer_pointer.cc.

unsubscribe()

void EnableObserverPointer::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 151 of file enable_observer_pointer.cc.

n_subscriptions()

unsigned int EnableObserverPointer::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 322 of file enable_observer_pointer.h.

list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType &  stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 339 of file enable_observer_pointer.h.

list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

serialize()

template<class Archive >

void EnableObserverPointer::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 331 of file enable_observer_pointer.h.

check_no_subscribers()

void EnableObserverPointer::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note

Since this function is just a consistency check it does nothing in release mode.

If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file enable_observer_pointer.cc.

build() [2/2]

template<int dim, int spacedim>

void MGTransferComponentBase::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_component and mg_selected_component member variables to restrict the transfer matrices to certain components. Furthermore, they use target_component and mg_target_component for re-ordering and grouping of components.

Definition at line 256 of file mg_transfer_component.cc.

Member Data Documentation

selected_component

template<typename number >

unsigned int MGTransferSelect< number >::selected_component

private

Selected component of global vector.

Definition at line 355 of file mg_transfer_component.h.

mg_selected_component

template<typename number >

unsigned int MGTransferSelect< number >::mg_selected_component

private

Selected component inside multigrid.

Definition at line 359 of file mg_transfer_component.h.

interface_dofs

template<typename number >

std::vector<IndexSet> MGTransferSelect< number >::interface_dofs

private

The degrees of freedom on the refinement edges. For each level the index set denotes which level degrees of freedom are on the refinement edge towards the lower level, excluding boundary dofs.

Definition at line 366 of file mg_transfer_component.h.

constraints

template<typename number >

ObserverPointer<const AffineConstraints<double> > MGTransferSelect< number >::constraints

The constraints of the global system.

Definition at line 372 of file mg_transfer_component.h.

counter

std::atomic<unsigned int> EnableObserverPointer::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 227 of file enable_observer_pointer.h.

counter_map

std::map<std::string, unsigned int> EnableObserverPointer::counter_map

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 233 of file enable_observer_pointer.h.

validity_pointers

std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers

mutableprivateinherited

In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.

Definition at line 249 of file enable_observer_pointer.h.

object_info

const std::type_info* EnableObserverPointer::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 257 of file enable_observer_pointer.h.

mutex

std::mutex EnableObserverPointer::mutex

staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 280 of file enable_observer_pointer.h.

component_mask

ComponentMask MGTransferComponentBase::component_mask

protectedinherited

Flag of selected components.

The transfer operators only act on the components having a true entry here. If renumbering by target_component is used, this refers to the renumbered components.

Definition at line 94 of file mg_transfer_component.h.

mg_component_mask

ComponentMask MGTransferComponentBase::mg_component_mask

protectedinherited

Flag of selected components.

The transfer operators only act on the components having a true entry here. If renumbering by mg_target_component is used, this refers to the renumbered components.

Definition at line 103 of file mg_transfer_component.h.

target_component

std::vector<unsigned int> MGTransferComponentBase::target_component

protectedinherited

Target component of the fine-level vector if renumbering is required.

Definition at line 108 of file mg_transfer_component.h.

mg_target_component

std::vector<unsigned int> MGTransferComponentBase::mg_target_component

protectedinherited

Target component if renumbering of level vectors is required.

Definition at line 113 of file mg_transfer_component.h.

sizes

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

mutableprotectedinherited

Sizes of the multi-level vectors.

Definition at line 118 of file mg_transfer_component.h.

component_start

std::vector<types::global_dof_index> MGTransferComponentBase::component_start

protectedinherited

Start index of each component.

Definition at line 123 of file mg_transfer_component.h.

mg_component_start

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

protectedinherited

Start index of each component on all levels.

Definition at line 128 of file mg_transfer_component.h.

prolongation_sparsities

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

privateinherited

Definition at line 136 of file mg_transfer_component.h.

prolongation_matrices

std::vector<std::shared_ptr<BlockSparseMatrix<double> > > MGTransferComponentBase::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 144 of file mg_transfer_component.h.

copy_to_and_from_indices

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

protectedinherited

This variable holds the mapping for the copy_to/from_mg-functions. The data is first the global index, then the level index.

Definition at line 151 of file mg_transfer_component.h.

boundary_indices

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

protectedinherited

Store the boundary_indices. These are needed for the boundary values in the restriction matrix.

Definition at line 157 of file mg_transfer_component.h.

---

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

• include/deal.II/multigrid/mg_transfer_component.h
• source/multigrid/mg_transfer_component.cc
• source/multigrid/multigrid.cc