GetFEM  5.4.3
gmm_precond.h
Go to the documentation of this file.
1 /* -*- c++ -*- (enables emacs c++ mode) */
2 /*===========================================================================
3 
4  Copyright (C) 2004-2020 Yves Renard
5 
6  This file is a part of GetFEM
7 
8  GetFEM is free software; you can redistribute it and/or modify it
9  under the terms of the GNU Lesser General Public License as published
10  by the Free Software Foundation; either version 3 of the License, or
11  (at your option) any later version along with the GCC Runtime Library
12  Exception either version 3.1 or (at your option) any later version.
13  This program is distributed in the hope that it will be useful, but
14  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
16  License and GCC Runtime Library Exception for more details.
17  You should have received a copy of the GNU Lesser General Public License
18  along with this program; if not, write to the Free Software Foundation,
19  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
20 
21  As a special exception, you may use this file as it is a part of a free
22  software library without restriction. Specifically, if other files
23  instantiate templates or use macros or inline functions from this file,
24  or you compile this file and link it with other files to produce an
25  executable, this file does not by itself cause the resulting executable
26  to be covered by the GNU Lesser General Public License. This exception
27  does not however invalidate any other reasons why the executable file
28  might be covered by the GNU Lesser General Public License.
29 
30 ===========================================================================*/
31 #ifndef GMM_PRECOND_H
32 #define GMM_PRECOND_H
33 
34 #include "gmm_kernel.h"
35 
36 /** @file gmm_precond.h
37  @author Yves Renard <Yves.Renard@insa-lyon.fr>
38  @date March 29, 2004.
39  @brief gmm preconditioners.
40  */
41 
42 /* Preconditioner concept : */
43 /* */
44 /* A the matrix, P the preconditioner PA well conditioned. */
45 /* PRECOND preconditioner type. */
46 /* mult(P, v, w) : w <- P v */
47 /* transposed_mult(P, v, w) : w <- transposed(P) v */
48 /* left_mult(P, v, w) : see qmr solver */
49 /* right_mult(P, v, w) : see qmr solver */
50 /* transposed_left_mult(P, v, w) : see qmr solver */
51 /* transposed_right_mult(P, v, w) : see qmr solver */
52 /* */
53 /* PRECOND P() : empty preconditioner. */
54 /* PRECOND P(A, ...) : preconditioner for the matrix A, with optional */
55 /* parameters */
56 /* PRECOND(...) : empty precondtioner with parameters set. */
57 /* P.build_with(A) : build a precondtioner for A. */
58 /* */
59 /* *********************************************************************** */
60 
61 
62 
63 
64 #endif
65 
gmm_kernel.h
Include the base gmm files.