Reference documentation for deal.II version SVN Revision 32797
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Member Functions | Private Attributes | List of all members
PreconditionRichardson Class Reference

#include <precondition.h>

Inheritance diagram for PreconditionRichardson:
[legend]

Classes

class  AdditionalData
 

Public Member Functions

 PreconditionRichardson ()
 
void initialize (const AdditionalData &parameters)
 
template<class MATRIX >
void initialize (const MATRIX &, const AdditionalData &parameters)
 
template<class VECTOR >
void vmult (VECTOR &, const VECTOR &) const
 
template<class VECTOR >
void Tvmult (VECTOR &, const VECTOR &) const
 
template<class VECTOR >
void vmult_add (VECTOR &, const VECTOR &) const
 
template<class VECTOR >
void Tvmult_add (VECTOR &, const VECTOR &) const
 
void clear ()
 
- 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)
 

Private Attributes

double relaxation
 

Detailed Description

Preconditioning with Richardson's method. This preconditioner just scales the vector with a constant relaxation factor provided by the AdditionalData object.

In Krylov-space methods, this preconditioner should not have any effect. Using SolverRichardson, the two relaxation parameters will be just multiplied. Still, this class is useful in multigrid smoother objects (MGSmootherRelaxation).

Author
Guido Kanschat, 2005

Definition at line 159 of file precondition.h.

Constructor & Destructor Documentation

PreconditionRichardson::PreconditionRichardson ( )

Constructor, sets the relaxation parameter to its default.

Member Function Documentation

void PreconditionRichardson::initialize ( const AdditionalData parameters)

Change the relaxaton parameter.

template<class MATRIX >
void PreconditionRichardson::initialize ( const MATRIX ,
const AdditionalData parameters 
)

Change the relaxaton parameter in a way consistent with other preconditioners. The matrix argument is ignored and here just for compatibility with more complex preconditioners.

template<class VECTOR >
void PreconditionRichardson::vmult ( VECTOR &  ,
const VECTOR &   
) const

Apply preconditioner.

template<class VECTOR >
void PreconditionRichardson::Tvmult ( VECTOR &  ,
const VECTOR &   
) const

Apply transpose preconditioner. Since this is the identity, this function is the same as vmult().

template<class VECTOR >
void PreconditionRichardson::vmult_add ( VECTOR &  ,
const VECTOR &   
) const

Apply preconditioner, adding to the previous value.

template<class VECTOR >
void PreconditionRichardson::Tvmult_add ( VECTOR &  ,
const VECTOR &   
) const

Apply transpose preconditioner, adding. Since this is the identity, this function is the same as vmult_add().

void PreconditionRichardson::clear ( )
inline

This function is only present to provide the interface of a preconditioner to be handed to a smoother. This does nothing.

Definition at line 246 of file precondition.h.

Member Data Documentation

double PreconditionRichardson::relaxation
private

The relaxation parameter multiplied with the vectors.

Definition at line 253 of file precondition.h.


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