petsc_solver.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2004 - 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_petsc_solver_h
#define dealii_petsc_solver_h
 
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_WITH_PETSC
 
#  include <deal.II/base/smartpointer.h>
 
#  include <deal.II/lac/exceptions.h>
#  include <deal.II/lac/solver_control.h>
 
#  include <petscksp.h>
 
#  ifdef DEAL_II_WITH_SLEPC
#    include <deal.II/lac/slepc_spectral_transformation.h>
#  endif
 
DEAL_II_NAMESPACE_OPEN
 
// Forward declarations
#  ifndef DOXYGEN
#    ifdef DEAL_II_WITH_SLEPC
namespace SLEPcWrappers
{
  // forward declarations
  class TransformationBase;
} // namespace SLEPcWrappers
#    endif
#  endif
 
namespace PETScWrappers
{
  // forward declarations
#  ifndef DOXYGEN
  class MatrixBase;
  class VectorBase;
  class PreconditionBase;
#  endif
 
 
  class SolverBase
  {
  public:
    SolverBase();
 
    SolverBase(SolverControl &cn);
 
    virtual ~SolverBase();
 
    void
    solve(const MatrixBase &      A,
          VectorBase &            x,
          const VectorBase &      b,
          const PreconditionBase &preconditioner);
 
    virtual void
    reset();
 
    void
    set_prefix(const std::string &prefix);
 
    SolverControl &
    control() const;
 
    void
    initialize(const PreconditionBase &preconditioner);
 
    KSP
    petsc_ksp();
 
    operator KSP() const;
 
  protected:
    KSP ksp;
 
    SmartPointer<SolverControl, SolverBase> solver_control;
 
    void
    initialize_ksp_with_comm(const MPI_Comm comm);
 
    virtual void
    set_solver_type(KSP &ksp) const;
 
    void
    perhaps_set_convergence_test() const;
 
    std::string prefix_name;
 
  private:
    static PetscErrorCode
    convergence_test(KSP                 ksp,
                     const PetscInt      iteration,
                     const PetscReal     residual_norm,
                     KSPConvergedReason *reason,
                     void *              solver_control);
 
 
#  ifdef DEAL_II_WITH_SLEPC
    // Make the transformation class a friend, since it needs to set the KSP
    // solver.
    friend class SLEPcWrappers::TransformationBase;
#  endif
  };
 
 
 
  class SolverRichardson : public SolverBase
  {
  public:
    struct AdditionalData
    {
      explicit AdditionalData(const double omega = 1);
 
      double omega;
    };
 
    SolverRichardson(SolverControl &       cn,
                     const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverRichardson(SolverControl &       cn,
                     const MPI_Comm        mpi_communicator,
                     const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverChebychev : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverChebychev(SolverControl &       cn,
                    const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverChebychev(SolverControl &       cn,
                    const MPI_Comm        mpi_communicator,
                    const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverCG : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverCG(SolverControl &cn, const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverCG(SolverControl &       cn,
             const MPI_Comm        mpi_communicator,
             const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverBiCG : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverBiCG(SolverControl &       cn,
               const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverBiCG(SolverControl &       cn,
               const MPI_Comm        mpi_communicator,
               const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverGMRES : public SolverBase
  {
  public:
    struct AdditionalData
    {
      AdditionalData(const unsigned int restart_parameter     = 30,
                     const bool         right_preconditioning = false);
 
      unsigned int restart_parameter;
 
      bool right_preconditioning;
    };
 
    SolverGMRES(SolverControl &       cn,
                const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverGMRES(SolverControl &       cn,
                const MPI_Comm        mpi_communicator,
                const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverBicgstab : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverBicgstab(SolverControl &       cn,
                   const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverBicgstab(SolverControl &       cn,
                   const MPI_Comm        mpi_communicator,
                   const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverCGS : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverCGS(SolverControl &cn, const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverCGS(SolverControl &       cn,
              const MPI_Comm        mpi_communicator,
              const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverTFQMR : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverTFQMR(SolverControl &       cn,
                const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverTFQMR(SolverControl &       cn,
                const MPI_Comm        mpi_communicator,
                const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverTCQMR : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverTCQMR(SolverControl &       cn,
                const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverTCQMR(SolverControl &       cn,
                const MPI_Comm        mpi_communicator,
                const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverCR : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverCR(SolverControl &cn, const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverCR(SolverControl &       cn,
             const MPI_Comm        mpi_communicator,
             const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
 
  class SolverLSQR : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverLSQR(SolverControl &       cn,
               const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverLSQR(SolverControl &       cn,
               const MPI_Comm        mpi_communicator,
               const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
 
  class SolverPreOnly : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SolverPreOnly(SolverControl &       cn,
                  const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SolverPreOnly(SolverControl &       cn,
                  const MPI_Comm        mpi_communicator,
                  const AdditionalData &data = AdditionalData());
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
  };
 
  class SparseDirectMUMPS : public SolverBase
  {
  public:
    struct AdditionalData
    {};
 
    SparseDirectMUMPS(SolverControl &       cn,
                      const AdditionalData &data = AdditionalData());
 
    DEAL_II_DEPRECATED_EARLY
    SparseDirectMUMPS(SolverControl &       cn,
                      const MPI_Comm        mpi_communicator,
                      const AdditionalData &data = AdditionalData());
 
    void
    solve(const MatrixBase &A, VectorBase &x, const VectorBase &b);
 
    void
    set_symmetric_mode(const bool flag);
 
  protected:
    const AdditionalData additional_data;
 
    virtual void
    set_solver_type(KSP &ksp) const override;
 
    bool symmetric_mode;
  };
} // namespace PETScWrappers
 
DEAL_II_NAMESPACE_CLOSE
 
#endif // DEAL_II_WITH_PETSC
 
#endif