/usr/include/deal.II/lac/iterative_inverse.h is in libdeal.ii-dev 8.1.0-6ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | // ---------------------------------------------------------------------
// $Id: iterative_inverse.h 30036 2013-07-18 16:55:32Z maier $
//
// Copyright (C) 1999 - 2013 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------
#ifndef __deal2__iterative_inverse_h
#define __deal2__iterative_inverse_h
#include <deal.II/base/config.h>
#include <deal.II/base/smartpointer.h>
#include <deal.II/lac/solver_selector.h>
#include <deal.II/lac/vector_memory.h>
#include <deal.II/lac/pointer_matrix.h>
DEAL_II_NAMESPACE_OPEN
/**
* Implementation of the inverse of a matrix, using an iterative
* method.
*
* The function vmult() of this class starts an iterative solver in
* order to approximate the action of the inverse matrix.
*
* Krylov space methods like SolverCG or SolverBicgstab
* become inefficient if soution down to machine accuracy is
* needed. This is due to the fact, that round-off errors spoil the
* orthogonality of the vector sequences. Therefore, a nested
* iteration of two methods is proposed: The outer method is
* SolverRichardson, since it is robust with respect to round-of
* errors. The inner loop is an appropriate Krylov space method, since
* it is fast.
*
* @code
* // Declare related objects
*
* SparseMatrix<double> A;
* Vector<double> x;
* Vector<double> b;
* GrowingVectorMemory<Vector<double> > mem;
* ReductionControl inner_control (10, 1.e-30, 1.e-2);
* PreconditionSSOR <SparseMatrix<double> > inner_precondition;
* inner_precondition.initialize (A, 1.2);
*
* IterativeInverse<Vector<double> > precondition;
* precondition.initialize (A, inner_precondition);
* precondition.solver.select("cg");
* precondition.solver.set_control(inner_control);
*
* SolverControl outer_control(100, 1.e-16);
* SolverRichardson<Vector<double> > outer_iteration;
*
* outer_iteration.solve (A, x, b, precondition);
* @endcode
*
* Each time we call the inner loop, reduction of the residual by a
* factor <tt>1.e-2</tt> is attempted. Since the right hand side vector of
* the inner iteration is the residual of the outer loop, the relative
* errors are far from machine accuracy, even if the errors of the
* outer loop are in the range of machine accuracy.
*
* @ingroup Matrix2
* @author Guido Kanschat
* @date 2010
*/
template <class VECTOR>
class IterativeInverse : public Subscriptor
{
public:
/**
* Initialization
* function. Provide a matrix and
* preconditioner for the solve in
* vmult().
*/
template <class MATRIX, class PRECONDITION>
void initialize (const MATRIX &, const PRECONDITION &);
/**
* Delete the pointers to matrix
* and preconditioner.
*/
void clear();
/**
* Solve for right hand side <tt>src</tt>.
*/
void vmult (VECTOR &dst, const VECTOR &src) const;
/**
* Solve for right hand side <tt>src</tt>, but allow for the fact
* that the vectors given to this function have different type from
* the vectors used by the inner solver.
*/
template <class VECTOR2>
void vmult (VECTOR2 &dst, const VECTOR2 &src) const;
/**
* The solver, which allows
* selection of the actual solver
* as well as adjuxtment of
* parameters.
*/
SolverSelector<VECTOR> solver;
private:
/**
* The matrix in use.
*/
std_cxx1x::shared_ptr<PointerMatrixBase<VECTOR> > matrix;
/**
* The preconditioner to use.
*/
std_cxx1x::shared_ptr<PointerMatrixBase<VECTOR> > preconditioner;
};
template <class VECTOR>
template <class MATRIX, class PRECONDITION>
inline
void
IterativeInverse<VECTOR>::initialize(const MATRIX &m, const PRECONDITION &p)
{
// dummy variable
VECTOR *v = 0;
matrix = std_cxx1x::shared_ptr<PointerMatrixBase<VECTOR> > (new_pointer_matrix_base(m, *v));
preconditioner = std_cxx1x::shared_ptr<PointerMatrixBase<VECTOR> > (new_pointer_matrix_base(p, *v));
}
template <class VECTOR>
inline
void
IterativeInverse<VECTOR>::clear()
{
matrix = 0;
preconditioner = 0;
}
template <class VECTOR>
inline void
IterativeInverse<VECTOR>::vmult (VECTOR &dst, const VECTOR &src) const
{
Assert(matrix.get() != 0, ExcNotInitialized());
Assert(preconditioner.get() != 0, ExcNotInitialized());
dst = 0.;
solver.solve(*matrix, dst, src, *preconditioner);
}
template <class VECTOR>
template <class VECTOR2>
inline void
IterativeInverse<VECTOR>::vmult (VECTOR2 &dst, const VECTOR2 &src) const
{
Assert(matrix.get() != 0, ExcNotInitialized());
Assert(preconditioner.get() != 0, ExcNotInitialized());
GrowingVectorMemory<VECTOR> mem;
typename VectorMemory<VECTOR>::Pointer sol(mem);
typename VectorMemory<VECTOR>::Pointer rhs(mem);
sol->reinit(dst);
*rhs = src;
solver.solve(*matrix, *sol, *rhs, *preconditioner);
dst = *sol;
}
DEAL_II_NAMESPACE_CLOSE
#endif
|