slepc_eigen_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef LIBMESH_SLEPC_EIGEN_SOLVER_H
#define LIBMESH_SLEPC_EIGEN_SOLVER_H
 
#include "libmesh/libmesh_config.h"
 
#ifdef LIBMESH_HAVE_SLEPC
 
// Local includes
#include "libmesh/eigen_solver.h"
#include "libmesh/slepc_macro.h"
 
// SLEPc include files.
EXTERN_C_FOR_SLEPC_BEGIN
# include "libmesh/ignore_warnings.h"
# include <slepceps.h>
# include "libmesh/restore_warnings.h"
EXTERN_C_FOR_SLEPC_END
 
namespace libMesh
{
 template <typename T> class PetscVector;
 
template <typename T>
class SlepcEigenSolver : public EigenSolver<T>
{
 
public:
 
  SlepcEigenSolver(const Parallel::Communicator & comm_in);
 
 
  ~SlepcEigenSolver();
 
 
  virtual void clear() noexcept override;
 
 
  virtual void init() override;
 
 
  virtual std::pair<unsigned int, unsigned int>
  solve_standard (SparseMatrix<T> & matrix_A,
                  int nev,
                  int ncv,
                  const double tol,
                  const unsigned int m_its) override;
 
  virtual std::pair<unsigned int, unsigned int>
  solve_standard (ShellMatrix<T> & shell_matrix,
                  int nev,
                  int ncv,
                  const double tol,
                  const unsigned int m_its) override;
 
   virtual std::pair<unsigned int, unsigned int>
   solve_standard (ShellMatrix<T> & shell_matrix,
                   SparseMatrix<T> & precond,
                   int nev,
                   int ncv,
                   const double tol,
                   const unsigned int m_its) override;
 
   virtual std::pair<unsigned int, unsigned int>
   solve_standard (ShellMatrix<T> & shell_matrix,
                   ShellMatrix<T> & precond,
                   int nev,
                   int ncv,
                   const double tol,
                   const unsigned int m_its) override;
 
 
  virtual std::pair<unsigned int, unsigned int>
  solve_generalized(SparseMatrix<T> & matrix_A,
                    SparseMatrix<T> & matrix_B,
                    int nev,
                    int ncv,
                    const double tol,
                    const unsigned int m_its) override;
 
  virtual std::pair<unsigned int, unsigned int>
  solve_generalized(ShellMatrix<T> & matrix_A,
                    SparseMatrix<T> & matrix_B,
                    int nev,
                    int ncv,
                    const double tol,
                    const unsigned int m_its) override;
 
  virtual std::pair<unsigned int, unsigned int>
  solve_generalized(SparseMatrix<T> & matrix_A,
                    ShellMatrix<T> & matrix_B,
                    int nev,
                    int ncv,
                    const double tol,
                    const unsigned int m_its) override;
 
  virtual std::pair<unsigned int, unsigned int>
  solve_generalized(ShellMatrix<T> & matrix_A,
                    ShellMatrix<T> & matrix_B,
                    int nev,
                    int ncv,
                    const double tol,
                    const unsigned int m_its) override;
 
 
  virtual std::pair<unsigned int, unsigned int>
  solve_generalized(ShellMatrix<T> & matrix_A,
                    ShellMatrix<T> & matrix_B,
                    SparseMatrix<T> & precond,
                    int nev,
                    int ncv,
                    const double tol,
                    const unsigned int m_its) override;
 
  virtual std::pair<unsigned int, unsigned int>
  solve_generalized(ShellMatrix<T> & matrix_A,
                    ShellMatrix<T> & matrix_B,
                    ShellMatrix<T> & precond,
                    int nev,
                    int ncv,
                    const double tol,
                    const unsigned int m_its) override;
 
  virtual std::pair<Real, Real>
  get_eigenpair (dof_id_type i,
                 NumericVector<T> & solution_in) override;
 
  virtual std::pair<Real, Real>
  get_eigenvalue (dof_id_type i) override;
 
  Real get_relative_error (unsigned int i);
 
  virtual void attach_deflation_space(NumericVector<T> & deflation_vector) override;
 
  virtual void
  set_initial_space(NumericVector<T> & initial_space_in) override;
 
  EPS eps() { this->init(); return _eps; }
 
  void print_eigenvalues() const;
 
private:
 
  std::pair<unsigned int, unsigned int> _solve_standard_helper (Mat mat,
                                                                Mat precond,
                                                                int nev,
                                                                int ncv,
                                                                const double tol,
                                                                const unsigned int m_its);
 
  std::pair<unsigned int, unsigned int> _solve_generalized_helper (Mat mat_A,
                                                                   Mat mat_B,
                                                                   Mat precond,
                                                                   int nev,
                                                                   int ncv,
                                                                   const double tol,
                                                                   const unsigned int m_its);
 
  std::pair<unsigned int, unsigned int> _solve_helper (Mat precond,
                                                       int nev,
                                                       int ncv,
                                                       const double tol,
                                                       const unsigned int m_its);
 
  void set_slepc_solver_type ();
 
  void set_slepc_problem_type ();
 
  void set_slepc_position_of_spectrum();
 
  static PetscErrorCode _petsc_shell_matrix_mult(Mat mat, Vec arg, Vec dest);
 
  static PetscErrorCode _petsc_shell_matrix_get_diagonal(Mat mat, Vec dest);
 
  EPS _eps;
 
  PetscVector<T>* _initial_space;
};
 
} // namespace libMesh
 
 
#endif // #ifdef LIBMESH_HAVE_SLEPC
#endif // LIBMESH_SLEPC_EIGEN_SOLVER_H