MGSmoother< VectorType > Class Template Reference

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

Inheritance diagram for MGSmoother< VectorType >:

Public Member Functions
	MGSmoother (const unsigned int steps=1, const bool variable=false, const bool symmetric=false, const bool transpose=false)
void	set_steps (const unsigned int)
void	set_variable (const bool)
void	set_symmetric (const bool)
void	set_transpose (const bool)
void	set_debug (const unsigned int level)
Public Member Functions inherited from MGSmootherBase< VectorType >
virtual	~MGSmootherBase () override=default
virtual void	clear ()=0
virtual void	smooth (const unsigned int level, VectorType &u, const VectorType &rhs) const =0
virtual void	apply (const unsigned int level, VectorType &u, const VectorType &rhs) const
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)

Protected Attributes
GrowingVectorMemory< VectorType >	vector_memory
unsigned int	steps
bool	variable
bool	symmetric
bool	transpose
unsigned int	debug

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)

Detailed Description

template<typename VectorType>
class MGSmoother< VectorType >

A base class for smoother handling information on smoothing. While not adding to the abstract interface in MGSmootherBase, this class stores information on the number and type of smoothing steps, which in turn can be used by a derived class.

Author

Guido Kanschat 2009

Definition at line 50 of file mg_smoother.h.

Constructor & Destructor Documentation

MGSmoother()

template<typename VectorType >

MGSmoother< VectorType >::MGSmoother	(	const unsigned int	steps = 1,
		const bool	variable = false,
		const bool	symmetric = false,
		const bool	transpose = false
	)

Constructor.

Member Function Documentation

set_steps()

template<typename VectorType >

void MGSmoother< VectorType >::set_steps

(

const unsigned int

)

Modify the number of smoothing steps on finest level.

set_variable()

template<typename VectorType >

void MGSmoother< VectorType >::set_variable

(

const bool

)

Switch on/off variable smoothing.

set_symmetric()

template<typename VectorType >

void MGSmoother< VectorType >::set_symmetric

(

const bool

)

Switch on/off symmetric smoothing.

set_transpose()

template<typename VectorType >

void MGSmoother< VectorType >::set_transpose

(

const bool

)

Switch on/off transposed smoothing. The effect is overridden by set_symmetric().

set_debug()

template<typename VectorType >

void MGSmoother< VectorType >::set_debug

(

const unsigned int

level

)

Set debug to a nonzero value to get debug information logged to deallog. Increase to get more information

Member Data Documentation

vector_memory

template<typename VectorType >

GrowingVectorMemory<VectorType> MGSmoother< VectorType >::vector_memory

mutableprotected

A memory object to be used for temporary vectors.

The object is marked as mutable since we will need to use it to allocate temporary vectors also in functions that are const.

Definition at line 100 of file mg_smoother.h.

steps

template<typename VectorType >

unsigned int MGSmoother< VectorType >::steps

protected

Number of smoothing steps on the finest level. If no variable smoothing is chosen, this is the number of steps on all levels.

Definition at line 106 of file mg_smoother.h.

variable

template<typename VectorType >

bool MGSmoother< VectorType >::variable

protected

Variable smoothing: double the number of smoothing steps whenever going to the next coarser level

Definition at line 112 of file mg_smoother.h.

symmetric

template<typename VectorType >

bool MGSmoother< VectorType >::symmetric

protected

Symmetric smoothing: in the smoothing iteration, alternate between the relaxation method and its transpose.

Definition at line 118 of file mg_smoother.h.

transpose

template<typename VectorType >

bool MGSmoother< VectorType >::transpose

protected

Use the transpose of the relaxation method instead of the method itself. This has no effect if symmetric smoothing is chosen.

Definition at line 124 of file mg_smoother.h.

debug

template<typename VectorType >

unsigned int MGSmoother< VectorType >::debug

protected

Output debugging information to deallog if this is nonzero.

Definition at line 129 of file mg_smoother.h.

---

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

• include/deal.II/multigrid/mg_smoother.h