petsc_solver.h

// ---------------------------------------------------------------------
//
// Copyright (C) 2004 - 2018 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 at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------

#ifndef dealii_petsc_solver_h
#define dealii_petsc_solver_h


#include <deal.II/base/config.h>

#ifdef DEAL_II_WITH_PETSC

#  include <deal.II/lac/exceptions.h>
#  include <deal.II/lac/solver_control.h>

#  include <petscksp.h>

#  include <memory>

#ifdef DEAL_II_WITH_SLEPC
#include <deal.II/lac/slepc_spectral_transformation.h>
#endif

DEAL_II_NAMESPACE_OPEN

#ifdef DEAL_II_WITH_SLEPC
namespace SLEPcWrappers
{
  // forward declarations
  class TransformationBase;
}
#endif

namespace PETScWrappers
{
  // forward declarations
  class MatrixBase;
  class VectorBase;
  class PreconditionerBase;


  class SolverBase
  {
  public:
    SolverBase (SolverControl  &cn,
                const MPI_Comm &mpi_communicator);

    virtual ~SolverBase () = default;

    void
    solve (const MatrixBase         &A,
           VectorBase               &x,
           const VectorBase         &b,
           const PreconditionerBase &preconditioner);


    virtual void reset();


    void set_prefix(const std::string &prefix);


    SolverControl &control() const;

    void initialize(const PreconditionerBase &preconditioner);

  protected:

    SolverControl &solver_control;

    const MPI_Comm mpi_communicator;

    virtual void set_solver_type (KSP &ksp) const = 0;

    std::string prefix_name;

  private:
    static
    PetscErrorCode convergence_test (KSP                 ksp,
                                     const PetscInt      iteration,
                                     const PetscReal     residual_norm,
                                     KSPConvergedReason *reason,
                                     void               *solver_control);

    struct SolverData
    {
      ~SolverData ();

      KSP  ksp;
    };

    std::unique_ptr<SolverData> solver_data;

#ifdef DEAL_II_WITH_SLEPC

    friend class SLEPcWrappers::TransformationBase;
#endif
  };



  class SolverRichardson : public SolverBase
  {
  public:
    struct AdditionalData
    {
      explicit
      AdditionalData (const double omega = 1);

      double omega;
    };

    SolverRichardson (SolverControl        &cn,
                      const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                      const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };



  class SolverChebychev : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverChebychev (SolverControl        &cn,
                     const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                     const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };



  class SolverCG : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverCG (SolverControl        &cn,
              const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
              const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };



  class SolverBiCG : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverBiCG (SolverControl        &cn,
                const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };



  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 MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                 const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };



  class SolverBicgstab : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverBicgstab (SolverControl        &cn,
                    const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                    const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };

  class SolverCGS : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverCGS (SolverControl        &cn,
               const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
               const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };



  class SolverTFQMR : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverTFQMR (SolverControl        &cn,
                 const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                 const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };




  class SolverTCQMR : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverTCQMR (SolverControl        &cn,
                 const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                 const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };



  class SolverCR : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverCR (SolverControl        &cn,
              const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
              const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };



  class SolverLSQR : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverLSQR (SolverControl        &cn,
                const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };


  class SolverPreOnly : public SolverBase
  {
  public:
    struct AdditionalData
    {};

    SolverPreOnly (SolverControl        &cn,
                   const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                   const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;

    virtual void set_solver_type (KSP &ksp) const;
  };

  class SparseDirectMUMPS : public SolverBase
  {
  public:
    struct AdditionalData
    {};
    SparseDirectMUMPS (SolverControl        &cn,
                       const MPI_Comm       &mpi_communicator = PETSC_COMM_SELF,
                       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;

  private:
    static
    PetscErrorCode convergence_test (KSP                ksp,
                                     const PetscInt     iteration,
                                     const PetscReal    residual_norm,
                                     KSPConvergedReason *reason,
                                     void               *solver_control);

    struct SolverDataMUMPS
    {
      ~SolverDataMUMPS ();

      KSP ksp;
      PC  pc;
    };

    std::unique_ptr<SolverDataMUMPS> solver_data;

    bool symmetric_mode;
  };
}

DEAL_II_NAMESPACE_CLOSE

#endif // DEAL_II_WITH_PETSC

/*----------------------------   petsc_solver.h     ---------------------------*/

#endif
/*----------------------------   petsc_solver.h     ---------------------------*/