Line data    Source code

       1             : // The libMesh Finite Element Library.
       2             : // Copyright (C) 2002-2025 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             : 
      38             : /**
      39             :  * This class provides an interface to the suite of preconditioners
      40             :  * available from Eigen. All overridden virtual functions are
      41             :  * documented in preconditioner.h.
      42             :  *
      43             :  * \author Benjamin Kirk
      44             :  * \date 2013
      45             :  */
      46             : template <typename T>
      47             : class EigenPreconditioner : public Preconditioner<T>
      48             : {
      49             : public:
      50             :   /**
      51             :    *  Constructor. Initializes EigenPreconditioner data structures
      52             :    */
      53             :   EigenPreconditioner (const libMesh::Parallel::Communicator & comm_in);
      54             : 
      55             :   /**
      56             :    * Destructor.
      57             :    */
      58             :   virtual ~EigenPreconditioner ();
      59             : 
      60             :   virtual void apply(const NumericVector<T> & x, NumericVector<T> & y) override;
      61             : 
      62           0 :   virtual void clear () override {}
      63             : 
      64             :   virtual void init () override;
      65             : };
      66             : 
      67             : 
      68             : 
      69             : 
      70             : /*----------------------- inline functions ----------------------------------*/
      71             : template <typename T>
      72             : inline
      73           0 : EigenPreconditioner<T>::EigenPreconditioner(const libMesh::Parallel::Communicator & comm_in) :
      74           0 :   Preconditioner<T>(comm_in)
      75             : {
      76           0 : }
      77             : 
      78             : 
      79             : 
      80             : template <typename T>
      81             : inline
      82           0 : EigenPreconditioner<T>::~EigenPreconditioner ()
      83             : {
      84           0 :   this->clear ();
      85           0 : }
      86             : 
      87             : } // namespace libMesh
      88             : 
      89             : #endif // #ifdef LIBMESH_HAVE_EIGEN
      90             : #endif // LIBMESH_EIGEN_PRECONDITIONER_H