eigen_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 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_SOLVER_H
#define LIBMESH_EIGEN_SOLVER_H


#include "libmesh/libmesh_config.h"
#ifdef LIBMESH_HAVE_SLEPC

// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/enum_solver_package.h"
#include "libmesh/enum_eigen_solver_type.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/libmesh.h"
#include "libmesh/parallel_object.h"
#include "libmesh/auto_ptr.h"

// C++ includes

namespace libMesh
{

// forward declarations
template <typename T> class SparseMatrix;
template <typename T> class ShellMatrix;
template <typename T> class NumericVector;


template <typename T>
class EigenSolver : public ReferenceCountedObject<EigenSolver<T> >,
                    public ParallelObject
{
public:

  EigenSolver (const Parallel::Communicator &comm_in
               LIBMESH_CAN_DEFAULT_TO_COMMWORLD);

  virtual ~EigenSolver ();

  static UniquePtr<EigenSolver<T> > build(const Parallel::Communicator &comm_in
                                          LIBMESH_CAN_DEFAULT_TO_COMMWORLD,
                                          const SolverPackage solver_package = SLEPC_SOLVERS);

  bool initialized () const { return _is_initialized; }


  virtual void clear () {}

  virtual void init () = 0;

  EigenSolverType eigen_solver_type () const { return _eigen_solver_type; }

  EigenProblemType eigen_problem_type () const { return _eigen_problem_type;}

  PositionOfSpectrum position_of_spectrum () const
  { return _position_of_spectrum;}

  void set_eigensolver_type (const EigenSolverType est)
  { _eigen_solver_type = est; }

  void set_eigenproblem_type ( EigenProblemType ept)
  {_eigen_problem_type = ept;}

  void set_position_of_spectrum (PositionOfSpectrum pos)
  {_position_of_spectrum= pos;}

  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) = 0;

  virtual std::pair<unsigned int, unsigned int> solve_standard (ShellMatrix<T> &matrix_A,
                                                                int nev,
                                                                int ncv,
                                                                const double tol,
                                                                const unsigned int m_its) = 0;


  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) = 0;

  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) = 0;

  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) = 0;

  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) = 0;


  virtual std::pair<Real, Real> get_eigenpair (unsigned int i,
                                               NumericVector<T> &solution) = 0;

  virtual std::pair<Real, Real> get_eigenvalue (unsigned int i) = 0;

  virtual void attach_deflation_space(NumericVector<T> &deflation_vector) = 0;

protected:

  EigenSolverType _eigen_solver_type;

  EigenProblemType _eigen_problem_type;

  PositionOfSpectrum _position_of_spectrum;

  bool _is_initialized;

};




/*----------------------- inline functions ----------------------------------*/
template <typename T>
inline
EigenSolver<T>::EigenSolver (const Parallel::Communicator &comm_in) :
  ParallelObject(comm_in),
  _eigen_solver_type    (ARNOLDI),
  _eigen_problem_type   (NHEP),
  _position_of_spectrum (LARGEST_MAGNITUDE),
  _is_initialized       (false)
{
}



template <typename T>
inline
EigenSolver<T>::~EigenSolver ()
{
  this->clear ();
}

} // namespace libMesh

#endif // LIBMESH_HAVE_SLEPC

#endif // LIBMESH_EIGEN_SOLVER_H