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

Inheritance diagram for MGTwoLevelTransfer< dim, VectorType >:

[legend]

Classes
struct	MatrixFreeRelatedData

struct	MGTransferScheme

Public Types
using	Number = typename VectorType::value_type

using	VectorizedArrayType = VectorizedArray< Number >

Public Member Functions
void	reinit_geometric_transfer (const DoFHandler< dim > &dof_handler_fine, const DoFHandler< dim > &dof_handler_coarse, const AffineConstraints< Number > &constraint_fine=AffineConstraints< Number >(), const AffineConstraints< Number > &constraint_coarse=AffineConstraints< Number >(), const unsigned int mg_level_fine=numbers::invalid_unsigned_int, const unsigned int mg_level_coarse=numbers::invalid_unsigned_int)

void	reinit_polynomial_transfer (const DoFHandler< dim > &dof_handler_fine, const DoFHandler< dim > &dof_handler_coarse, const AffineConstraints< Number > &constraint_fine=AffineConstraints< Number >(), const AffineConstraints< Number > &constraint_coarse=AffineConstraints< Number >(), const unsigned int mg_level_fine=numbers::invalid_unsigned_int, const unsigned int mg_level_coarse=numbers::invalid_unsigned_int)

void	reinit (const DoFHandler< dim > &dof_handler_fine, const DoFHandler< dim > &dof_handler_coarse, const AffineConstraints< Number > &constraint_fine=AffineConstraints< Number >(), const AffineConstraints< Number > &constraint_coarse=AffineConstraints< Number >(), const unsigned int mg_level_fine=numbers::invalid_unsigned_int, const unsigned int mg_level_coarse=numbers::invalid_unsigned_int)

void	reinit (const MatrixFree< dim, Number > &matrix_free_fine, const unsigned int dof_no_fine, const MatrixFree< dim, Number > &matrix_free_coarse, const unsigned int dof_no_coarse)

void	interpolate (VectorType &dst, const VectorType &src) const override

std::pair< bool, bool >	enable_inplace_operations_if_possible (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_coarse, const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_fine) override

std::size_t	memory_consumption () const override

void	prolongate_and_add (VectorType &dst, const VectorType &src) const

