petsc_preconditioner.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2019 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library 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 2.1 of the License, or (at your option) any later version.
 
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef LIBMESH_PETSC_PRECONDITIONER_H
#define LIBMESH_PETSC_PRECONDITIONER_H
 
#include "libmesh/libmesh_config.h"
 
#ifdef LIBMESH_HAVE_PETSC
 
// Local includes
#include "libmesh/preconditioner.h"
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/libmesh.h"
#include "libmesh/petsc_macro.h"
 
#ifdef LIBMESH_FORWARD_DECLARE_ENUMS
namespace libMesh
{
enum PreconditionerType : int;
}
#else
#include "libmesh/enum_preconditioner_type.h"
#endif
 
// Petsc includes
#include "petscpc.h"
 
namespace libMesh
{
 
// forward declarations
template <typename T> class SparseMatrix;
template <typename T> class NumericVector;
template <typename T> class ShellMatrix;
 
template <typename T>
class PetscPreconditioner : public Preconditioner<T>
{
public:
 
  PetscPreconditioner (const libMesh::Parallel::Communicator & comm_in);
 
  virtual ~PetscPreconditioner ();
 
  virtual void apply(const NumericVector<T> & x, NumericVector<T> & y) override;
 
  virtual void clear () override;
 
  virtual void init () override;
 
  PC pc() { return _pc; }
 
  static void set_petsc_preconditioner_type (const PreconditionerType & preconditioner_type, PC & pc);
 
protected:
 
  PC _pc;
 
  Mat _mat;
 
private:
#if PETSC_VERSION_LESS_THAN(3,0,0)
  // In Petsc 2.3.3, PCType was #define'd as const char *
  static void set_petsc_subpreconditioner_type(PCType type, PC & pc);
#else
  // In later versions, PCType is #define'd as char *, so we need the const
  static void set_petsc_subpreconditioner_type(const PCType type, PC & pc);
#endif
};
 
 
 
 
/*----------------------- inline functions ----------------------------------*/
template <typename T>
inline
PetscPreconditioner<T>::PetscPreconditioner (const libMesh::Parallel::Communicator & comm_in) :
  Preconditioner<T>(comm_in),
  _pc(PETSC_NULL)
{
}
 
 
 
template <typename T>
inline
PetscPreconditioner<T>::~PetscPreconditioner ()
{
  this->clear ();
}
 
} // namespace libMesh
 
#endif // #ifdef LIBMESH_HAVE_PETSC
#endif // LIBMESH_PETSC_PRECONDITIONER_H