![]() |
Reference documentation for deal.II version 8.1.0
|
#include <precondition.h>
Public Member Functions | |
template<class VECTOR > | |
void | vmult (VECTOR &, const VECTOR &) const |
template<class VECTOR > | |
void | Tvmult (VECTOR &, const VECTOR &) const |
template<class VECTOR > | |
void | step (VECTOR &x, const VECTOR &rhs) const |
template<class VECTOR > | |
void | Tstep (VECTOR &x, const VECTOR &rhs) const |
![]() | |
void | initialize (const MATRIX &A, const AdditionalData ¶meters=AdditionalData()) |
void | clear () |
![]() | |
Subscriptor () | |
Subscriptor (const Subscriptor &) | |
virtual | ~Subscriptor () |
Subscriptor & | operator= (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) |
Additional Inherited Members | |
![]() | |
SmartPointer< const MATRIX, PreconditionRelaxation< MATRIX > > | A |
double | relaxation |
SOR preconditioner using matrix built-in function.
Assuming the matrix A = D + L + U is split into its diagonal D as well as the strict lower and upper triangles L and U, then the SOR preconditioner with relaxation parameter r is
It is this operator P-1, which is implemented by vmult() through forward substitution. Analogously, Tvmult() implements the operation of r(D+rU)-1.
The SOR iteration itself can be directly written as
Using the right hand side b and the previous iterate x, this is the operation implemented by step().
The MATRIX class used is required to have functions precondition_SOR(VECTOR&, const VECTOR&, double)
and precondition_TSOR(VECTOR&, const VECTOR&, double)
.
Definition at line 516 of file precondition.h.
void PreconditionSOR< MATRIX >::vmult | ( | VECTOR & | , |
const VECTOR & | |||
) | const |
Apply preconditioner.
void PreconditionSOR< MATRIX >::Tvmult | ( | VECTOR & | , |
const VECTOR & | |||
) | const |
Apply transpose preconditioner.
void PreconditionSOR< MATRIX >::step | ( | VECTOR & | x, |
const VECTOR & | rhs | ||
) | const |
Perform one step of the preconditioned Richardson iteration.
void PreconditionSOR< MATRIX >::Tstep | ( | VECTOR & | x, |
const VECTOR & | rhs | ||
) | const |
Perform one transposed step of the preconditioned Richardson iteration.