Reference documentation for deal.II version 8.5.1
|
#include <deal.II/lac/precondition.h>
Public Types | |
typedef PreconditionRelaxation< MatrixType >::AdditionalData | AdditionalData |
Public Types inherited from PreconditionRelaxation< MatrixType > | |
typedef MatrixType::size_type | size_type |
Public Member Functions | |
template<class VectorType > | |
void | vmult (VectorType &, const VectorType &) const |
template<class VectorType > | |
void | Tvmult (VectorType &, const VectorType &) const |
template<class VectorType > | |
void | step (VectorType &x, const VectorType &rhs) const |
template<class VectorType > | |
void | Tstep (VectorType &x, const VectorType &rhs) const |
Public Member Functions inherited from PreconditionRelaxation< MatrixType > | |
void | initialize (const MatrixType &A, const AdditionalData ¶meters=AdditionalData()) |
void | clear () |
size_type | m () const |
size_type | n () const |
Public Member Functions inherited from Subscriptor | |
Subscriptor () | |
Subscriptor (const Subscriptor &) | |
Subscriptor (Subscriptor &&) | |
virtual | ~Subscriptor () |
Subscriptor & | operator= (const Subscriptor &) |
Subscriptor & | operator= (Subscriptor &&) |
void | subscribe (const char *identifier=0) const |
void | unsubscribe (const char *identifier=0) const |
unsigned int | n_subscriptions () const |
void | list_subscribers () const |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
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) |
Protected Attributes inherited from PreconditionRelaxation< MatrixType > | |
SmartPointer< const MatrixType, PreconditionRelaxation< MatrixType > > | A |
double | relaxation |
Jacobi preconditioner using matrix built-in function. The MatrixType
class used is required to have a function precondition_Jacobi(VectorType&, const VectorType&, double
). This class satisfies the relaxation concept.
Definition at line 476 of file precondition.h.
typedef PreconditionRelaxation<MatrixType>::AdditionalData PreconditionJacobi< MatrixType >::AdditionalData |
A typedef to the base class AdditionalData.
Definition at line 482 of file precondition.h.
void PreconditionJacobi< MatrixType >::vmult | ( | VectorType & | , |
const VectorType & | |||
) | const |
Apply preconditioner.
void PreconditionJacobi< MatrixType >::Tvmult | ( | VectorType & | , |
const VectorType & | |||
) | const |
Apply transpose preconditioner. Since this is a symmetric preconditioner, this function is the same as vmult().
void PreconditionJacobi< MatrixType >::step | ( | VectorType & | x, |
const VectorType & | rhs | ||
) | const |
Perform one step of the preconditioned Richardson iteration.
void PreconditionJacobi< MatrixType >::Tstep | ( | VectorType & | x, |
const VectorType & | rhs | ||
) | const |
Perform one transposed step of the preconditioned Richardson iteration.