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

A parallel SSOR preconditioner. More...

#include <dune/istl/schwarz.hh>

Inheritance diagram for Dune::ParSSOR< M, X, Y, C >:
Dune::Preconditioner< X, Y >

Public Types

enum  { category =SolverCategory::overlapping }
 
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...
 
typedef C communication_type
 The type of the communication object. More...
 

Public Member Functions

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

Detailed Description

template<class M, class X, class Y, class C>
class Dune::ParSSOR< M, X, Y, C >

A parallel SSOR preconditioner.

Member Typedef Documentation

template<class M, class X, class Y, class C>
typedef C Dune::ParSSOR< M, X, Y, C >::communication_type

The type of the communication object.

template<class M, class X, class Y, class C>
typedef X Dune::ParSSOR< M, X, Y, C >::domain_type

The domain type of the preconditioner.

template<class M, class X, class Y, class C>
typedef X::field_type Dune::ParSSOR< M, X, Y, C >::field_type

The field type of the preconditioner.

template<class M, class X, class Y, class C>
typedef M Dune::ParSSOR< M, X, Y, C >::matrix_type

The matrix type the preconditioner is for.

template<class M, class X, class Y, class C>
typedef Y Dune::ParSSOR< M, X, Y, C >::range_type

The range type of the preconditioner.

Member Enumeration Documentation

template<class M, class X, class Y, class C>
anonymous enum
Enumerator
category 

The category the precondtioner is part of.

Constructor & Destructor Documentation

template<class M, class X, class Y, class C>
Dune::ParSSOR< M, X, Y, C >::ParSSOR ( const matrix_type A,
int  n,
field_type  w,
const communication_type c 
)
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.
cThe communication object for syncing overlap and copy data points. (E.~g. OwnerOverlapCommunication )

Member Function Documentation

template<class M, class X, class Y, class C>
virtual void Dune::ParSSOR< M, X, Y, C >::apply ( X &  v,
const Y &  d 
)
inlinevirtual

Apply the precondtioner.

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

Implements Dune::Preconditioner< X, Y >.

References Dune::bsorb(), and Dune::bsorf().

template<class M, class X, class Y, class C>
virtual void Dune::ParSSOR< M, X, Y, C >::post ( X &  x)
inlinevirtual

Clean up.

Clean up.

Implements Dune::Preconditioner< X, Y >.

template<class M, class X, class Y, class C>
virtual void Dune::ParSSOR< M, X, Y, C >::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: