A parallel SSOR preconditioner.
More...
#include <dune/istl/schwarz.hh>
template<class M, class X, class Y, class C>
class Dune::ParSSOR< M, X, Y, C >
A parallel SSOR preconditioner.
- Template Parameters
-
M | The type of the sequential matrix to use, e.g. BCRSMatrix or another matrix type fulfilling the matrix interface of ISTL. |
X | The type of the sequential vector to use for the left hand side, e.g. BlockVector or another type fulfilling the ISTL vector interface. |
Y | The type of the sequential vector to use for the right hand side, e..g. BlockVector or another type fulfilling the ISTL vector interface. |
C | The type of the communication object. This must either be OwnerOverlapCopyCommunication or a type implementing the same interface. |
◆ communication_type
template<class M , class X , class Y , class C >
The type of the communication object.
◆ domain_type
template<class M , class X , class Y , class C >
The domain type of the preconditioner.
◆ field_type
template<class M , class X , class Y , class C >
The field type of the preconditioner.
◆ matrix_type
template<class M , class X , class Y , class C >
The matrix type the preconditioner is for.
◆ range_type
template<class M , class X , class Y , class C >
The range type of the preconditioner.
◆ ParSSOR()
template<class M , class X , class Y , class C >
Constructor.
constructor gets all parameters to operate the prec.
- Parameters
-
A | The matrix to operate on. |
n | The number of iterations to perform. |
w | The relaxation factor. |
c | The communication object for syncing overlap and copy data points. (E.~g. OwnerOverlapCopyCommunication ) |
◆ apply()
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. 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.
- Parameters
-
[out] | v | The update to be computed |
| d | The current defect. |
Implements Dune::Preconditioner< X, Y >.
◆ category()
template<class M , class X , class Y , class C >
◆ post()
template<class M , class X , class Y , class C >
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.
- Parameters
-
x | The right hand side of the equation. |
Implements Dune::Preconditioner< X, Y >.
◆ pre()
template<class M , class X , class Y , class C >
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.
- Note
- if a preconditioner is copied (e.g. for a second thread) again the pre() method has to be called to ensure proper memory mangement.
X x(0.0);
Y b = ...;
Preconditioner<X,Y> prec(...);
prec.pre(x,b);
prec.apply(x,b);
prec.post(x);
- Parameters
-
x | The left hand side of the equation. |
b | The right hand side of the equation. |
Implements Dune::Preconditioner< X, Y >.
The documentation for this class was generated from the following file: