Reference documentation for deal.II version GIT 6113e8d4d8 2022-09-29 15:30:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
sparse_ilu.h
Go to the documentation of this file.
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 1999 - 2020 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.md at
12 // the top level directory of deal.II.
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 
23 #include <deal.II/lac/exceptions.h>
26 
28 
59 template <typename number>
60 class SparseILU : public SparseLUDecomposition<number>
61 {
62 public:
67 
74  SparseILU() = default;
75 
81 
99  template <typename somenumber>
100  void
102  const AdditionalData & parameters = AdditionalData());
103 
110  template <typename somenumber>
111  void
112  vmult(Vector<somenumber> &dst, const Vector<somenumber> &src) const;
113 
114 
121  template <typename somenumber>
122  void
124 
125 
130  std::size_t
131  memory_consumption() const override;
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 
164 
165 #endif // dealii_sparse_ilu_h
void Tvmult(Vector< somenumber > &dst, const Vector< somenumber > &src) const
void vmult(Vector< somenumber > &dst, const Vector< somenumber > &src) const
std::size_t memory_consumption() const override
typename SparseLUDecomposition< number >::AdditionalData AdditionalData
Definition: sparse_ilu.h:80
void initialize(const SparseMatrix< somenumber > &matrix, const AdditionalData &parameters=AdditionalData())
SparseILU()=default
typename SparseMatrix< number >::size_type size_type
Definition: vector.h:109
#define DEAL_II_NAMESPACE_OPEN
Definition: config.h:457
#define DEAL_II_NAMESPACE_CLOSE
Definition: config.h:458
static ::ExceptionBase & ExcZeroPivot(size_type arg1)
static ::ExceptionBase & ExcInvalidStrengthening(double arg1)
#define DeclException1(Exception1, type1, outsequence)
Definition: exceptions.h:509
@ matrix
Contents is actually a matrix.