slepc.hpp

Go to the documentation of this file.

// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
// LICENSE and NOTICE for details. LLNL-CODE-806117.
//
// This file is part of the MFEM library. For more information and source code
// availability visit https://mfem.org.
//
// MFEM is free software; you can redistribute it and/or modify it under the
// terms of the BSD-3 license. We welcome feedback and contributions, see file
// CONTRIBUTING.md for details.

#ifndef MFEM_SLEPC
#define MFEM_SLEPC

#include "../config/config.hpp"

#ifdef MFEM_USE_SLEPC
#ifdef MFEM_USE_MPI

#include "petsc.hpp"

// Forward declaration of SLEPc's internal struct _p_EPS:
struct _p_EPS;

namespace mfem
{

// Declare an alias of SLEPc's EPS type, mfem::slepc::EPS:
namespace slepc { typedef struct ::_p_EPS *EPS; }

void MFEMInitializeSlepc();
void MFEMInitializeSlepc(int*,char***);
void MFEMInitializeSlepc(int*,char***,const char[],const char[]);
void MFEMFinalizeSlepc();

class SlepcEigenSolver
{
private:
   /// Boolean to handle SetFromOptions calls
   mutable bool clcustom;

   /// SLEPc linear eigensolver object
   slepc::EPS eps;

   /// Real and imaginary part of eigenvector
   mutable PetscParVector *VR, *VC;

public:
   /// Constructors
   SlepcEigenSolver(MPI_Comm comm, const std::string &prefix = std::string());

   virtual ~SlepcEigenSolver();

   /// Set solver tolerance
   void SetTol(double tol);

   /// Set maximum number of iterations
   void SetMaxIter(int max_iter);
   /// Set the number of required eigenmodes
   void SetNumModes(int num_eigs);
   /// Set operator for standard eigenvalue problem
   void SetOperator(const PetscParMatrix &op);
   /// Set operator for generalized eigenvalue problem
   void SetOperators(const PetscParMatrix &op, const PetscParMatrix &opB);

   /// Customize object with options set
   void Customize(bool customize = true) const;

   /// Solve the eigenvalue problem for the specified number of eigenvalues
   void Solve();

   /// Get the number of converged eigenvalues
   int GetNumConverged();

   /// Get the corresponding eigenvalue
   void GetEigenvalue(unsigned int i, double & lr) const;
   void GetEigenvalue(unsigned int i, double & lr, double & lc) const;

   /// Get the corresponding eigenvector
   void GetEigenvector(unsigned int i, Vector & vr) const;
   void GetEigenvector(unsigned int i, Vector & vr, Vector & vc) const;

   /// Target spectrum for the eigensolver. Target imaginary is not supported
   /// without complex support in SLEPc, and intervals are not implemented.
   enum Which
   {
      LARGEST_MAGNITUDE,
      SMALLEST_MAGNITUDE,
      LARGEST_REAL,
      SMALLEST_REAL,
      LARGEST_IMAGINARY,
      SMALLEST_IMAGINARY,
      TARGET_MAGNITUDE,
      TARGET_REAL
   };

   enum SpectralTransformation
   {
      SHIFT,
      SHIFT_INVERT
   };

   void SetWhichEigenpairs(Which which);
   void SetTarget(double target);
   void SetSpectralTransformation(SpectralTransformation transformation);

   /// Conversion function to SLEPc's EPS type.
   operator slepc::EPS() const { return eps; }

   /// Conversion function to PetscObject
   operator PetscObject() const {return (PetscObject)eps; }
};

}

#endif // MFEM_USE_MPI
#endif // MFEM_USE_SLEPC

#endif // MFEM_SLEPC