dune-istl
2.9.0
|
The sequential jacobian preconditioner. More...
#include <dune/istl/preconditioners.hh>
Public Types | |
typedef M | matrix_type |
The matrix type the preconditioner is for. More... | |
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... | |
typedef Simd::Scalar< field_type > | scalar_field_type |
scalar type underlying the field_type More... | |
typedef FieldTraits< scalar_field_type >::real_type | real_field_type |
real scalar type underlying the field_type More... | |
Public Member Functions | |
SeqJac (const M &A, int n, real_field_type w) | |
Constructor. More... | |
SeqJac (const std::shared_ptr< const AssembledLinearOperator< M, X, Y >> &A, const ParameterTree &configuration) | |
Constructor. More... | |
SeqJac (const M &A, const ParameterTree &configuration) | |
Constructor. More... | |
virtual void | pre ([[maybe_unused]] X &x, [[maybe_unused]] Y &b) |
Prepare the preconditioner. More... | |
virtual void | apply (X &v, const Y &d) |
Apply the preconditioner. More... | |
virtual void | post ([[maybe_unused]] X &x) |
Clean up. More... | |
virtual SolverCategory::Category | category () const |
Category of the preconditioner (see SolverCategory::Category) More... | |
virtual void | pre (X &x, Y &b)=0 |
Prepare the preconditioner. More... | |
virtual void | post (X &x)=0 |
Clean up. More... | |
The sequential jacobian preconditioner.
Wraps the naked ISTL generic block Jacobi 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::SeqJac< M, X, Y, l >::domain_type |
The domain type of the preconditioner.
typedef X::field_type Dune::SeqJac< M, X, Y, l >::field_type |
The field type of the preconditioner.
typedef M Dune::SeqJac< M, X, Y, l >::matrix_type |
The matrix type the preconditioner is for.
typedef Y Dune::SeqJac< M, X, Y, l >::range_type |
The range type of the preconditioner.
typedef FieldTraits<scalar_field_type>::real_type Dune::SeqJac< M, X, Y, l >::real_field_type |
real scalar type underlying the field_type
typedef Simd::Scalar<field_type> Dune::SeqJac< M, X, Y, l >::scalar_field_type |
scalar type underlying the field_type
|
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. |
|
inline |
Constructor.
A | The assembled linear operator to use. |
configuration | ParameterTree containing preconditioner parameters. |
ParameterTree Key | Meaning |
---|---|
iterations | The number of iterations to perform. default=1 |
relaxation | The relaxation factor. default=1.0 |
See ISTL_Factory for the ParameterTree layout and examples.
|
inline |
Constructor.
A | The matrix to operate on. |
configuration | ParameterTree containing preconditioner parameters. |
ParameterTree Key | Meaning |
---|---|
iterations | The number of iterations to perform. default=1 |
relaxation | The relaxation factor. default=1.0 |
See ISTL_Factory for the ParameterTree layout and examples.
|
inlinevirtual |
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 >.
|
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. |
|
pure virtualinherited |
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. |
Implemented in Dune::BlockPreconditioner< X, Y, C, P >, Dune::NonoverlappingBlockPreconditioner< C, P >, Dune::InverseOperator2Preconditioner< O, c >, Dune::Amg::KAMG< M, X, S, PI, K, A >, Dune::Amg::FastAMG< M, X, PI, A >, Dune::Amg::AMG< M, X, S, PI, A >, Dune::Amg::AMG< M, X, S, SequentialInformation, std::allocator< X > >, and Dune::Amg::AMG< Operator, X, Smoother >.
|
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. |
|
pure virtualinherited |
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. |
Implemented in Dune::BlockPreconditioner< X, Y, C, P >, Dune::NonoverlappingBlockPreconditioner< C, P >, Dune::InverseOperator2Preconditioner< O, c >, Dune::Amg::KAMG< M, X, S, PI, K, A >, Dune::Amg::FastAMG< M, X, PI, A >, Dune::Amg::AMG< M, X, S, PI, A >, Dune::Amg::AMG< M, X, S, SequentialInformation, std::allocator< X > >, and Dune::Amg::AMG< Operator, X, Smoother >.