libdolfin-dev 2017.2.0.post0-2 / usr / include / dolfin / la / PETScKrylovSolver.h

// Copyright (C) 2004-2015 Johan Jansson and Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Anders Logg 2005-2012
// Modified by Johan Hoffman 2005
// Modified by Andy R. Terrel 2005
// Modified by Garth N. Wells 2005-2010

#ifndef __DOLFIN_PETSC_KRYLOV_SOLVER_H
#define __DOLFIN_PETSC_KRYLOV_SOLVER_H

#ifdef HAS_PETSC

#include <map>
#include <memory>
#include <string>
#include <petscksp.h>
#include <dolfin/common/types.h>
#include "GenericLinearSolver.h"
#include "PETScObject.h"

namespace dolfin
{

  /// Forward declarations
  class GenericMatrix;
  class GenericVector;
  class PETScBaseMatrix;
  class PETScMatrix;
  class PETScVector;
  class PETScPreconditioner;
  class PETScSNESSolver;
  class VectorSpaceBasis;

  class PETScDMCollection;

  /// This class implements Krylov methods for linear systems of the
  /// form Ax = b. It is a wrapper for the Krylov solvers of PETSc.

  class PETScKrylovSolver : public GenericLinearSolver, public PETScObject
  {
  public:

    /// Norm types used in convergence testing. Not all solvers types
    /// support all norm types (see
    /// http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/KSP/KSPSetNormType.html). Note
    /// that 'default' is a reserved keyword, so we use 'default_norm'
    enum class norm_type {none, default_norm, preconditioned, unpreconditioned, natural};

    /// Create Krylov solver for a particular method and named
    /// preconditioner
    PETScKrylovSolver(MPI_Comm comm,
                      std::string method="default",
                      std::string preconditioner="default");

    /// Create Krylov solver for a particular method and named
    /// preconditioner
    PETScKrylovSolver(std::string method="default",
                      std::string preconditioner="default");

    /// Create Krylov solver for a particular method and
    /// PETScPreconditioner (shared_ptr version)
    PETScKrylovSolver(MPI_Comm comm,
                      std::string method,
                      std::shared_ptr<PETScPreconditioner> preconditioner);

    /// Create Krylov solver for a particular method and
    /// PETScPreconditioner (shared_ptr version)
    PETScKrylovSolver(std::string method,
                      std::shared_ptr<PETScPreconditioner> preconditioner);

    /// Create solver wrapper of a PETSc KSP object
    explicit PETScKrylovSolver(KSP ksp);

    /// Destructor
    virtual ~PETScKrylovSolver();

    /// Set operator (matrix)
    void set_operator(std::shared_ptr<const GenericLinearOperator> A);

    /// Set operator (PETScMatrix). This is memory-safe as PETSc will
    /// increase the reference count to the underlying PETSc object.
    void set_operator(const PETScBaseMatrix& A);

    /// Set operator (matrix) and preconditioner matrix
    void set_operators(std::shared_ptr<const GenericLinearOperator> A,
                       std::shared_ptr<const GenericLinearOperator> P);

    /// Set operator and preconditioner matrix (PETScMatrix). This is
    /// memory-safe as PETSc will increase the reference count to the
    /// underlying PETSc objects.
    void set_operators(const PETScBaseMatrix& A, const PETScBaseMatrix& P);

    /// Solve linear system Ax = b and return number of iterations
    std::size_t solve(GenericVector& x, const GenericVector& b);

    /// Solve linear system Ax = b and return number of iterations
    /// (A^t x = b if transpose is true)
    std::size_t solve(GenericVector& x, const GenericVector& b,
                      bool transpose);

    /// Solve linear system Ax = b and return number of iterations
    /// (A^t x = b if transpose is true)
    std::size_t solve(PETScVector& x, const PETScVector& b,
                      bool transpose=false);

    /// Solve linear system Ax = b and return number of iterations
    std::size_t solve(const GenericLinearOperator& A, GenericVector& x,
                      const GenericVector& b);

    /// Use nonzero initial guess for solution function
    /// (nonzero_guess=true, the solution vector x will not be zeroed
    /// before the solver starts)
    void set_nonzero_guess(bool nonzero_guess);

    /// Reuse preconditioner if true, even if matrix operator changes
    /// (by default preconditioner will be re-built if the matrix
    /// changes)
    void set_reuse_preconditioner(bool reuse_pc);

    /// Set tolerances (relative residual, alsolute residial, maximum
    /// number of iterations)
    void set_tolerances(double relative, double absolute, double diverged,
                        int max_iter);

    /// Set norm type used in convergence testing - not all solvers
    /// types support all norm types
    void set_norm_type(norm_type type);

    /// Get norm type used in convergence testing
    norm_type get_norm_type() const;

    /// Monitor residual at each iteration
    void monitor(bool monitor_convergence);

    /// Sets the prefix used by PETSc when searching the PETSc options
    /// database
    void set_options_prefix(std::string options_prefix);

    /// Returns the prefix used by PETSc when searching the PETSc
    /// options database
    std::string get_options_prefix() const;

    /// Set options from PETSc options database
    void set_from_options() const;

    /// Return informal string representation (pretty-print)
    std::string str(bool verbose) const;

    /// Return MPI communicator
    MPI_Comm mpi_comm() const;

    /// Return PETSc KSP pointer
    KSP ksp() const;

    /// Return a list of available solver methods
    static std::map<std::string, std::string> methods();

    /// Return a list of available named preconditioners
    static std::map<std::string, std::string> preconditioners();

    /// Default parameter values
    static Parameters default_parameters();

    /// Return parameter type: "krylov_solver" or "lu_solver"
    std::string parameter_type() const
    { return "krylov_solver"; }

    /// Set the DM
    void set_dm(DM dm);

    /// Activate/deactivate DM
    void set_dm_active(bool val);

    friend class PETScSNESSolver;
    friend class PETScTAOSolver;

  private:

    // Return norm_type enum for norm string
    static PETScKrylovSolver::norm_type get_norm_type(std::string norm);

    // Solve linear system Ax = b and return number of iterations
    std::size_t _solve(const PETScBaseMatrix& A, PETScVector& x,
                       const PETScVector& b);

    // Report the number of iterations
    void write_report(int num_iterations, KSPConvergedReason reason);

    void check_dimensions(const PETScBaseMatrix& A, const GenericVector& x,
                          const GenericVector& b) const;

    // Available solvers
    static const std::map<std::string, const KSPType> _methods;

    // Available solvers descriptions
    static const std::map<std::string, std::string> _methods_descr;

    // PETSc solver pointer
    KSP _ksp;

    // Preconditioner
    std::shared_ptr<PETScPreconditioner> _preconditioner;

    bool preconditioner_set;

  };

}

#endif

#endif