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

Inheritance diagram for Multigrid< VectorType >:

Public Types
enum	Cycle { v_cycle , w_cycle , f_cycle }

using	vector_type = VectorType

using	const_vector_type = const VectorType

Public Member Functions
	Multigrid (const MGMatrixBase< VectorType > &matrix, const MGCoarseGridBase< VectorType > &coarse, const MGTransferBase< VectorType > &transfer, const MGSmootherBase< VectorType > &pre_smooth, const MGSmootherBase< VectorType > &post_smooth, const unsigned int minlevel=0, const unsigned int maxlevel=numbers::invalid_unsigned_int, Cycle cycle=v_cycle)

void	reinit (const unsigned int minlevel, const unsigned int maxlevel)

void	cycle ()

void	vcycle ()

void	set_edge_matrices (const MGMatrixBase< VectorType > &edge_out, const MGMatrixBase< VectorType > &edge_in)

void	set_edge_flux_matrices (const MGMatrixBase< VectorType > &edge_down, const MGMatrixBase< VectorType > &edge_up)

unsigned int	get_maxlevel () const

unsigned int	get_minlevel () const

void	set_maxlevel (const unsigned int)

void	set_minlevel (const unsigned int level, bool relative=false)

void	set_cycle (Cycle)

boost::signals2::connection	connect_coarse_solve (const std::function< void(const bool, const unsigned int)> &slot)

boost::signals2::connection	connect_restriction (const std::function< void(const bool, const unsigned int)> &slot)

boost::signals2::connection	connect_prolongation (const std::function< void(const bool, const unsigned int)> &slot)

boost::signals2::connection	connect_pre_smoother_step (const std::function< void(const bool, const unsigned int)> &slot)

boost::signals2::connection	connect_post_smoother_step (const std::function< void(const bool, const unsigned int)> &slot)

Public Attributes
MGLevelObject< VectorType >	defect

MGLevelObject< VectorType >	solution

Private Member Functions
void	level_v_step (const unsigned int level)

void	level_step (const unsigned int level, Cycle cycle)

Private Attributes
mg::Signals	signals

Cycle	cycle_type

unsigned int	minlevel

unsigned int	maxlevel

MGLevelObject< VectorType >	t

MGLevelObject< VectorType >	defect2

SmartPointer< const MGMatrixBase< VectorType >, Multigrid< VectorType > >	matrix

SmartPointer< const MGCoarseGridBase< VectorType >, Multigrid< VectorType > >	coarse

SmartPointer< const MGTransferBase< VectorType >, Multigrid< VectorType > >	transfer

SmartPointer< const MGSmootherBase< VectorType >, Multigrid< VectorType > >	pre_smooth

SmartPointer< const MGSmootherBase< VectorType >, Multigrid< VectorType > >	post_smooth

SmartPointer< const MGMatrixBase< VectorType > >	edge_out

SmartPointer< const MGMatrixBase< VectorType > >	edge_in

SmartPointer< const MGMatrixBase< VectorType >, Multigrid< VectorType > >	edge_down

SmartPointer< const MGMatrixBase< VectorType >, Multigrid< VectorType > >	edge_up

Friends
template<int dim, class OtherVectorType , class TRANSFER >
class	PreconditionMG

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 VectorType>
class Multigrid< VectorType >

Implementation of the multigrid method. The implementation supports both continuous and discontinuous elements and follows the procedure described in the multigrid paper by Janssen and Kanschat.

The function which starts a multigrid cycle on the finest level is cycle(). Depending on the cycle type chosen with the constructor (see enum Cycle), this function triggers one of the cycles level_v_step() or level_step(), where the latter one can do different types of cycles.

Using this class, it is expected that the right hand side has been converted from a vector living on the locally finest level to a multilevel vector. This is a nontrivial operation, usually initiated automatically by the class PreconditionMG and performed by the classes derived from MGTransferBase.

Note: The interface of this class is still very clumsy. In particular, you will have to set up quite a few auxiliary objects before you can use it. Unfortunately, it seems that this can be avoided only be restricting the flexibility of this class in an unacceptable way.

Definition at line 152 of file multigrid.h.

Member Typedef Documentation

◆ vector_type

template<typename VectorType >

