- Home
- About DUNE
- Download
- Documentation
- Community
- Development
Sequential SOR preconditioner. More...
#include <dune/istl/preconditioners.hh>
Public Types | |
enum | { category = SolverCategory::sequential } |
typedef M | matrix_type |
The matrix type the preconditioner is for. | |
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. | |
Public Member Functions | |
SeqSOR (const M &A, int n, field_type w) | |
Constructor. | |
virtual void | pre (X &x, Y &b) |
Prepare the preconditioner. | |
virtual void | apply (X &v, const Y &d) |
Apply the preconditioner. | |
template<bool forward> | |
void | apply (X &v, const Y &d) |
Apply the preconditioner in a special direction. | |
virtual void | post (X &x) |
Clean up. |
Sequential SOR preconditioner.
Wraps the naked ISTL generic SOR preconditioner into the solver framework.
M | The matrix type to operate on | |
X | Type of the update | |
Y | Type of the defect | |
l | The block level to invert. Default is 1 |
typedef X Dune::SeqSOR< M, X, Y, l >::domain_type |
The domain type of the preconditioner.
Reimplemented from Dune::Preconditioner< X, Y >.
typedef X::field_type Dune::SeqSOR< M, X, Y, l >::field_type |
The field type of the preconditioner.
Reimplemented from Dune::Preconditioner< X, Y >.
typedef M Dune::SeqSOR< M, X, Y, l >::matrix_type |
The matrix type the preconditioner is for.
typedef Y Dune::SeqSOR< M, X, Y, l >::range_type |
The range type of the preconditioner.
Reimplemented from Dune::Preconditioner< X, Y >.
anonymous enum |
Dune::SeqSOR< M, X, Y, l >::SeqSOR | ( | const M & | A, | |
int | n, | |||
field_type | w | |||
) | [inline] |
Constructor.
constructor gets all parameters to operate the prec.
A | The matrix to operate on. | |
n | The number of iterations to perform. | |
w | The relaxation factor. |
virtual void Dune::SeqSOR< M, X, Y, l >::apply | ( | X & | v, | |
const Y & | d | |||
) | [inline, virtual] |
Apply the preconditioner.
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 where
is the approximate inverse of the operator
characterizing the preconditioner.
[out] | v | The update to be computed |
d | The current defect. |
Implements Dune::Preconditioner< X, Y >.
void Dune::SeqSOR< M, X, Y, l >::apply | ( | X & | v, | |
const Y & | d | |||
) | [inline, virtual] |
Apply the preconditioner in a special direction.
The template parameter forward indications the direction the smoother is applied. If true The application is started at the lowest index in the vector v, if false at the highest index of vector v.
Implements Dune::Preconditioner< X, Y >.
References Dune::bsorb(), and Dune::bsorf().
virtual void Dune::SeqSOR< M, X, Y, l >::post | ( | X & | x | ) | [inline, virtual] |
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 >.
virtual void Dune::SeqSOR< M, X, Y, l >::pre | ( | X & | x, | |
Y & | b | |||
) | [inline, virtual] |
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 >.
Generated on Fri Apr 29 2011 with Doxygen (ver 1.7.1) [doxygen-log,error-log].