libMesh
petsc_preconditioner.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 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_PETSC_PRECONDITIONER_H
21 #define LIBMESH_PETSC_PRECONDITIONER_H
22 
23 #include "libmesh/libmesh_config.h"
24 
25 #ifdef LIBMESH_HAVE_PETSC
26 
27 // Local includes
28 #include "libmesh/preconditioner.h"
29 #include "libmesh/libmesh_common.h"
30 #include "libmesh/enum_solver_package.h"
31 #include "libmesh/enum_preconditioner_type.h"
32 #include "libmesh/reference_counted_object.h"
33 #include "libmesh/libmesh.h"
34 #include "libmesh/petsc_macro.h"
35 
36 // Petsc includes
37 #include "petscpc.h"
38 
39 namespace libMesh
40 {
41 
42 // forward declarations
43 template <typename T> class SparseMatrix;
44 template <typename T> class NumericVector;
45 template <typename T> class ShellMatrix;
46 
55 template <typename T>
57 {
58 public:
59 
64  LIBMESH_CAN_DEFAULT_TO_COMMWORLD);
65 
69  virtual ~PetscPreconditioner ();
70 
71  virtual void apply(const NumericVector<T> & x, NumericVector<T> & y) libmesh_override;
72 
73  virtual void clear () libmesh_override;
74 
75  virtual void init () libmesh_override;
76 
81  PC pc() { return _pc; }
82 
86  static void set_petsc_preconditioner_type (const PreconditionerType & preconditioner_type, PC & pc);
87 
88 protected:
89 
93  PC _pc;
94 
98  Mat _mat;
99 
100 private:
108 #if PETSC_VERSION_LESS_THAN(3,0,0)
109  // In Petsc 2.3.3, PCType was #define'd as const char *
110  static void set_petsc_subpreconditioner_type(PCType type, PC & pc);
111 #else
112  // In later versions, PCType is #define'd as char *, so we need the const
113  static void set_petsc_subpreconditioner_type(const PCType type, PC & pc);
114 #endif
115 };
116 
117 
118 
119 
120 /*----------------------- inline functions ----------------------------------*/
121 template <typename T>
122 inline
124  Preconditioner<T>(comm_in),
125  _pc(PETSC_NULL)
126 {
127 }
128 
129 
130 
131 template <typename T>
132 inline
134 {
135  this->clear ();
136 }
137 
138 } // namespace libMesh
139 
140 #endif // #ifdef LIBMESH_HAVE_PETSC
141 #endif // LIBMESH_PETSC_PRECONDITIONER_H
Encapsulates the MPI_Comm object.
Definition: parallel.h:657
This class provides an interface to the suite of preconditioners available from PETSc.
PC _pc
Preconditioner context.
virtual ~PetscPreconditioner()
Destructor.
Mat _mat
PETSc Mat pulled out of the _matrix object during init().
PreconditionerType type() const
Numeric vector.
Definition: dof_map.h:66
The libMesh namespace provides an interface to certain functionality in the library.
PreconditionerType
Defines an enum for preconditioner types.
This class provides a uniform interface for preconditioners.
PetscErrorCode Vec x
static void set_petsc_subpreconditioner_type(PCType type, PC &pc)
Some PETSc preconditioners (ILU, LU) don&#39;t work in parallel.
static void set_petsc_preconditioner_type(const PreconditionerType &preconditioner_type, PC &pc)
Tells PETSc to use the user-specified preconditioner.
virtual void init() libmesh_override
Initialize data structures if not done so already.
virtual void apply(const NumericVector< T > &x, NumericVector< T > &y) libmesh_override
Computes the preconditioned vector y based on input vector x.
PetscPreconditioner(const libMesh::Parallel::Communicator &comm_in LIBMESH_CAN_DEFAULT_TO_COMMWORLD)
Constructor.
virtual void clear() libmesh_override
Release all memory and clear data structures.