Reference documentation for deal.II version Git f0ecfd8 2016-12-09 00:16:27 +0100
Public Types | Public Member Functions | List of all members
PreconditionJacobi< MatrixType > Class Template Reference

#include <deal.II/lac/precondition.h>

Inheritance diagram for PreconditionJacobi< MatrixType >:
[legend]

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 &parameters=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 ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (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
 

Detailed Description

template<typename MatrixType = SparseMatrix<double>>
class PreconditionJacobi< MatrixType >

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.

// Declare related objects
SolverCG<> solver(...);
//...initialize and build A
// Define and initialize preconditioner:
solver.solve (A, x, b, precondition);
Author
Guido Kanschat, 2000

Definition at line 476 of file precondition.h.

Member Typedef Documentation

template<typename MatrixType = SparseMatrix<double>>
typedef PreconditionRelaxation<MatrixType>::AdditionalData PreconditionJacobi< MatrixType >::AdditionalData

A typedef to the base class AdditionalData.

Definition at line 482 of file precondition.h.

Member Function Documentation

template<typename MatrixType = SparseMatrix<double>>
template<class VectorType >
void PreconditionJacobi< MatrixType >::vmult ( VectorType &  ,
const VectorType &   
) const

Apply preconditioner.

template<typename MatrixType = SparseMatrix<double>>
template<class VectorType >
void PreconditionJacobi< MatrixType >::Tvmult ( VectorType &  ,
const VectorType &   
) const

Apply transpose preconditioner. Since this is a symmetric preconditioner, this function is the same as vmult().

template<typename MatrixType = SparseMatrix<double>>
template<class VectorType >
void PreconditionJacobi< MatrixType >::step ( VectorType &  x,
const VectorType &  rhs 
) const

Perform one step of the preconditioned Richardson iteration.

template<typename MatrixType = SparseMatrix<double>>
template<class VectorType >
void PreconditionJacobi< MatrixType >::Tstep ( VectorType &  x,
const VectorType &  rhs 
) const

Perform one transposed step of the preconditioned Richardson iteration.


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