Reference documentation for deal.II version 8.5.1
|
#include <deal.II/lac/precondition.h>
Classes | |
class | AdditionalData |
Public Types | |
typedef MatrixType::size_type | size_type |
Public Member Functions | |
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) |
Protected Attributes | |
SmartPointer< const MatrixType, PreconditionRelaxation< MatrixType > > | A |
double | relaxation |
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) |
Base class for other preconditioners. Here, only some common features Jacobi, SOR and SSOR preconditioners are implemented. For preconditioning, refer to derived classes.
Definition at line 384 of file precondition.h.
typedef MatrixType::size_type PreconditionRelaxation< MatrixType >::size_type |
Declare type for container size.
Definition at line 390 of file precondition.h.
void PreconditionRelaxation< MatrixType >::initialize | ( | const MatrixType & | A, |
const AdditionalData & | parameters = 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 PreconditionRelaxation< MatrixType >::clear | ( | ) |
Release the matrix and reset its pointer.
size_type PreconditionRelaxation< MatrixType >::m | ( | ) | const |
Return the dimension of the codomain (or range) space. Note that the matrix is of dimension \(m \times n\).
size_type PreconditionRelaxation< MatrixType >::n | ( | ) | const |
Return the dimension of the domain space. Note that the matrix is of dimension \(m \times n\).
|
protected |
Pointer to the matrix object.
Definition at line 438 of file precondition.h.
|
protected |
Relaxation parameter.
Definition at line 443 of file precondition.h.