dune-istl  2.2.1
Public Types | Public Member Functions | List of all members
Dune::SeqGS< M, X, Y, l > Class Template Reference

Sequential Gauss Seidel preconditioner. More...

#include <dune/istl/preconditioners.hh>

Inheritance diagram for Dune::SeqGS< M, X, Y, l >:
Dune::Preconditioner< X, Y >

Public Types

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

Public Member Functions

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

Detailed Description

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

Sequential Gauss Seidel preconditioner.

Wraps the naked ISTL generic block Gauss-Seidel preconditioner into the solver framework.

Template Parameters
MThe matrix type to operate on
XType of the update
YType of the defect
lThe block level to invert. Default is 1

Member Typedef Documentation

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

The domain type of the preconditioner.

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

The field type of the preconditioner.

template<class M, class X, class Y, int l = 1>
typedef M Dune::SeqGS< 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::SeqGS< M, X, Y, l >::range_type

The range type of the preconditioner.

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::SeqGS< M, X, Y, l >::SeqGS ( const M &  A,
int  n,
field_type  w 
)
inline

Constructor.

Constructor gets all parameters to operate the prec.

Parameters
AThe matrix to operate on.
nThe number of iterations to perform.
wThe relaxation factor.

References Dune::CheckIfDiagonalPresent< Matrix, blocklevel, l >::check().

Member Function Documentation

template<class M, class X, class Y, int l = 1>
virtual void Dune::SeqGS< M, X, Y, l >::apply ( X &  v,
const Y &  d 
)
inlinevirtual

Apply the preconditioner.

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

Implements Dune::Preconditioner< X, Y >.

References Dune::dbgs().

template<class M, class X, class Y, int l = 1>
virtual void Dune::SeqGS< M, X, Y, l >::post ( X &  x)
inlinevirtual

Clean up.

Clean up.

Implements Dune::Preconditioner< X, Y >.

template<class M, class X, class Y, int l = 1>
virtual void Dune::SeqGS< M, X, Y, l >::pre ( X &  x,
Y &  b 
)
inlinevirtual

Prepare the preconditioner.

Prepare the preconditioner.

Implements Dune::Preconditioner< X, Y >.


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