slepc_spectral_transformation.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2009 - 2026 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
 
#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>
 
#  endif // DEAL_II_WITH_SLEPC
 
DEAL_II_NAMESPACE_OPEN
 
#  ifdef DEAL_II_WITH_SLEPC
// Forward declaration
#    ifndef DOXYGEN
namespace PETScWrappers
{
  // forward declarations
  class SolverBase;
} // namespace PETScWrappers
#    endif
 
namespace SLEPcWrappers
{
  // forward declaration
  class SolverBase;
 
  class TransformationBase
  {
  protected:
    explicit 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
    {
      explicit AdditionalData(const double shift_parameter = 0);
 
      const double shift_parameter;
    };
 
 
    explicit TransformationShift(const MPI_Comm        mpi_communicator,
                                 const AdditionalData &data = AdditionalData());
 
 
  protected:
    const AdditionalData additional_data;
  };
 
  class TransformationShiftInvert : public TransformationBase
  {
  public:
    struct AdditionalData
    {
      explicit AdditionalData(const double shift_parameter = 0);
 
      const double shift_parameter;
    };
 
 
    explicit 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 TransformationCayley : public TransformationBase
  {
  public:
    struct AdditionalData
    {
      explicit AdditionalData(const double shift_parameter     = 0,
                              const double antishift_parameter = 0);
 
      const double shift_parameter;
 
      const double antishift_parameter;
    };
 
 
    explicit TransformationCayley(
      const MPI_Comm        mpi_communicator,
      const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
  };
 
} // namespace SLEPcWrappers
 
#  endif // DEAL_II_WITH_SLEPC
 
DEAL_II_NAMESPACE_CLOSE
 
/*--------------------   slepc_spectral_transformation.h   ------------------*/
 
#endif
 
/*--------------------   slepc_spectral_transformation.h   ------------------*/