Reference documentation for deal.II version Git d228448 2017-10-17 21:17:08 +0200
Public Member Functions | Protected Attributes | List of all members
MGSmoother< VectorType > Class Template Reference

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

Inheritance diagram for MGSmoother< VectorType >:
[legend]

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 ()=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 &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=nullptr) const
 
void unsubscribe (const char *identifier=nullptr) const
 
unsigned int n_subscriptions () 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, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *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 46 of file mg_smoother.h.

Constructor & Destructor Documentation

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

template<typename VectorType>
void MGSmoother< VectorType >::set_steps ( const unsigned  int)

Modify the number of smoothing steps on finest level.

template<typename VectorType>
void MGSmoother< VectorType >::set_variable ( const bool  )

Switch on/off variable smoothing.

template<typename VectorType>
void MGSmoother< VectorType >::set_symmetric ( const bool  )

Switch on/off symmetric smoothing.

template<typename VectorType>
void MGSmoother< VectorType >::set_transpose ( const bool  )

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

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

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 91 of file mg_smoother.h.

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 97 of file mg_smoother.h.

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 103 of file mg_smoother.h.

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 109 of file mg_smoother.h.

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 115 of file mg_smoother.h.

template<typename VectorType>
unsigned int MGSmoother< VectorType >::debug
protected

Output debugging information to deallog if this is nonzero.

Definition at line 120 of file mg_smoother.h.


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