/usr/include/libmesh/preconditioner.h is in libmesh-dev 0.7.1-2ubuntu1.
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 | // $Id: preconditioner.h 3874 2010-07-02 21:57:26Z roystgnr $
// The libMesh Finite Element Library.
// Copyright (C) 2002-2008 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
// This library is free software; you can 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.
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#ifndef __preconditioner_h__
#define __preconditioner_h__
// C++ includes
// Local includes
#include "libmesh_common.h"
#include "enum_solver_package.h"
#include "enum_solver_type.h"
#include "enum_preconditioner_type.h"
#include "reference_counted_object.h"
#include "libmesh.h"
namespace libMesh
{
// forward declarations
template <typename T> class AutoPtr;
template <typename T> class SparseMatrix;
template <typename T> class NumericVector;
template <typename T> class ShellMatrix;
/**
* This class provides a uniform interface for preconditioners. This base
* class is overloaded to provide linear solvers from different packages
* like PETSC or Trilinos.
*
* In the below comments P is the matrix to be preconditioned with Apply()
* performing the equivalent of the matrix vector product P^-1 x. This
* can also be thought of as (usually approximately) solving for Py=x.
*
* @author Derek Gaston, 2009
*/
template <typename T>
class Preconditioner : public ReferenceCountedObject<Preconditioner<T> >
{
public:
/**
* Constructor. Initializes Preconditioner data structures
*/
Preconditioner ();
/**
* Destructor.
*/
virtual ~Preconditioner ();
/**
* Builds a \p Preconditioner using the linear solver package specified by
* \p solver_package
*/
static Preconditioner<T> * build(const SolverPackage solver_package =
libMesh::default_solver_package());
/**
* @returns true if the data structures are
* initialized, false otherwise.
*/
bool initialized () const { return _is_initialized; }
/**
* Computes the preconditioned vector "y" based on input "x".
* Usually by solving Py=x to get the action of P^-1 x.
*/
virtual void apply(const NumericVector<T> & x, NumericVector<T> & y) = 0;
/**
* Release all memory and clear data structures.
*/
virtual void clear () {}
/**
* Initialize data structures if not done so already.
*/
virtual void init () {};
/**
* Sets the matrix P to be preconditioned.
*/
void set_matrix(SparseMatrix<Number> & mat);
/**
* Returns the type of preconditioner to use.
*/
PreconditionerType type () const
{ return _preconditioner_type; }
/**
* Sets the type of preconditioner to use.
*/
void set_type (const PreconditionerType pct);
protected:
/**
* The matrix P... ie the matrix to be preconditioned.
* This is often the actual system matrix of a linear sytem.
*/
SparseMatrix<T> * _matrix;
/**
* Enum statitng with type of preconditioner to use.
*/
PreconditionerType _preconditioner_type;
/**
* Flag indicating if the data structures have been initialized.
*/
bool _is_initialized;
};
/*----------------------- inline functions ----------------------------------*/
template <typename T>
inline
Preconditioner<T>::Preconditioner () :
_matrix(NULL),
_preconditioner_type (ILU_PRECOND),
_is_initialized (false)
{
}
template <typename T>
inline
Preconditioner<T>::~Preconditioner ()
{
this->clear ();
}
template <typename T>
void
Preconditioner<T>::set_matrix(SparseMatrix<Number> & mat)
{
//If the matrix is changing then we (probably) need to reinitialize.
_is_initialized = false;
_matrix = &mat;
}
template <typename T>
void
Preconditioner<T>::set_type (const PreconditionerType pct)
{
//If the preconditioner type changes we (probably) need to reinitialize.
_is_initialized = false;
_preconditioner_type = pct;
}
} // namespace libMesh
#endif // #ifdef __preconditioner_h__
|