dune-istl 2.8.0
|
Richardson preconditioner. More...
#include <dune/istl/preconditioners.hh>
Public Types | |
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. | |
typedef Simd::Scalar< field_type > | scalar_field_type |
scalar type underlying the field_type | |
typedef FieldTraits< scalar_field_type >::real_type | real_field_type |
real scalar type underlying the field_type | |
Public Member Functions | |
Richardson (real_field_type w=1.0) | |
Constructor. | |
Richardson (const ParameterTree &configuration) | |
Constructor. | |
virtual void | pre (X &x, Y &b) |
Prepare the preconditioner. | |
virtual void | apply (X &v, const Y &d) |
Apply the precondioner. | |
virtual void | post (X &x) |
Clean up. | |
virtual SolverCategory::Category | category () const |
Category of the preconditioner (see SolverCategory::Category) | |
Richardson preconditioner.
Multiply simply by a constant.
X | Type of the update |
Y | Type of the defect |
typedef X Dune::Richardson< X, Y >::domain_type |
The domain type of the preconditioner.
typedef X::field_type Dune::Richardson< X, Y >::field_type |
The field type of the preconditioner.
typedef Y Dune::Richardson< X, Y >::range_type |
The range type of the preconditioner.
typedef FieldTraits<scalar_field_type>::real_type Dune::Richardson< X, Y >::real_field_type |
real scalar type underlying the field_type
typedef Simd::Scalar<field_type> Dune::Richardson< X, Y >::scalar_field_type |
scalar type underlying the field_type
|
inline |
Constructor.
Constructor gets all parameters to operate the prec.
w | The relaxation factor. |
|
inline |
Constructor.
configuration | ParameterTree containing preconditioner parameters. |
ParameterTree Key | Meaning |
---|---|
relaxation | The relaxation factor. default=1.0 |
See ISTL_Factory for the ParameterTree layout and examples.
|
inlinevirtual |
Apply the precondioner.
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
[out] | v | The update to be computed |
d | The current defect. |
Implements Dune::Preconditioner< X, Y >.
|
inlinevirtual |
Category of the preconditioner (see SolverCategory::Category)
Implements Dune::Preconditioner< X, Y >.
|
inlinevirtual |
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.
x | The right hand side of the equation. |
Implements Dune::Preconditioner< X, Y >.
|
inlinevirtual |
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.
x | The left hand side of the equation. |
b | The right hand side of the equation. |
Implements Dune::Preconditioner< X, Y >.