dune-istl  2.1.1
Public Types | Public Member Functions
Dune::SeqILU0< M, X, Y, l > Class Template Reference

Sequential ILU0 preconditioner. More...

#include <dune/istl/preconditioners.hh>

Inheritance diagram for Dune::SeqILU0< M, X, Y, l >:
Inheritance graph

List of all members.

Public Types

enum  { category = SolverCategory::sequential }
typedef Dune::remove_const< M >
::type 
matrix_type
 The matrix type the preconditioner is for.
typedef X domain_type
 The domain type of the preconditioner.
typedef Y range_type
 The range type of the preconditioner.
typedef X::field_type field_type
 The field type of the preconditioner.

Public Member Functions

 SeqILU0 (const M &A, field_type w)
 Constructor.
virtual void pre (X &x, Y &b)
 Prepare the preconditioner.
virtual void apply (X &v, const Y &d)
 Apply the preconditoner.
virtual void post (X &x)
 Clean up.

Detailed Description

template<class M, class X, class Y, int l = 1>
class Dune::SeqILU0< M, X, Y, l >

Sequential ILU0 preconditioner.

Wraps the naked ISTL generic ILU0 preconditioner into the solver framework.

Template Parameters:
MThe matrix type to operate on
XType of the update
YType of the defect
lIgnored. Just there to have the same number of template arguments as other preconditioners.

Member Typedef Documentation

template<class M, class X, class Y, int l = 1>
typedef X Dune::SeqILU0< M, X, Y, l >::domain_type

The domain type of the preconditioner.

Reimplemented from Dune::Preconditioner< X, Y >.

template<class M, class X, class Y, int l = 1>
typedef X::field_type Dune::SeqILU0< M, X, Y, l >::field_type

The field type of the preconditioner.

Reimplemented from Dune::Preconditioner< X, Y >.

template<class M, class X, class Y, int l = 1>
typedef Dune::remove_const<M>::type Dune::SeqILU0< M, X, Y, l >::matrix_type

The matrix type the preconditioner is for.

template<class M, class X, class Y, int l = 1>
typedef Y Dune::SeqILU0< M, X, Y, l >::range_type

The range type of the preconditioner.

Reimplemented from Dune::Preconditioner< X, Y >.


Member Enumeration Documentation

template<class M, class X, class Y, int l = 1>
anonymous enum
Enumerator:
category 

The category the preconditioner is part of.


Constructor & Destructor Documentation

template<class M, class X, class Y, int l = 1>
Dune::SeqILU0< M, X, Y, l >::SeqILU0 ( const M &  A,
field_type  w 
) [inline]

Constructor.

Constructor gets all parameters to operate the prec.

Parameters:
AThe matrix to operate on.
wThe relaxation factor.

References Dune::bilu0_decomposition().


Member Function Documentation

template<class M, class X, class Y, int l = 1>
virtual void Dune::SeqILU0< M, X, Y, l >::apply ( X &  v,
const Y &  d 
) [inline, virtual]

Apply the preconditoner.

Apply one step of the preconditioner to the system A(v)=d.

On entry v=0 and d=b-A(x) (although this might not be computed in that way. On exit v contains the update, i.e one step computes $ v = M^{-1} d $ where $ M $ is the approximate inverse of the operator $ A $ characterizing the preconditioner.

Parameters:
[out]vThe update to be computed
dThe current defect.

Implements Dune::Preconditioner< X, Y >.

References Dune::bilu_backsolve().

template<class M, class X, class Y, int l = 1>
virtual void Dune::SeqILU0< M, X, Y, l >::post ( X &  x) [inline, virtual]

Clean up.

Clean up.

This method is called after the last apply call for the linear system to be solved. Memory may be deallocated safely here. x is the solution of the linear equation.

Parameters:
xThe right hand side of the equation.

Implements Dune::Preconditioner< X, Y >.

template<class M, class X, class Y, int l = 1>
virtual void Dune::SeqILU0< M, X, Y, l >::pre ( X &  x,
Y &  b 
) [inline, virtual]

Prepare the preconditioner.

Prepare the preconditioner.

A solver solves a linear operator equation A(x)=b by applying one or several steps of the preconditioner. The method pre() is called before the first apply operation. b and x are right hand side and solution vector of the linear system respectively. It may. e.g., scale the system, allocate memory or compute a (I)LU decomposition. Note: The ILU decomposition could also be computed in the constructor or with a separate method of the derived method if several linear systems with the same matrix are to be solved.

Parameters:
xThe left hand side of the equation.
bThe right hand side of the equation.

Implements Dune::Preconditioner< X, Y >.


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