SLEPcEigenSolver.h

// Copyright (C) 2005-2017 Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN 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 DOLFIN. If not, see <http://www.gnu.org/licenses/>.

#ifndef __SLEPC_EIGEN_SOLVER_H
#define __SLEPC_EIGEN_SOLVER_H

#ifdef HAS_SLEPC

#include <memory>
#include <string>
#include <slepceps.h>
#include "dolfin/common/types.h"
#include "dolfin/common/MPI.h"
#include "PETScObject.h"

namespace dolfin
{

  class GenericVector;
  class PETScMatrix;
  class PETScVector;
  class VectorSpaceBasis;


  class SLEPcEigenSolver : public Variable, public PETScObject
  {
  public:

    explicit SLEPcEigenSolver(MPI_Comm comm);

    explicit SLEPcEigenSolver(EPS eps);

    explicit SLEPcEigenSolver(std::shared_ptr<const PETScMatrix> A);

    SLEPcEigenSolver(MPI_Comm comm, std::shared_ptr<const PETScMatrix> A);

    SLEPcEigenSolver(std::shared_ptr<const PETScMatrix> A,
                     std::shared_ptr<const PETScMatrix> B);

    SLEPcEigenSolver(MPI_Comm comm, std::shared_ptr<const PETScMatrix> A,
                     std::shared_ptr<const PETScMatrix> B);

    ~SLEPcEigenSolver();

    void set_operators(std::shared_ptr<const PETScMatrix> A,
                       std::shared_ptr<const PETScMatrix> B);

    void solve();

    void solve(std::size_t n);

    void get_eigenvalue(double& lr, double& lc, std::size_t i) const;

    void get_eigenpair(double& lr, double& lc,
                       GenericVector& r, GenericVector& c, std::size_t i) const;

    void get_eigenpair(double& lr, double& lc,
                       PETScVector& r, PETScVector& c, std::size_t i) const;

    std::size_t get_iteration_number() const;

    std::size_t get_number_converged() const;

    void set_deflation_space(const VectorSpaceBasis& deflation_space);

    void set_initial_space(const VectorSpaceBasis& initial_space);

    void set_options_prefix(std::string options_prefix);

    std::string get_options_prefix() const;

    void set_from_options() const;

    EPS eps() const;

    static Parameters default_parameters()
    {
      Parameters p("slepc_eigenvalue_solver");
      p.add<std::string>("problem_type");
      p.add<std::string>("spectrum");
      p.add<std::string>("solver");
      p.add<double>("tolerance");
      p.add<int>("maximum_iterations");
      p.add<std::string>("spectral_transform");
      p.add<double>("spectral_shift");
      p.add<bool>("verbose");

      return p;
    }

  private:

    void read_parameters();

    // Set problem type (used for SLEPc internals)
    void set_problem_type(std::string type);

    // Set spectral transform
    void set_spectral_transform(std::string transform, double shift);

    // Set spectrum
    void set_spectrum(std::string solver);

    // Set solver
    void set_solver(std::string spectrum);

    // Set tolerance
    void set_tolerance(double tolerance, int maxiter);

    // SLEPc solver pointer
    EPS _eps;

  };

}

#endif

#endif