Reference documentation for deal.II version Git 05e4468 2017-09-21 10:18:23 +0200
sparse_ilu.h
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 1999 - 2015 by the deal.II authors
4 //
5 // This file is part of the deal.II library.
6 //
7 // The deal.II library is free software; you can use it, redistribute
8 // it, and/or modify it under the terms of the GNU Lesser General
9 // Public License as published by the Free Software Foundation; either
10 // version 2.1 of the License, or (at your option) any later version.
11 // The full text of the license can be found in the file LICENSE at
12 // the top level of the deal.II distribution.
13 //
14 // ---------------------------------------------------------------------
15 
16 
17 #ifndef dealii_sparse_ilu_h
18 #define dealii_sparse_ilu_h
19 
20 
21 #include <deal.II/base/config.h>
22 #include <deal.II/lac/sparse_matrix.h>
23 #include <deal.II/lac/sparse_decomposition.h>
24 #include <deal.II/lac/exceptions.h>
25 
26 DEAL_II_NAMESPACE_OPEN
27 
59 template <typename number>
60 class SparseILU : public SparseLUDecomposition<number>
61 {
62 public:
67 
74  SparseILU () = default;
75 
80  typedef
83 
101  template <typename somenumber>
102  void initialize (const SparseMatrix<somenumber> &matrix,
103  const AdditionalData &parameters = AdditionalData());
104 
111  template <typename somenumber>
112  void vmult (Vector<somenumber> &dst,
113  const Vector<somenumber> &src) const;
114 
115 
122  template <typename somenumber>
123  void Tvmult (Vector<somenumber> &dst,
124  const Vector<somenumber> &src) const;
125 
126 
131  std::size_t memory_consumption () const;
132 
142  double,
143  << "The strengthening parameter " << arg1
144  << " is not greater or equal than zero!");
149  size_type,
150  << "While computing the ILU decomposition, the algorithm "
151  "found a zero pivot on the diagonal of row "
152  << arg1
153  << ". This must stop the ILU algorithm because it means "
154  "that the matrix for which you try to compute a "
155  "decomposition is singular.");
157 };
158 
160 //---------------------------------------------------------------------------
161 
162 
163 DEAL_II_NAMESPACE_CLOSE
164 
165 #endif // dealii_sparse_ilu_h
SparseMatrix< number >::size_type size_type
static::ExceptionBase & ExcInvalidStrengthening(double arg1)
SparseILU()=default
SparseLUDecomposition< number >::size_type size_type
Definition: sparse_ilu.h:66
#define DeclException1(Exception1, type1, outsequence)
Definition: exceptions.h:593
void Tvmult(Vector< somenumber > &dst, const Vector< somenumber > &src) const
static::ExceptionBase & ExcZeroPivot(size_type arg1)
void initialize(const SparseMatrix< somenumber > &matrix, const AdditionalData &parameters=AdditionalData())
std::size_t memory_consumption() const
void vmult(Vector< somenumber > &dst, const Vector< somenumber > &src) const
SparseLUDecomposition< number >::AdditionalData AdditionalData
Definition: sparse_ilu.h:82