1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2020 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17 
18 
19 
20 #ifndef LIBMESH_ENUM_PRECONDITIONER_TYPE_H
21 #define LIBMESH_ENUM_PRECONDITIONER_TYPE_H
22 
23 namespace libMesh {
24 
25 /**
26  * Defines an \p enum for preconditioner types.
27  *
28  * The fixed type, i.e. ": int", enumeration syntax used here allows
29  * this enum to be forward declared as
30  * enum PreconditionerType : int;
31  * reducing header file dependencies.
32  */
33 enum PreconditionerType : int {
34                          IDENTITY_PRECOND =0,
35                          JACOBI_PRECOND,
36                          BLOCK_JACOBI_PRECOND,
37                          SOR_PRECOND,
38                          SSOR_PRECOND,
39                          EISENSTAT_PRECOND,
40                          ASM_PRECOND,
41                          CHOLESKY_PRECOND,
42                          ICC_PRECOND,
43                          ILU_PRECOND,
44                          LU_PRECOND,
45                          USER_PRECOND,
46                          SHELL_PRECOND,
47                          AMG_PRECOND,
48                          // Invalid
49                          INVALID_PRECONDITIONER};
50 }
51 
52 #endif
53