void	restrict_and_add (VectorType &dst, const VectorType &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 bool	fast_polynomial_transfer_supported (const unsigned int fe_degree_fine, const unsigned int fe_degree_coarse)

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Public Attributes
std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner_coarse

std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner_fine

Protected Member Functions
void	prolongate_and_add_internal (VectorType &dst, const VectorType &src) const override

void	restrict_and_add_internal (VectorType &dst, const VectorType &src) const override

virtual void	prolongate_and_add_internal (LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const =0

virtual void	restrict_and_add_internal (LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const =0

void	update_ghost_values (const VectorType &vec) const

void	compress (VectorType &vec, const VectorOperation::values op) const

void	zero_out_ghost_values (const VectorType &vec) const

template<int dim, std::size_t width, typename IndexType >
std::pair< bool, bool >	internal_enable_inplace_operations_if_possible (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_coarse, const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_fine, bool &vec_fine_needs_ghost_update, internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArray< Number, width >, IndexType > &constraint_info_coarse, std::vector< unsigned int > &dof_indices_fine)

Protected Attributes
bool	fine_element_is_continuous

LinearAlgebra::distributed::Vector< Number >	vec_coarse

LinearAlgebra::distributed::Vector< Number >	vec_fine

bool	vec_fine_needs_ghost_update

std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner_coarse_embedded

std::shared_ptr< const Utilities::MPI::Partitioner >	partitioner_fine_embedded

AlignedVector< Number >	buffer_coarse_embedded

AlignedVector< Number >	buffer_fine_embedded

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

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
void	check_no_subscribers () const noexcept

Private Attributes
std::vector< MGTransferScheme >	schemes

internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArrayType, types::global_dof_index >	constraint_info_coarse

internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArrayType, types::global_dof_index >	constraint_info_fine

std::unique_ptr< MatrixFreeRelatedData >	matrix_free_data

std::vector< unsigned int >	weights_start

AlignedVector< VectorizedArrayType >	weights

std::vector< unsigned char >	weights_are_compressed

unsigned int	n_components

ObserverPointer< const DoFHandler< dim > >	dof_handler_fine

unsigned int	mg_level_fine

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

Static Private Attributes
static std::mutex	mutex

Friends
class	internal::MGTwoLevelTransferImplementation

class	MGTransferMF< dim, Number >

Detailed Description

template<int dim, typename VectorType>
class MGTwoLevelTransfer< dim, VectorType >

Class for transfer between two multigrid levels for p- or global coarsening. It relies on a list of DoF indices associated with the cells on the coarse and fine side of the transfer, and implements a cell-by-cell (matrix-free) interpolation setup with the reference-cell embedding matrices.

The implementation of this class is explained in detail in [163].

There are two possible ways to use this class. In the first option, the transfer is built from the underlying DoFHandler and AffineConstraints objects on the coarse and fine side, collecting an explicit copy of all indices on both sides. This works for a relatively wide set of FiniteElement combinations, including p-adaptive schemes using hp::FECollection. The second, more setup-efficient approach is to build the transfer between two multigrid levels for polynomial coarsening (p-coarsening) from two MatrixFree objects that might already exist from other parts of the code. In this case, we require that both objects share the same triangulation (but differ through their DoFHandler descriptions) and are described by the respective DoFHandler/AffineConstraints pair. This second variant is more efficient because no queries to the DoFHandler need to be made, reducing both the setup time and the overall memory consumption. Note that not all options are supported for the second entry point, and we fall back to the first option in such a case.

Definition at line 433 of file mg_transfer_global_coarsening.h.

Member Typedef Documentation

◆ Number

template<int dim, typename VectorType >

using MGTwoLevelTransfer< dim, VectorType >::Number = typename VectorType::value_type

The scalar type used by the vector-type template argument.

Definition at line 446 of file mg_transfer_global_coarsening.h.

◆ VectorizedArrayType

template<int dim, typename VectorType >

using MGTwoLevelTransfer< dim, VectorType >::VectorizedArrayType = VectorizedArray<Number>

A data type representing a vectorized array of the same kind of objects stored in the VectorType.

Definition at line 452 of file mg_transfer_global_coarsening.h.

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

Member Function Documentation

◆ reinit_geometric_transfer()

template<int dim, typename VectorType >

void MGTwoLevelTransfer< dim, VectorType >::reinit_geometric_transfer	(	const DoFHandler< dim > &	dof_handler_fine,
		const DoFHandler< dim > &	dof_handler_coarse,
		const AffineConstraints< Number > &	constraint_fine = `AffineConstraints< Number >()`,
		const AffineConstraints< Number > &	constraint_coarse = `AffineConstraints< Number >()`,
		const unsigned int	mg_level_fine = `numbers::invalid_unsigned_int`,
		const unsigned int	mg_level_coarse = `numbers::invalid_unsigned_int`
	)

Set up global coarsening between the given DoFHandler objects ( dof_handler_fine and dof_handler_coarse). The transfer can be only performed on active levels.

◆ reinit_polynomial_transfer()

template<int dim, typename VectorType >

void MGTwoLevelTransfer< dim, VectorType >::reinit_polynomial_transfer	(	const DoFHandler< dim > &	dof_handler_fine,
		const DoFHandler< dim > &	dof_handler_coarse,
		const AffineConstraints< Number > &	constraint_fine = `AffineConstraints< Number >()`,
		const AffineConstraints< Number > &	constraint_coarse = `AffineConstraints< Number >()`,
		const unsigned int	mg_level_fine = `numbers::invalid_unsigned_int`,
		const unsigned int	mg_level_coarse = `numbers::invalid_unsigned_int`
	)

Set up polynomial coarsening between the given DoFHandler objects ( dof_handler_fine and dof_handler_coarse). Polynomial transfers can be only performed on active levels (numbers::invalid_unsigned_int) or on coarse-grid levels, i.e., levels without hanging nodes.

Note: The function polynomial_transfer_supported() can be used to check if the given polynomial coarsening strategy is supported.

◆ reinit() [1/2]

template<int dim, typename VectorType >

void MGTwoLevelTransfer< dim, VectorType >::reinit	(	const DoFHandler< dim > &	dof_handler_fine,
		const DoFHandler< dim > &	dof_handler_coarse,
		const AffineConstraints< Number > &	constraint_fine = `AffineConstraints< Number >()`,
		const AffineConstraints< Number > &	constraint_coarse = `AffineConstraints< Number >()`,
		const unsigned int	mg_level_fine = `numbers::invalid_unsigned_int`,
		const unsigned int	mg_level_coarse = `numbers::invalid_unsigned_int`
	)

Set up the transfer operator between the given DoFHandler objects ( dof_handler_fine and dof_handler_coarse). Depending on the underlying Triangulation objects polynomial or geometrical global coarsening is performed.

Note: While geometric transfer can be only performed on active levels (numbers::invalid_unsigned_int), polynomial transfers can also be performed on coarse-grid levels, i.e., levels without hanging nodes.; The function polynomial_transfer_supported() can be used to check if the given polynomial coarsening strategy is supported.

◆ reinit() [2/2]

template<int dim, typename VectorType >

void MGTwoLevelTransfer< dim, VectorType >::reinit	(	const MatrixFree< dim, Number > &	matrix_free_fine,
		const unsigned int	dof_no_fine,
		const MatrixFree< dim, Number > &	matrix_free_coarse,
		const unsigned int	dof_no_coarse
	)

Set up polynomial coarsening between the DoFHandler objects underlying two MatrixFree objects and the respective numbers for the DoFHandler objects within MatrixFree. This reinit() function allows for a more efficient setup of the transfer operator and reduces the overall memory consumption of a multigrid cycle in case the same MatrixFree objects are also used for smoothers and residual evaluation on the two involved levels.

◆ fast_polynomial_transfer_supported()

template<int dim, typename VectorType >

static bool MGTwoLevelTransfer< dim, VectorType >::fast_polynomial_transfer_supported	(	const unsigned int	fe_degree_fine,
		const unsigned int	fe_degree_coarse
	)

static

Check if a fast templated version of the polynomial transfer between fe_degree_fine and fe_degree_coarse is available.

Note: Currently, the polynomial coarsening strategies: 1) go-to-one, 2) bisect, and 3) decrease-by-one are precompiled with templates for degrees up to 9.

