eigen_system.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 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_EIGEN_SYSTEM_H
#define LIBMESH_EIGEN_SYSTEM_H

#include "libmesh/libmesh_config.h"

// Currently, the EigenSystem should only be available
// if SLEPc support is enabled.
#if defined(LIBMESH_HAVE_SLEPC)

// Local Includes
#include "libmesh/system.h"
#include "libmesh/eigen_solver.h"

namespace libMesh
{

// Forward Declarations
template <typename T> class SparseMatrix;
template <typename T> class ShellMatrix;


class EigenSystem : public System
{
public:

  EigenSystem (EquationSystems & es,
               const std::string & name_in,
               const unsigned int number_in);

  EigenSystem (const EigenSystem &) = delete;
  EigenSystem & operator= (const EigenSystem &) = delete;
  EigenSystem (EigenSystem &&) = default;
  EigenSystem & operator= (EigenSystem &&) = delete;
  virtual ~EigenSystem ();

  typedef EigenSystem sys_type;

  typedef System Parent;

  sys_type & system () { return *this; }

  virtual void clear () override;

  virtual void reinit () override;

  virtual void solve () override;

  virtual std::pair<Real, Real> get_eigenpair (dof_id_type i);

  virtual std::pair<Real, Real> get_eigenvalue (dof_id_type i);

  virtual std::string system_type () const override { return "Eigen"; }

  unsigned int get_n_converged () const {return _n_converged_eigenpairs;}

  unsigned int get_n_iterations () const {return _n_iterations;}

  void set_eigenproblem_type (EigenProblemType ept);

  EigenProblemType get_eigenproblem_type () const {return _eigen_problem_type;}

  void set_initial_space(NumericVector<Number> & initial_space_in);

  bool generalized () const;

  bool use_shell_matrices() const { return _use_shell_matrices; }

  void use_shell_matrices(bool use_shell_matrices) { _use_shell_matrices = use_shell_matrices; }

  bool use_shell_precond_matrix() const { return _use_shell_precond_matrix; }

  void use_shell_precond_matrix(bool use_shell_precond_matrix) { _use_shell_precond_matrix = use_shell_precond_matrix; }

  const SparseMatrix<Number> & get_matrix_A() const;

  SparseMatrix<Number> & get_matrix_A();

  const SparseMatrix<Number> & get_matrix_B() const;

  SparseMatrix<Number> & get_matrix_B();

  const SparseMatrix<Number> & get_precond_matrix() const;

  SparseMatrix<Number> & get_precond_matrix();

  const ShellMatrix<Number> & get_shell_matrix_A() const;

  ShellMatrix<Number> & get_shell_matrix_A();

  const ShellMatrix<Number> & get_shell_matrix_B() const;

  ShellMatrix<Number> & get_shell_matrix_B();

  const ShellMatrix<Number> & get_shell_precond_matrix() const;

  ShellMatrix<Number> & get_shell_precond_matrix();

  const EigenSolver<Number> & get_eigen_solver() const;
  EigenSolver<Number> & get_eigen_solver();

  bool has_matrix_A() const;

  bool has_matrix_B() const;

  bool has_precond_matrix() const;

  bool has_shell_matrix_A() const;

  bool has_shell_matrix_B() const;

  bool has_shell_precond_matrix() const;

  SparseMatrix<Number> * matrix_A;

  SparseMatrix<Number> * matrix_B;

  std::unique_ptr<ShellMatrix<Number>> shell_matrix_A;

  std::unique_ptr<ShellMatrix<Number>> shell_matrix_B;

  SparseMatrix<Number> * precond_matrix;

  std::unique_ptr<ShellMatrix<Number>> shell_precond_matrix;

  std::unique_ptr<EigenSolver<Number>> eigen_solver;


protected:

  virtual void add_matrices () override;

  virtual void init_matrices () override;

  void set_n_converged (unsigned int nconv)
  { _n_converged_eigenpairs = nconv; }

  void set_n_iterations (unsigned int its)
  { _n_iterations = its;}


private:

  unsigned int _n_converged_eigenpairs;

  unsigned int _n_iterations;

  EigenProblemType _eigen_problem_type;

  bool _use_shell_matrices;

  bool _use_shell_precond_matrix;
};

} // namespace libMesh

#endif // LIBMESH_HAVE_SLEPC

#endif // LIBMESH_EIGEN_SYSTEM_H