slepc_spectral_transformation.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2009 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, 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.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------
 
 
#ifndef dealii_slepc_spectral_transformation_h
#  define dealii_slepc_spectral_transformation_h
 
 
#  include <deal.II/base/config.h>
 
#  ifdef DEAL_II_WITH_SLEPC
 
#    include <deal.II/lac/exceptions.h>
#    include <deal.II/lac/petsc_solver.h>
 
#    include <petscksp.h>
 
#    include <slepceps.h>
 
#    include <memory>
 
DEAL_II_NAMESPACE_OPEN
 
// Forward declaration
#    ifndef DOXYGEN
namespace PETScWrappers
{
  // forward declarations
  class SolverBase;
} // namespace PETScWrappers
#    endif
 
namespace SLEPcWrappers
{
  // forward declaration
  class SolverBase;
 
  class TransformationBase
  {
  protected:
    TransformationBase(const MPI_Comm mpi_communicator);
 
  public:
    virtual ~TransformationBase();
 
    void
    set_matrix_mode(const STMatMode mode);
 
    void
    set_solver(const PETScWrappers::SolverBase &solver);
 
  protected:
    ST st;
 
    // Make the solver class a friend, since it needs to set spectral
    // transformation object.
    friend class SolverBase;
  };
 
  class TransformationShift : public TransformationBase
  {
  public:
    struct AdditionalData
    {
      AdditionalData(const double shift_parameter = 0);
 
      const double shift_parameter;
    };
 
 
    TransformationShift(const MPI_Comm        mpi_communicator,
                        const AdditionalData &data = AdditionalData());
 
 
  protected:
    const AdditionalData additional_data;
  };
 
  class TransformationShiftInvert : public TransformationBase
  {
  public:
    struct AdditionalData
    {
      AdditionalData(const double shift_parameter = 0);
 
      const double shift_parameter;
    };
 
 
    TransformationShiftInvert(const MPI_Comm        mpi_communicator,
                              const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    // Make the solver class a friend, since it may need to set target
    // equal the provided shift value.
    friend class SolverBase;
  };
 
  class DEAL_II_DEPRECATED TransformationSpectrumFolding
    : public TransformationBase
  {
  public:
    struct AdditionalData
    {
      AdditionalData(const double shift_parameter = 0);
 
      const double shift_parameter;
    };
 
 
    TransformationSpectrumFolding(
      const MPI_Comm        mpi_communicator,
      const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
  };
 
  class TransformationCayley : public TransformationBase
  {
  public:
    struct AdditionalData
    {
      AdditionalData(const double shift_parameter     = 0,
                     const double antishift_parameter = 0);
 
      const double shift_parameter;
 
      const double antishift_parameter;
    };
 
 
    TransformationCayley(const MPI_Comm        mpi_communicator,
                         const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
  };
 
} // namespace SLEPcWrappers
 
DEAL_II_NAMESPACE_CLOSE
 
#  endif // DEAL_II_WITH_SLEPC
 
/*--------------------   slepc_spectral_transformation.h   ------------------*/
 
#endif
 
/*--------------------   slepc_spectral_transformation.h   ------------------*/