ginkgo_solver.h

// ---------------------------------------------------------------------
//
// Copyright (C) 2018 - 2019 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_ginkgo_solver_h
#  define dealii_ginkgo_solver_h


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

#  ifdef DEAL_II_WITH_GINKGO

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

#    include <ginkgo/ginkgo.hpp>

#    include <memory>

DEAL_II_NAMESPACE_OPEN

namespace GinkgoWrappers
{
  template <typename ValueType, typename IndexType>
  class SolverBase
  {
  public:
    SolverBase(SolverControl &solver_control, const std::string &exec_type);

    virtual ~SolverBase() = default;

    void
    initialize(const SparseMatrix<ValueType> &matrix);

    void
    apply(Vector<ValueType> &solution, const Vector<ValueType> &rhs);

    void
    solve(const SparseMatrix<ValueType> &matrix,
          Vector<ValueType> &            solution,
          const Vector<ValueType> &      rhs);

    SolverControl &
    control() const;


  protected:
    SolverControl &solver_control;

    std::shared_ptr<gko::LinOpFactory> solver_gen;

    std::shared_ptr<gko::stop::ResidualNormReduction<>::Factory>
      residual_criterion;

    std::shared_ptr<gko::log::Convergence<>> convergence_logger;

    std::shared_ptr<gko::stop::Combined::Factory> combined_factory;

    std::shared_ptr<gko::Executor> executor;

  private:
    void
    initialize_ginkgo_log();

    std::shared_ptr<gko::matrix::Csr<ValueType, IndexType>> system_matrix;

    const std::string exec_type;
  };


  template <typename ValueType = double, typename IndexType = int32_t>
  class SolverCG : public SolverBase<ValueType, IndexType>
  {
  public:
    struct AdditionalData
    {};

    SolverCG(SolverControl &       solver_control,
             const std::string &   exec_type,
             const AdditionalData &data = AdditionalData());

    SolverCG(SolverControl &                           solver_control,
             const std::string &                       exec_type,
             const std::shared_ptr<gko::LinOpFactory> &preconditioner,
             const AdditionalData &                    data = AdditionalData());

  protected:
    const AdditionalData additional_data;
  };


  template <typename ValueType = double, typename IndexType = int32_t>
  class SolverBicgstab : public SolverBase<ValueType, IndexType>
  {
  public:
    struct AdditionalData
    {};

    SolverBicgstab(SolverControl &       solver_control,
                   const std::string &   exec_type,
                   const AdditionalData &data = AdditionalData());

    SolverBicgstab(SolverControl &                           solver_control,
                   const std::string &                       exec_type,
                   const std::shared_ptr<gko::LinOpFactory> &preconditioner,
                   const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;
  };

  template <typename ValueType = double, typename IndexType = int32_t>
  class SolverCGS : public SolverBase<ValueType, IndexType>
  {
  public:
    struct AdditionalData
    {};

    SolverCGS(SolverControl &       solver_control,
              const std::string &   exec_type,
              const AdditionalData &data = AdditionalData());

    SolverCGS(SolverControl &                           solver_control,
              const std::string &                       exec_type,
              const std::shared_ptr<gko::LinOpFactory> &preconditioner,
              const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;
  };

  template <typename ValueType = double, typename IndexType = int32_t>
  class SolverFCG : public SolverBase<ValueType, IndexType>
  {
  public:
    struct AdditionalData
    {};

    SolverFCG(SolverControl &       solver_control,
              const std::string &   exec_type,
              const AdditionalData &data = AdditionalData());

    SolverFCG(SolverControl &                           solver_control,
              const std::string &                       exec_type,
              const std::shared_ptr<gko::LinOpFactory> &preconditioner,
              const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;
  };

  template <typename ValueType = double, typename IndexType = int32_t>
  class SolverGMRES : public SolverBase<ValueType, IndexType>
  {
  public:
    struct AdditionalData
    {
      AdditionalData(const unsigned int restart_parameter = 30);

      unsigned int restart_parameter;
    };

    SolverGMRES(SolverControl &       solver_control,
                const std::string &   exec_type,
                const AdditionalData &data = AdditionalData());

    SolverGMRES(SolverControl &                           solver_control,
                const std::string &                       exec_type,
                const std::shared_ptr<gko::LinOpFactory> &preconditioner,
                const AdditionalData &data = AdditionalData());

  protected:
    const AdditionalData additional_data;
  };

  template <typename ValueType = double, typename IndexType = int32_t>
  class SolverIR : public SolverBase<ValueType, IndexType>
  {
  public:
    struct AdditionalData
    {};

    SolverIR(SolverControl &       solver_control,
             const std::string &   exec_type,
             const AdditionalData &data = AdditionalData());

    SolverIR(SolverControl &                           solver_control,
             const std::string &                       exec_type,
             const std::shared_ptr<gko::LinOpFactory> &inner_solver,
             const AdditionalData &                    data = AdditionalData());

  protected:
    const AdditionalData additional_data;
  };


} // namespace GinkgoWrappers

DEAL_II_NAMESPACE_CLOSE

#  endif // DEAL_II_WITH_GINKGO

#endif
/*----------------------------   ginkgo_solver.h ---------------------------*/