using Multigrid< VectorType >::vector_type = VectorType

Definition at line 168 of file multigrid.h.

◆ const_vector_type

template<typename VectorType >

using Multigrid< VectorType >::const_vector_type = const VectorType

Definition at line 169 of file multigrid.h.

Member Enumeration Documentation

◆ Cycle

template<typename VectorType >

enum Multigrid::Cycle

List of implemented cycle types.

Enumerator
v_cycle	The V-cycle.
w_cycle	The W-cycle.
f_cycle	The F-cycle.

Definition at line 158 of file multigrid.h.

Constructor & Destructor Documentation

◆ Multigrid()

template<typename VectorType >

Multigrid< VectorType >::Multigrid	(	const MGMatrixBase< VectorType > &	matrix,
		const MGCoarseGridBase< VectorType > &	coarse,
		const MGTransferBase< VectorType > &	transfer,
		const MGSmootherBase< VectorType > &	pre_smooth,
		const MGSmootherBase< VectorType > &	post_smooth,
		const unsigned int	minlevel = `0`,
		const unsigned int	maxlevel = `numbers::invalid_unsigned_int`,
		Cycle	cycle = `v_cycle`
	)

Constructor. transfer is an object performing prolongation and restriction. For levels in [minlevel, maxlevel] matrix has to contain valid matrices. By default the maxlevel is set to the maximal valid level.

This function already initializes the vectors which will be used later in the course of the computations. You should therefore create objects of this type as late as possible.

Member Function Documentation

◆ reinit()

template<typename VectorType >

void Multigrid< VectorType >::reinit	(	const unsigned int	minlevel,
		const unsigned int	maxlevel
	)

Reinit this class according to minlevel and maxlevel.

◆ cycle()

template<typename VectorType >

void Multigrid< VectorType >::cycle ( )

Execute one multigrid cycle. The type of cycle is selected by the constructor argument cycle. See the enum Cycle for available types.

◆ vcycle()

template<typename VectorType >

void Multigrid< VectorType >::vcycle ( )

Execute one step of the V-cycle algorithm. This function assumes, that the multilevel vector defect is filled with the residual of an outer defect correction scheme. This is usually taken care of by PreconditionMG). After vcycle(), the result is in the multilevel vector solution. See copy_*_mg in the MGTools namespace if you want to use these vectors yourself.

The actual work for this function is done in level_v_step().

◆ set_edge_matrices()

template<typename VectorType >

void Multigrid< VectorType >::set_edge_matrices	(	const MGMatrixBase< VectorType > &	edge_out,
		const MGMatrixBase< VectorType > &	edge_in
	)

Set additional matrices to correct residual computation at refinement edges. Since we only smoothen in the interior of the refined part of the mesh, the coupling across the refinement edge is missing. This coupling is provided by these two matrices.

Note: While edge_out.vmult is used, for the second argument, we use edge_in.Tvmult. Thus, edge_in should be assembled in transposed form. This saves a second sparsity pattern for edge_in. In particular, for symmetric operators, both arguments can refer to the same matrix, saving assembling of one of them.

◆ set_edge_flux_matrices()

template<typename VectorType >

void Multigrid< VectorType >::set_edge_flux_matrices	(	const MGMatrixBase< VectorType > &	edge_down,
		const MGMatrixBase< VectorType > &	edge_up
	)

Set additional matrices to correct residual computation at refinement edges. These matrices originate from discontinuous Galerkin methods (see FE_DGQ etc.), where they correspond to the edge fluxes at the refinement edge between two levels.

Note: While edge_down.vmult is used, for the second argument, we use edge_up.Tvmult. Thus, edge_up should be assembled in transposed form. This saves a second sparsity pattern for edge_up. In particular, for symmetric operators, both arguments can refer to the same matrix, saving assembling of one of them.

◆ get_maxlevel()

template<typename VectorType >

unsigned int Multigrid< VectorType >::get_maxlevel ( ) const

Return the finest level for multigrid.

◆ get_minlevel()

template<typename VectorType >

unsigned int Multigrid< VectorType >::get_minlevel ( ) const

Return the coarsest level for multigrid.

◆ set_maxlevel()

template<typename VectorType >

void Multigrid< VectorType >::set_maxlevel ( const unsigned int )

