Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Member Functions | List of all members
mg::SmootherRelaxation< RELAX, VECTOR > Class Template Reference

#include <mg_smoother.h>

Inheritance diagram for mg::SmootherRelaxation< RELAX, VECTOR >:
[legend]

Public Member Functions

 SmootherRelaxation (const unsigned int steps=1, const bool variable=false, const bool symmetric=false, const bool transpose=false)
 
template<class MATRIX2 >
void initialize (const MGLevelObject< MATRIX2 > &matrices, const typename RELAX::AdditionalData &additional_data=typename RELAX::AdditionalData())
 
template<class MATRIX2 , class DATA >
void initialize (const MGLevelObject< MATRIX2 > &matrices, const MGLevelObject< DATA > &additional_data)
 
void clear ()
 
virtual void smooth (const unsigned int level, VECTOR &u, const VECTOR &rhs) const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from MGLevelObject< RELAX >
 MGLevelObject (const unsigned int minlevel=0, const unsigned int maxlevel=0)
 
RELAX & operator[] (const unsigned int level)
 
const RELAX & operator[] (const unsigned int level) const
 
void resize (const unsigned int new_minlevel, const unsigned int new_maxlevel)
 
MGLevelObject< RELAX > & operator= (const double d)
 
void clear ()
 
unsigned int min_level () const
 
unsigned int max_level () const
 
unsigned int get_minlevel () const DEAL_II_DEPRECATED
 
unsigned int get_maxlevel () const DEAL_II_DEPRECATED
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
- Public Member Functions inherited from MGSmoother< VECTOR >
 MGSmoother (const unsigned int steps=1, const bool variable=false, const bool symmetric=false, const bool transpose=false)
 
 MGSmoother (VectorMemory< VECTOR > &mem, const unsigned int steps=1, const bool variable=false, const bool symmetric=false, const bool transpose=false) DEAL_II_DEPRECATED
 
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< VECTOR >
virtual ~MGSmootherBase ()
 

Additional Inherited Members

- Protected Attributes inherited from MGSmoother< VECTOR >
unsigned int steps
 
bool variable
 
bool symmetric
 
bool transpose
 
unsigned int debug
 
SmartPointer< VectorMemory
< VECTOR >, MGSmoother< VECTOR > > 
mem
 

Detailed Description

template<class RELAX, class VECTOR>
class mg::SmootherRelaxation< RELAX, VECTOR >

Smoother using relaxation classes.

A relaxation class is an object that has two member functions,

void step(VECTOR& x, const VECTOR& d) const;
void Tstep(VECTOR& x, const VECTOR& d) const;

performing one step of the smoothing scheme.

This class performs smoothing on each level. The operation can be controlled by several parameters. First, the relaxation parameter omega is used in the underlying relaxation method. steps is the number of relaxation steps on the finest level (on all levels if variable is off). If variable is true, the number of smoothing steps is doubled on each coarser level. This results in a method having the complexity of the W-cycle, but saving grid transfers. This is the method proposed by Bramble at al.

The option symmetric switches on alternating between the smoother and its transpose in each step as proposed by Bramble.

transpose uses the transposed smoothing operation using Tstep instead of the regular step of the relaxation scheme.

If you are using block matrices, the second initialize function offers the possibility to extract a single block for smoothing. In this case, the multigrid method must be used only with the vector associated to that single block.

Author
Guido Kanschat,
Date
2003, 2009, 2010

Definition at line 234 of file mg_smoother.h.

Constructor & Destructor Documentation

template<class RELAX, class VECTOR >
mg::SmootherRelaxation< RELAX, VECTOR >::SmootherRelaxation ( const unsigned int  steps = 1,
const bool  variable = false,
const bool  symmetric = false,
const bool  transpose = false 
)

Constructor. Sets memory and smoothing parameters.

Member Function Documentation

template<class RELAX, class VECTOR >
template<class MATRIX2 >
void mg::SmootherRelaxation< RELAX, VECTOR >::initialize ( const MGLevelObject< MATRIX2 > &  matrices,
const typename RELAX::AdditionalData &  additional_data = typename RELAX::AdditionalData() 
)

Initialize for matrices. This function initializes the smoothing operator with the same smoother for each level.

additional_data is an object of type RELAX::AdditionalData and is handed to the initialization function of the relaxation method.

template<class RELAX, class VECTOR >
template<class MATRIX2 , class DATA >
void mg::SmootherRelaxation< RELAX, VECTOR >::initialize ( const MGLevelObject< MATRIX2 > &  matrices,
const MGLevelObject< DATA > &  additional_data 
)

Initialize matrices and additional data for each level.

If minimal or maximal level of the two objects differ, the greatest common range is utilized. This way, smoothing can be restricted to certain levels even if the matrix was generated for all levels.

template<class RELAX, class VECTOR >
void mg::SmootherRelaxation< RELAX, VECTOR >::clear ( )
virtual

Initialize for matrix blocks. This function initializes the smoothing operator with the same smoother for each level.

additional_data is an object of type RELAX::AdditionalData and is handed to the initialization function of the relaxation method. Empty all vectors.

Implements MGSmootherBase< VECTOR >.

template<class RELAX, class VECTOR >
virtual void mg::SmootherRelaxation< RELAX, VECTOR >::smooth ( const unsigned int  level,
VECTOR &  u,
const VECTOR &  rhs 
) const
virtual

The actual smoothing method.

Implements MGSmootherBase< VECTOR >.

template<class RELAX, class VECTOR >
std::size_t mg::SmootherRelaxation< RELAX, VECTOR >::memory_consumption ( ) const

Memory used by this object.


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