◆ interpolate()

template<int dim, typename VectorType >

void MGTwoLevelTransfer< dim, VectorType >::interpolate	(	VectorType &	dst,
		const VectorType &	src
	)		const

overridevirtual

Perform interpolation of a solution vector from the fine level to the coarse level. This function is different from restriction, where a weighted residual is transferred to a coarser level (transposition of prolongation matrix). In other words, restriction acts on right hand side vectors, whereas interpolation acts on solution vectors.

Implements MGTwoLevelTransferBase< VectorType >.

◆ enable_inplace_operations_if_possible()

template<int dim, typename VectorType >

std::pair< bool, bool > MGTwoLevelTransfer< dim, VectorType >::enable_inplace_operations_if_possible	(	const std::shared_ptr< const Utilities::MPI::Partitioner > &	partitioner_coarse,
		const std::shared_ptr< const Utilities::MPI::Partitioner > &	partitioner_fine
	)

overridevirtual

Enable inplace vector operations if external and internal vectors are compatible.

Implements MGTwoLevelTransferBase< VectorType >.

◆ memory_consumption()

template<int dim, typename VectorType >

std::size_t MGTwoLevelTransfer< dim, VectorType >::memory_consumption ( ) const

overridevirtual

Return the memory consumption of the allocated memory in this class.

Implements MGTwoLevelTransferBase< VectorType >.

◆ prolongate_and_add_internal() [1/2]

template<int dim, typename VectorType >

void MGTwoLevelTransfer< dim, VectorType >::prolongate_and_add_internal	(	VectorType &	dst,
		const VectorType &	src
	)		const

overrideprotected

◆ restrict_and_add_internal() [1/2]

template<int dim, typename VectorType >

void MGTwoLevelTransfer< dim, VectorType >::restrict_and_add_internal	(	VectorType &	dst,
		const VectorType &	src
	)		const

overrideprotected

◆ prolongate_and_add()

template<typename VectorType >

void MGTwoLevelTransferBase< VectorType >::prolongate_and_add	(	VectorType &	dst,
		const VectorType &	src
	)		const

