libMesh
eigen_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_EIGEN_PRECONDITIONER_H
21 #define LIBMESH_EIGEN_PRECONDITIONER_H
22 
23 #include "libmesh/libmesh_config.h"
24 
25 #ifdef LIBMESH_HAVE_EIGEN
26 
27 // Local includes
28 #include "libmesh/preconditioner.h"
29 
30 namespace libMesh
31 {
32 
33 // forward declarations
34 template <typename T> class SparseMatrix;
35 template <typename T> class NumericVector;
36 template <typename T> class ShellMatrix;
37 
46 template <typename T>
48 {
49 public:
54  LIBMESH_CAN_DEFAULT_TO_COMMWORLD);
55 
59  virtual ~EigenPreconditioner ();
60 
61  virtual void apply(const NumericVector<T> & x, NumericVector<T> & y) libmesh_override;
62 
63  virtual void clear () libmesh_override {}
64 
65  virtual void init () libmesh_override;
66 };
67 
68 
69 
70 
71 /*----------------------- inline functions ----------------------------------*/
72 template <typename T>
73 inline
75  Preconditioner<T>(comm_in)
76 {
77 }
78 
79 
80 
81 template <typename T>
82 inline
84 {
85  this->clear ();
86 }
87 
88 } // namespace libMesh
89 
90 #endif // #ifdef LIBMESH_HAVE_EIGEN
91 #endif // LIBMESH_EIGEN_PRECONDITIONER_H
Encapsulates the MPI_Comm object.
Definition: parallel.h:657
virtual void init() libmesh_override
Initialize data structures if not done so already.
Numeric vector.
Definition: dof_map.h:66
The libMesh namespace provides an interface to certain functionality in the library.
virtual ~EigenPreconditioner()
Destructor.
virtual void apply(const NumericVector< T > &x, NumericVector< T > &y) libmesh_override
Computes the preconditioned vector y based on input vector x.
This class provides a uniform interface for preconditioners.
PetscErrorCode Vec x
This class provides an interface to the suite of preconditioners available from Eigen.
Generic shell matrix, i.e.
EigenPreconditioner(const libMesh::Parallel::Communicator &comm_in LIBMESH_CAN_DEFAULT_TO_COMMWORLD)
Constructor.
virtual void clear() libmesh_override
Release all memory and clear data structures.