
Public Types | |
| typedef SparseLUDecomposition < number >::AdditionalData | AdditionalData |
Public Member Functions | |
| SparseILU () | |
| SparseILU (const SparsityPattern &sparsity) | |
| template<typename somenumber > | |
| void | initialize (const SparseMatrix< somenumber > &matrix, const AdditionalData parameters=AdditionalData()) |
| template<typename somenumber > | |
| void | decompose (const SparseMatrix< somenumber > &matrix, const double strengthen_diagonal=0.) |
| template<typename somenumber > | |
| void | apply_decomposition (Vector< somenumber > &dst, const Vector< somenumber > &src) const |
| template<typename somenumber > | |
| void | vmult (Vector< somenumber > &dst, const Vector< somenumber > &src) const |
| template<typename somenumber > | |
| void | Tvmult (Vector< somenumber > &dst, const Vector< somenumber > &src) const |
| std::size_t | memory_consumption () const |
Static Public Member Functions | |
| ::ExceptionBase & | ExcInvalidStrengthening (double arg1) throw (errortext << "The strengthening parameter " << arg1 << " is not greater or equal than zero!" ) |
Incomplete LU decomposition of a sparse matrix into another sparse matrix. A given matrix is decomposed into a incomplete LU factorization, where by incomplete we mean that also a sparse decomposition is used and entries in the decomposition that do not fit into the sparsity structure of this object are discarded.
The algorithm used by this class is essentially a copy of the algorithm given in the book Y. Saad: "Iterative methods for sparse linear systems", second edition, in section 10.3.2.
Refer to SparseLUDecomposition documentation for suggested usage and state management. This class is used in the step-22 tutorial program.
<float> and <double>; others can be generated in application programs (see the section on Template instantiations in the manual).Definition at line 52 of file sparse_ilu.h.
| typedef SparseLUDecomposition<number>::AdditionalData SparseILU< number >::AdditionalData |
Make SparseLUDecomposition::AdditionalData accessible to this class as well.
Definition at line 80 of file sparse_ilu.h.
Constructor. Does nothing.
Call the initialize function before using this object as preconditioner.
| SparseILU< number >::SparseILU | ( | const SparsityPattern & | sparsity ) |
| void SparseILU< number >::initialize | ( | const SparseMatrix< somenumber > & | matrix, |
| const AdditionalData | parameters = AdditionalData() |
||
| ) |
Perform the incomplete LU factorization of the given matrix.
This function needs to be called before an object of this class is used as preconditioner.
For more details about possible parameters, see the class documentation of SparseLUDecomposition and the documentation of the SparseLUDecomposition::AdditionalData class.
According to the parameters, this function creates a new SparsityPattern or keeps the previous sparsity or takes the sparsity given by the user to data. Then, this function performs the LU decomposition.
After this function is called the preconditioner is ready to be used.
Reimplemented from SparseLUDecomposition< number >.
| void SparseILU< number >::decompose | ( | const SparseMatrix< somenumber > & | matrix, |
| const double | strengthen_diagonal = 0. |
||
| ) |
This method is deprecated, and left for backward compability. It will be removed in later versions.
Reimplemented from SparseLUDecomposition< number >.
| void SparseILU< number >::apply_decomposition | ( | Vector< somenumber > & | dst, |
| const Vector< somenumber > & | src | ||
| ) | const [inline] |
This method is deprecated, and left for backward compability. It will be removed in later versions.
Definition at line 191 of file sparse_ilu.h.
| void SparseILU< number >::vmult | ( | Vector< somenumber > & | dst, |
| const Vector< somenumber > & | src | ||
| ) | const |
Apply the incomplete decomposition, i.e. do one forward-backward step
.
The initialize() function needs to be called before.
| void SparseILU< number >::Tvmult | ( | Vector< somenumber > & | dst, |
| const Vector< somenumber > & | src | ||
| ) | const |
Apply the transpose of the incomplete decomposition, i.e. do one forward-backward step
.
The initialize() function needs to be called before.
| std::size_t SparseILU< number >::memory_consumption | ( | ) | const [virtual] |
Determine an estimate for the memory consumption (in bytes) of this object.
Reimplemented from SparseLUDecomposition< number >.
documentation generated on Fri Feb 3 2012 06:04:11 by
doxygen
1.7.2