inherited

Perform prolongation on a solution vector.

◆ restrict_and_add()

template<typename VectorType >

void MGTwoLevelTransferBase< VectorType >::restrict_and_add	(	VectorType &	dst,
		const VectorType &	src
	)		const

inherited

Perform restriction on a residual vector.

◆ prolongate_and_add_internal() [2/2]

template<typename VectorType >

virtual void MGTwoLevelTransferBase< VectorType >::prolongate_and_add_internal	(	LinearAlgebra::distributed::Vector< Number > &	dst,
		const LinearAlgebra::distributed::Vector< Number > &	src
	)		const

protectedpure virtualinherited

Perform prolongation on vectors with correct ghosting.

◆ restrict_and_add_internal() [2/2]

template<typename VectorType >

virtual void MGTwoLevelTransferBase< VectorType >::restrict_and_add_internal	(	LinearAlgebra::distributed::Vector< Number > &	dst,
		const LinearAlgebra::distributed::Vector< Number > &	src
	)		const

protectedpure virtualinherited

Perform restriction on vectors with correct ghosting.

◆ update_ghost_values()

template<typename VectorType >

void MGTwoLevelTransferBase< VectorType >::update_ghost_values ( const VectorType & vec ) const

protectedinherited

A wrapper around update_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ compress()

template<typename VectorType >

void MGTwoLevelTransferBase< VectorType >::compress	(	VectorType &	vec,
		const VectorOperation::values	op
	)		const

protectedinherited

A wrapper around compress() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ zero_out_ghost_values()

template<typename VectorType >

void MGTwoLevelTransferBase< VectorType >::zero_out_ghost_values ( const VectorType & vec ) const

protectedinherited

A wrapper around zero_out_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ internal_enable_inplace_operations_if_possible()

template<typename VectorType >

template<int dim, std::size_t width, typename IndexType >

std::pair< bool, bool > MGTwoLevelTransferBase< VectorType >::internal_enable_inplace_operations_if_possible	(	const std::shared_ptr< const Utilities::MPI::Partitioner > &	partitioner_coarse,
		const std::shared_ptr< const Utilities::MPI::Partitioner > &	partitioner_fine,
		bool &	vec_fine_needs_ghost_update,
		internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArray< Number, width >, IndexType > &	constraint_info_coarse,
		std::vector< unsigned int > &	dof_indices_fine
	)

protectedinherited

Enable inplace vector operations if external and internal vectors are compatible.

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

Friends And Related Symbol Documentation

◆ internal::MGTwoLevelTransferImplementation

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.

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

include/deal.II/multigrid/mg_transfer_global_coarsening.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Number

◆ VectorizedArrayType

◆ map_value_type

◆ map_iterator

Member Function Documentation

◆ reinit_geometric_transfer()

◆ reinit_polynomial_transfer()

◆ reinit() [1/2]

◆ reinit() [2/2]

◆ fast_polynomial_transfer_supported()

◆ interpolate()

◆ enable_inplace_operations_if_possible()

◆ memory_consumption()

◆ prolongate_and_add_internal() [1/2]

◆ restrict_and_add_internal() [1/2]

◆ prolongate_and_add()

◆ restrict_and_add()

◆ prolongate_and_add_internal() [2/2]

◆ restrict_and_add_internal() [2/2]

◆ update_ghost_values()

◆ compress()

◆ zero_out_ghost_values()

◆ internal_enable_inplace_operations_if_possible()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Friends And Related Symbol Documentation

◆ internal::MGTwoLevelTransferImplementation

◆ MGTransferMF< dim, Number >

Member Data Documentation

◆ schemes

◆ constraint_info_coarse

◆ constraint_info_fine

◆ matrix_free_data

◆ weights_start

◆ weights

◆ weights_are_compressed

◆ n_components

◆ dof_handler_fine

◆ mg_level_fine

◆ fine_element_is_continuous

◆ partitioner_coarse

◆ partitioner_fine

◆ vec_coarse

◆ vec_fine

◆ vec_fine_needs_ghost_update

◆ partitioner_coarse_embedded

◆ partitioner_fine_embedded

◆ buffer_coarse_embedded

◆ buffer_fine_embedded

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex