/usr/include/deal.II/lac/precondition_selector.h is in libdeal.ii-dev 8.4.2-2+b1.
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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | // ---------------------------------------------------------------------
//
// Copyright (C) 1999 - 2015 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 dealii__precondition_selector_h
#define dealii__precondition_selector_h
#include <deal.II/base/config.h>
#include <deal.II/base/smartpointer.h>
#include <string>
DEAL_II_NAMESPACE_OPEN
template <class number> class Vector;
template <class number> class SparseMatrix;
/*! @addtogroup Preconditioners
*@{
*/
/**
* Selects the preconditioner. The constructor of this class takes the name of
* the preconditioning and the damping parameter @p omega of the
* preconditioning and the @p use_matrix function takes the matrix that is
* used by the matrix-builtin precondition functions. Each time, the
* <tt>operator()</tt> function is called, this preselected preconditioner,
* this matrix and this @p omega is used for the preconditioning. This class
* is designed for being used as argument of the @p solve function of a @p
* Solver and it covers the selection of all matrix-builtin precondition
* functions. The selection of other preconditioners, like BlockSOR or ILU
* should be handled in derived classes by the user.
*
* <h3>Usage</h3> The simplest use of this class is the following:
* @code
* // generate a @p SolverControl and
* // a @p VectorMemory
* SolverControl control;
* VectorMemory<Vector<double> > memory;
* // generate a solver
* SolverCG<SparseMatrix<double>, Vector<double> > solver(control, memory);
* // generate a @p PreconditionSelector
* PreconditionSelector<SparseMatrix<double>, Vector<double> >
* preconditioning("jacobi", 1.);
* // give a matrix whose diagonal entries
* // are to be used for the preconditioning.
* // Generally the matrix of the linear
* // equation system Ax=b.
* preconditioning.use_matrix(A);
* // call the @p solve function with this
* // preconditioning as last argument
* solver.solve(A,x,b,preconditioning);
* @endcode
* The same example where also the @p SolverSelector class is used reads
* @code
* // generate a @p SolverControl and
* // a @p VectorMemory
* SolverControl control;
* VectorMemory<Vector<double> > memory;
* // generate a @p SolverSelector that
* // calls the @p SolverCG
* SolverSelector<SparseMatrix<double>, Vector<double> >
* solver_selector("cg", control, memory);
* // generate a @p PreconditionSelector
* PreconditionSelector<SparseMatrix<double>, Vector<double> >
* preconditioning("jacobi", 1.);
*
* preconditioning.use_matrix(A);
*
* solver_selector.solve(A,x,b,preconditioning);
* @endcode
* Now the use of the @p SolverSelector in combination with the @p
* PreconditionSelector allows the user to select both, the solver and the
* preconditioner, at the beginning of his program and each time the solver is
* started (that is several times e.g. in a nonlinear iteration) this
* preselected solver and preconditioner is called.
*
* @author Ralf Hartmann, 1999; extension for full compatibility with
* LinearOperator class: Jean-Paul Pelteret, 2015
*/
template <typename MatrixType = SparseMatrix<double>,
typename VectorType = dealii::Vector<double> >
class PreconditionSelector : public Subscriptor
{
public:
/**
* Declare type for container size.
*/
typedef typename MatrixType::size_type size_type;
/**
* Constructor. @p omega denotes the damping parameter of the
* preconditioning.
*/
PreconditionSelector (const std::string &preconditioning,
const typename VectorType::value_type &omega=1.);
/**
* Destructor.
*/
virtual ~PreconditionSelector();
/**
* Takes the matrix that is needed for preconditionings that involves a
* matrix. e.g. for @p precondition_jacobi, <tt>~_sor</tt>, <tt>~_ssor</tt>.
*/
void use_matrix(const MatrixType &M);
/**
* Return the dimension of the codomain (or range) space. To remember: the
* matrix is of dimension $m \times n$.
*/
size_type m () const;
/**
* Return the dimension of the domain space. To remember: the matrix is of
* dimension $m \times n$.
*/
size_type n () const;
/**
* Precondition procedure. Calls the preconditioning that was specified in
* the constructor.
*/
virtual void vmult (VectorType &dst, const VectorType &src) const;
/**
* Transpose precondition procedure. Calls the preconditioning that was
* specified in the constructor.
*/
virtual void Tvmult (VectorType &dst, const VectorType &src) const;
/**
* Get the names of all implemented preconditionings.
*/
static std::string get_precondition_names();
/**
* @addtogroup Exceptions
* @{
*/
/**
* Exception.
*/
DeclException0 (ExcNoMatrixGivenToUse);
//@}
protected:
/**
* Stores the name of the preconditioning.
*/
std::string preconditioning;
private:
/**
* Matrix that is used for the matrix-builtin preconditioning function. cf.
* also @p PreconditionUseMatrix.
*/
SmartPointer<const MatrixType,PreconditionSelector<MatrixType,VectorType> > A;
/**
* Stores the damping parameter of the preconditioner.
*/
const typename VectorType::value_type omega;
};
/*@}*/
/* --------------------- Inline and template functions ------------------- */
template <typename MatrixType, typename VectorType>
PreconditionSelector<MatrixType,VectorType>
::PreconditionSelector(const std::string &preconditioning,
const typename VectorType::value_type &omega) :
preconditioning(preconditioning),
omega(omega) {}
template <typename MatrixType, typename VectorType>
PreconditionSelector<MatrixType,VectorType>::~PreconditionSelector()
{
// release the matrix A
A=0;
}
template <typename MatrixType, typename VectorType>
void PreconditionSelector<MatrixType,VectorType>::use_matrix(const MatrixType &M)
{
A=&M;
}
template <typename MatrixType, typename VectorType>
inline typename PreconditionSelector<MatrixType,VectorType>::size_type
PreconditionSelector<MatrixType,VectorType>::m () const
{
Assert(A!=0, ExcNoMatrixGivenToUse());
return A->m();
}
template <typename MatrixType, typename VectorType>
inline typename PreconditionSelector<MatrixType,VectorType>::size_type
PreconditionSelector<MatrixType,VectorType>::n () const
{
Assert(A!=0, ExcNoMatrixGivenToUse());
return A->n();
}
template <typename MatrixType, typename VectorType>
void PreconditionSelector<MatrixType,VectorType>::vmult (VectorType &dst,
const VectorType &src) const
{
if (preconditioning=="none")
{
dst=src;
}
else
{
Assert(A!=0, ExcNoMatrixGivenToUse());
if (preconditioning=="jacobi")
{
A->precondition_Jacobi(dst,src,omega);
}
else if (preconditioning=="sor")
{
A->precondition_SOR(dst,src,omega);
}
else if (preconditioning=="ssor")
{
A->precondition_SSOR(dst,src,omega);
}
else
Assert(false,ExcNotImplemented());
}
}
template <typename MatrixType, typename VectorType>
void PreconditionSelector<MatrixType,VectorType>::Tvmult (VectorType &dst,
const VectorType &src) const
{
if (preconditioning=="none")
{
dst=src;
}
else
{
Assert(A!=0, ExcNoMatrixGivenToUse());
if (preconditioning=="jacobi")
{
A->precondition_Jacobi(dst,src,omega); // Symmetric operation
}
else if (preconditioning=="sor")
{
A->precondition_TSOR(dst,src,omega);
}
else if (preconditioning=="ssor")
{
A->precondition_SSOR(dst,src,omega); // Symmetric operation
}
else
Assert(false,ExcNotImplemented());
}
}
template <typename MatrixType, typename VectorType>
std::string PreconditionSelector<MatrixType,VectorType>::get_precondition_names()
{
return "none|jacobi|sor|ssor";
}
DEAL_II_NAMESPACE_CLOSE
#endif
|