![]() |
Reference documentation for deal.II version 8.1.0
|
#include <precondition.h>
Public Types | |
typedef types::global_dof_index | size_type |
typedef PreconditionRelaxation < MATRIX > | BaseClass |
Public Member Functions | |
void | initialize (const MATRIX &A, const typename BaseClass::AdditionalData ¶meters=typename BaseClass::AdditionalData()) |
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) |
Private Attributes | |
std::vector< std::size_t > | pos_right_of_diagonal |
Additional Inherited Members | |
![]() | |
SmartPointer< const MATRIX, PreconditionRelaxation< MATRIX > > | A |
double | relaxation |
SSOR preconditioner using matrix built-in function. The MATRIX
class used is required to have a function precondition_SSOR(VECTOR&, const VECTOR&, double)
Definition at line 577 of file precondition.h.
typedef types::global_dof_index PreconditionSSOR< MATRIX >::size_type |
Declare type for container size.
Definition at line 583 of file precondition.h.
typedef PreconditionRelaxation<MATRIX> PreconditionSSOR< MATRIX >::BaseClass |
A typedef to the base class.
Definition at line 588 of file precondition.h.
void PreconditionSSOR< MATRIX >::initialize | ( | const MATRIX & | A, |
const typename BaseClass::AdditionalData & | parameters = typename BaseClass::AdditionalData() |
||
) |
Initialize matrix and relaxation parameter. The matrix is just stored in the preconditioner object. The relaxation parameter should be larger than zero and smaller than 2 for numerical reasons. It defaults to 1.
void PreconditionSSOR< MATRIX >::vmult | ( | VECTOR & | , |
const VECTOR & | |||
) | const |
Apply preconditioner.
void PreconditionSSOR< MATRIX >::Tvmult | ( | VECTOR & | , |
const VECTOR & | |||
) | const |
Apply transpose preconditioner. Since this is a symmetric preconditioner, this function is the same as vmult().
void PreconditionSSOR< MATRIX >::step | ( | VECTOR & | x, |
const VECTOR & | rhs | ||
) | const |
Perform one step of the preconditioned Richardson iteration
void PreconditionSSOR< MATRIX >::Tstep | ( | VECTOR & | x, |
const VECTOR & | rhs | ||
) | const |
Perform one transposed step of the preconditioned Richardson iteration.
|
private |
An array that stores for each matrix row where the first position after the diagonal is located.
Definition at line 643 of file precondition.h.