petsc_matrix_free.h

// ---------------------------------------------------------------------
//
// Copyright (C) 2012 - 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.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------

#ifndef dealii_petsc_matrix_free_h
#  define dealii_petsc_matrix_free_h


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

#  ifdef DEAL_II_WITH_PETSC
#    include <deal.II/lac/exceptions.h>
#    include <deal.II/lac/petsc_matrix_base.h>
#    include <deal.II/lac/petsc_vector.h>
DEAL_II_NAMESPACE_OPEN



namespace PETScWrappers
{
  class MatrixFree : public MatrixBase
  {
  public:
    MatrixFree();

    MatrixFree(const MPI_Comm &   communicator,
               const unsigned int m,
               const unsigned int n,
               const unsigned int local_rows,
               const unsigned int local_columns);

    MatrixFree(const MPI_Comm &                 communicator,
               const unsigned int               m,
               const unsigned int               n,
               const std::vector<unsigned int> &local_rows_per_process,
               const std::vector<unsigned int> &local_columns_per_process,
               const unsigned int               this_process);

    MatrixFree(const unsigned int m,
               const unsigned int n,
               const unsigned int local_rows,
               const unsigned int local_columns);

    MatrixFree(const unsigned int               m,
               const unsigned int               n,
               const std::vector<unsigned int> &local_rows_per_process,
               const std::vector<unsigned int> &local_columns_per_process,
               const unsigned int               this_process);

    void
    reinit(const MPI_Comm &   communicator,
           const unsigned int m,
           const unsigned int n,
           const unsigned int local_rows,
           const unsigned int local_columns);

    void
    reinit(const MPI_Comm &                 communicator,
           const unsigned int               m,
           const unsigned int               n,
           const std::vector<unsigned int> &local_rows_per_process,
           const std::vector<unsigned int> &local_columns_per_process,
           const unsigned int               this_process);

    void
    reinit(const unsigned int m,
           const unsigned int n,
           const unsigned int local_rows,
           const unsigned int local_columns);

    void
    reinit(const unsigned int               m,
           const unsigned int               n,
           const std::vector<unsigned int> &local_rows_per_process,
           const std::vector<unsigned int> &local_columns_per_process,
           const unsigned int               this_process);

    void
    clear();

    const MPI_Comm &
    get_mpi_communicator() const override;

    virtual void
    vmult(VectorBase &dst, const VectorBase &src) const = 0;

    virtual void
    Tvmult(VectorBase &dst, const VectorBase &src) const = 0;

    virtual void
    vmult_add(VectorBase &dst, const VectorBase &src) const = 0;

    virtual void
    Tvmult_add(VectorBase &dst, const VectorBase &src) const = 0;

    virtual void
    vmult(Vec &dst, const Vec &src) const;

  private:
    MPI_Comm communicator;

    static int
    matrix_free_mult(Mat A, Vec src, Vec dst);

    void
    do_reinit(const unsigned int m,
              const unsigned int n,
              const unsigned int local_rows,
              const unsigned int local_columns);
  };



  // -------- template and inline functions ----------

  inline const MPI_Comm &
  MatrixFree::get_mpi_communicator() const
  {
    return communicator;
  }
} // namespace PETScWrappers

DEAL_II_NAMESPACE_CLOSE

#  endif // DEAL_II_WITH_PETSC

#endif
/*---------------------------- petsc_matrix_free.h --------------------------*/