Set the highest level for which the multilevel method is performed. By default, this is the finest level of the Triangulation. Accepted are values not smaller than the current minlevel.

◆ set_minlevel()

template<typename VectorType >

void Multigrid< VectorType >::set_minlevel	(	const unsigned int	level,
		bool	relative = `false`
	)

Set the coarsest level for which the multilevel method is performed. By default, this is zero. Accepted are non-negative values not larger than the current maxlevel.

If relative is true, then this function determines the number of levels used, that is, it sets minlevel to maxlevel-level.

Note: The mesh on the coarsest level must cover the whole domain. There may not be hanging nodes on minlevel.; If minlevel is set to a nonzero value, do not forget to adjust your coarse grid solver!

◆ set_cycle()

template<typename VectorType >

void Multigrid< VectorType >::set_cycle ( Cycle )

Chance cycle_type used in cycle().

◆ connect_coarse_solve()

template<typename VectorType >

boost::signals2::connection Multigrid< VectorType >::connect_coarse_solve ( const std::function< void(const bool, const unsigned int)> & slot )

Connect a function to mg::Signals::coarse_solve.

◆ connect_restriction()

template<typename VectorType >

boost::signals2::connection Multigrid< VectorType >::connect_restriction ( const std::function< void(const bool, const unsigned int)> & slot )

Connect a function to mg::Signals::restriction.

◆ connect_prolongation()

template<typename VectorType >

boost::signals2::connection Multigrid< VectorType >::connect_prolongation ( const std::function< void(const bool, const unsigned int)> & slot )

Connect a function to mg::Signals::prolongation.

◆ connect_pre_smoother_step()

template<typename VectorType >

boost::signals2::connection Multigrid< VectorType >::connect_pre_smoother_step ( const std::function< void(const bool, const unsigned int)> & slot )

Connect a function to mg::Signals::pre_smoother_step.

◆ connect_post_smoother_step()

template<typename VectorType >

boost::signals2::connection Multigrid< VectorType >::connect_post_smoother_step ( const std::function< void(const bool, const unsigned int)> & slot )

Connect a function to mg::Signals::post_smoother_step.

◆ level_v_step()

template<typename VectorType >

void Multigrid< VectorType >::level_v_step ( const unsigned int level )

private

The V-cycle multigrid method. level is the level the function starts on. It will usually be called for the highest level from outside, but will then call itself recursively for level-1, unless we are on minlevel where the coarse grid solver solves the problem exactly.

◆ level_step()

template<typename VectorType >

void Multigrid< VectorType >::level_step	(	const unsigned int	level,
		Cycle	cycle
	)

private

The actual W-cycle or F-cycle multigrid method. level is the level the function starts on. It will usually be called for the highest level from outside, but will then call itself recursively for level-1, unless we are on minlevel where the coarse grid solver solves the problem exactly.

Friends And Related Function Documentation

◆ PreconditionMG

template<typename VectorType >

template<int dim, class OtherVectorType , class TRANSFER >

friend class PreconditionMG

friend

Definition at line 448 of file multigrid.h.

Member Data Documentation

◆ signals

template<typename VectorType >

mg::Signals Multigrid< VectorType >::signals

private

Signals for the various actions that the Multigrid algorithm uses.

Definition at line 329 of file multigrid.h.

◆ cycle_type

template<typename VectorType >

Cycle Multigrid< VectorType >::cycle_type

private

Cycle type performed by the method cycle().

Definition at line 353 of file multigrid.h.

◆ minlevel

template<typename VectorType >

unsigned int Multigrid< VectorType >::minlevel

private

Level for coarse grid solution.

Definition at line 358 of file multigrid.h.

◆ maxlevel

template<typename VectorType >

unsigned int Multigrid< VectorType >::maxlevel

private

Highest level of cells.

Definition at line 363 of file multigrid.h.

◆ defect

template<typename VectorType >

MGLevelObject<VectorType> Multigrid< VectorType >::defect

Input vector for the cycle. Contains the defect of the outer method projected to the multilevel vectors.

Definition at line 370 of file multigrid.h.

◆ solution

template<typename VectorType >

MGLevelObject<VectorType> Multigrid< VectorType >::solution

