Reference documentation for deal.II version SVN Revision 32783
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Member Functions | Protected Attributes | List of all members
PreconditionRelaxation< MATRIX > Class Template Reference

#include <precondition.h>

Inheritance diagram for PreconditionRelaxation< MATRIX >:
[legend]

Classes

class  AdditionalData
 

Public Member Functions

void initialize (const MATRIX &A, const AdditionalData &parameters=AdditionalData())
 
void clear ()
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (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)
 

Protected Attributes

SmartPointer< const MATRIX,
PreconditionRelaxation< MATRIX > > 
A
 
double relaxation
 

Detailed Description

template<class MATRIX = SparseMatrix<double>>
class PreconditionRelaxation< MATRIX >

Base class for other preconditioners. Here, only some common features Jacobi, SOR and SSOR preconditioners are implemented. For preconditioning, refer to derived classes.

Author
Guido Kanschat, 2000

Definition at line 353 of file precondition.h.

Member Function Documentation

template<class MATRIX = SparseMatrix<double>>
void PreconditionRelaxation< MATRIX >::initialize ( const MATRIX 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.

template<class MATRIX = SparseMatrix<double>>
void PreconditionRelaxation< MATRIX >::clear ( )

Release the matrix and reset its pointer.

Member Data Documentation

template<class MATRIX = SparseMatrix<double>>
SmartPointer<const MATRIX, PreconditionRelaxation<MATRIX> > PreconditionRelaxation< MATRIX >::A
protected

Pointer to the matrix object.

Definition at line 396 of file precondition.h.

template<class MATRIX = SparseMatrix<double>>
double PreconditionRelaxation< MATRIX >::relaxation
protected

Relaxation parameter.

Definition at line 401 of file precondition.h.


The documentation for this class was generated from the following file: