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

Richardson preconditioner. More...

#include <dune/istl/preconditioners.hh>

Inheritance diagram for Dune::Richardson< X, Y >:
Dune::Preconditioner< X, Y >

Public Types

enum  { category =SolverCategory::sequential }
 
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

 Richardson (field_type w=1.0)
 Constructor. More...
 
virtual void pre (X &x, Y &b)
 Prepare the preconditioner. More...
 
virtual void apply (X &v, const Y &d)
 Apply the precondioner. More...
 
virtual void post (X &x)
 Clean up. More...
 

Detailed Description

template<class X, class Y>
class Dune::Richardson< X, Y >

Richardson preconditioner.

Multiply simply by a constant.

Template Parameters
XType of the update
YType of the defect

Member Typedef Documentation

template<class X , class Y >
typedef X Dune::Richardson< X, Y >::domain_type

The domain type of the preconditioner.

template<class X , class Y >
typedef X::field_type Dune::Richardson< X, Y >::field_type

The field type of the preconditioner.

template<class X , class Y >
typedef Y Dune::Richardson< X, Y >::range_type

The range type of the preconditioner.

Member Enumeration Documentation

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

The category the preconditioner is part of.

Constructor & Destructor Documentation

template<class X , class Y >
Dune::Richardson< X, Y >::Richardson ( field_type  w = 1.0)
inline

Constructor.

 Constructor gets all parameters to operate the prec.
Parameters
wThe relaxation factor.

Member Function Documentation

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

Apply the precondioner.

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

Implements Dune::Preconditioner< X, Y >.

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

Clean up.

Clean up.

Implements Dune::Preconditioner< X, Y >.

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