The solution update after the multigrid step.

Definition at line 375 of file multigrid.h.

◆ t

template<typename VectorType >

MGLevelObject<VectorType> Multigrid< VectorType >::t

private

Auxiliary vector.

Definition at line 381 of file multigrid.h.

◆ defect2

template<typename VectorType >

MGLevelObject<VectorType> Multigrid< VectorType >::defect2

private

Auxiliary vector for W- and F-cycles. Left uninitialized in V-cycle.

Definition at line 386 of file multigrid.h.

◆ matrix

template<typename VectorType >

SmartPointer<const MGMatrixBase<VectorType>, Multigrid<VectorType> > Multigrid< VectorType >::matrix

private

The matrix for each level.

Definition at line 392 of file multigrid.h.

◆ coarse

template<typename VectorType >

SmartPointer<const MGCoarseGridBase<VectorType>, Multigrid<VectorType> > Multigrid< VectorType >::coarse

private

The matrix for each level.

Definition at line 398 of file multigrid.h.

◆ transfer

template<typename VectorType >

SmartPointer<const MGTransferBase<VectorType>, Multigrid<VectorType> > Multigrid< VectorType >::transfer

private

Object for grid transfer.

Definition at line 404 of file multigrid.h.

◆ pre_smooth

template<typename VectorType >

SmartPointer<const MGSmootherBase<VectorType>, Multigrid<VectorType> > Multigrid< VectorType >::pre_smooth

private

The pre-smoothing object.

Definition at line 410 of file multigrid.h.

◆ post_smooth

template<typename VectorType >

SmartPointer<const MGSmootherBase<VectorType>, Multigrid<VectorType> > Multigrid< VectorType >::post_smooth

private

The post-smoothing object.

Definition at line 416 of file multigrid.h.

◆ edge_out

template<typename VectorType >

SmartPointer<const MGMatrixBase<VectorType> > Multigrid< VectorType >::edge_out

private

Edge matrix from the interior of the refined part to the refinement edge.

Note: Only vmult is used for these matrices.

Definition at line 423 of file multigrid.h.

◆ edge_in

template<typename VectorType >

SmartPointer<const MGMatrixBase<VectorType> > Multigrid< VectorType >::edge_in

private

Transpose edge matrix from the refinement edge to the interior of the refined part.

Note: Only Tvmult is used for these matrices.

Definition at line 431 of file multigrid.h.

◆ edge_down

template<typename VectorType >

SmartPointer<const MGMatrixBase<VectorType>, Multigrid<VectorType> > Multigrid< VectorType >::edge_down

private

Edge matrix from fine to coarse.

Note: Only vmult is used for these matrices.

Definition at line 438 of file multigrid.h.

◆ edge_up

template<typename VectorType >

SmartPointer<const MGMatrixBase<VectorType>, Multigrid<VectorType> > Multigrid< VectorType >::edge_up

private

Transpose edge matrix from coarse to fine.

Note: Only Tvmult is used for these matrices.

Definition at line 445 of file multigrid.h.

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

include/deal.II/multigrid/multigrid.h

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Subscriptor functionality

Detailed Description

Member Typedef Documentation

◆ vector_type

◆ const_vector_type

Member Enumeration Documentation

◆ Cycle

Constructor & Destructor Documentation

◆ Multigrid()

Member Function Documentation

◆ reinit()

◆ cycle()

◆ vcycle()

◆ set_edge_matrices()

◆ set_edge_flux_matrices()

◆ get_maxlevel()

◆ get_minlevel()

◆ set_maxlevel()

◆ set_minlevel()

◆ set_cycle()

◆ connect_coarse_solve()

◆ connect_restriction()

◆ connect_prolongation()

◆ connect_pre_smoother_step()

◆ connect_post_smoother_step()

◆ level_v_step()

◆ level_step()

Friends And Related Function Documentation

◆ PreconditionMG

Member Data Documentation

◆ signals

◆ cycle_type

◆ minlevel

◆ maxlevel

◆ defect

◆ solution

◆ t

◆ defect2

◆ matrix

◆ coarse

◆ transfer

◆ pre_smooth

◆ post_smooth

◆ edge_out

◆ edge_in

◆ edge_down

◆ edge_up