dune-istl  2.3beta2
Public Types | Public Member Functions | List of all members
Dune::InverseOperator2Preconditioner< O, c > Class Template Reference

Turns an InverseOperator into a Preconditioner. More...

#include <dune/istl/preconditioners.hh>

Inheritance diagram for Dune::InverseOperator2Preconditioner< O, c >:
Inheritance graph

Public Types

enum  { category = c }
typedef O::domain_type domain_type
 The domain type of the preconditioner.
typedef O::range_type range_type
 The range type of the preconditioner.
typedef range_type::field_type field_type
 The field type of the preconditioner.
typedef O InverseOperator

Public Member Functions

 InverseOperator2Preconditioner (InverseOperator &inverse_operator)
 Construct the preconditioner from the solver.
void pre (domain_type &, range_type &)
 Prepare the preconditioner.
void apply (domain_type &v, const range_type &d)
 Apply one step of the preconditioner to the system A(v)=d.
void post (domain_type &)
 Clean up.

Detailed Description

template<class O, int c>
class Dune::InverseOperator2Preconditioner< O, c >

Turns an InverseOperator into a Preconditioner.

Template Parameters
OThe type of the inverse operator to wrap.

Member Typedef Documentation

template<class O , int c>
typedef O::domain_type Dune::InverseOperator2Preconditioner< O, c >::domain_type

The domain type of the preconditioner.

template<class O , int c>
typedef range_type::field_type Dune::InverseOperator2Preconditioner< O, c >::field_type

The field type of the preconditioner.

template<class O , int c>
typedef O Dune::InverseOperator2Preconditioner< O, c >::InverseOperator
template<class O , int c>
typedef O::range_type Dune::InverseOperator2Preconditioner< O, c >::range_type

The range type of the preconditioner.

Member Enumeration Documentation

template<class O , int c>
anonymous enum
Enumerator:
category 

The category the preconditioner is part of.

Constructor & Destructor Documentation

template<class O , int c>
Dune::InverseOperator2Preconditioner< O, c >::InverseOperator2Preconditioner ( InverseOperator inverse_operator)
inline

Construct the preconditioner from the solver.

Parameters
inverse_operatorThe inverse operator to wrap.

Member Function Documentation

template<class O , int c>
void Dune::InverseOperator2Preconditioner< O, c >::apply ( domain_type v,
const range_type d 
)
inlinevirtual

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< O::domain_type, O::range_type >.

template<class O , int c>
void Dune::InverseOperator2Preconditioner< O, c >::post ( domain_type x)
inlinevirtual

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< O::domain_type, O::range_type >.

template<class O , int c>
void Dune::InverseOperator2Preconditioner< O, c >::pre ( domain_type x,
range_type b 
)
inlinevirtual

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< O::domain_type, O::range_type >.


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