
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 |
Private Attributes | |
| double | relaxation |
Classes | |
| class | AdditionalData |
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 usefull in multigrid smoother objects (MGSmootherRelaxation).
| PreconditionRichardson::PreconditionRichardson | ( | ) | [inline] |
Constructor, sets the relaxation parameter to its default.
References PreconditionRichardson::AdditionalData::relaxation, and relaxation.
| void PreconditionRichardson::initialize | ( | const AdditionalData | parameters | ) | [inline] |
Change the relaxaton parameter.
References PreconditionRichardson::AdditionalData::relaxation, and relaxation.
| void PreconditionRichardson::initialize | ( | const MATRIX & | , | |
| const AdditionalData | parameters | |||
| ) | [inline] |
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.
References PreconditionRichardson::AdditionalData::relaxation, and relaxation.
| void PreconditionRichardson::vmult | ( | VECTOR & | dst, | |
| const VECTOR & | src | |||
| ) | const [inline] |
Apply preconditioner.
References relaxation.
| void PreconditionRichardson::Tvmult | ( | VECTOR & | dst, | |
| const VECTOR & | src | |||
| ) | const [inline] |
Apply transpose preconditioner. Since this is the identity, this function is the same as vmult().
References relaxation.
| void PreconditionRichardson::vmult_add | ( | VECTOR & | dst, | |
| const VECTOR & | src | |||
| ) | const [inline] |
Apply preconditioner, adding to the previous value.
References relaxation.
| void PreconditionRichardson::Tvmult_add | ( | VECTOR & | dst, | |
| const VECTOR & | src | |||
| ) | const [inline] |
Apply transpose preconditioner, adding. Since this is the identity, this function is the same as vmult_add().
References relaxation.
double PreconditionRichardson::relaxation [private] |
The relaxation parameter multiplied with the vectors.
Referenced by initialize(), PreconditionRichardson(), Tvmult(), Tvmult_add(), vmult(), and vmult_add().
documentation generated on Fri Nov 21 07:13:24 2008 by
doxygen
1.5.6