petsc_compatibility.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2016 - 2026 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
/*
 * Rather than using ifdefs everywhere, try to wrap older versions of PETSc
 * functions in one place.
 *
 * Functions that are not inlined are:
 * - Functions returning PetscErrorCode that are supposed to be called within
 *   PETSc callbacks.
 * - Functions that need access to internal PETSc headers that we don't want
 *   to expose to deal.II users
 */
#ifndef dealii_petsc_compatibility_h
#define dealii_petsc_compatibility_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/lac/exceptions.h>
 
#ifdef DEAL_II_WITH_PETSC
 
#  include <petscksp.h>
#  include <petscmat.h>
#  include <petscpc.h>
#  include <petscsnes.h>
#  include <petscts.h>
#  if DEAL_II_PETSC_VERSION_LT(3, 19, 0)
#    define PETSC_SUCCESS 0
#  endif
 
#  include <string>
 
#endif // DEAL_II_WITH_PETSC
 
DEAL_II_NAMESPACE_OPEN
 
#ifdef DEAL_II_WITH_PETSC
namespace PETScWrappers
{
  inline void
  set_option_value(const std::string &name, const std::string &value)
  {
    const PetscErrorCode ierr =
      PetscOptionsSetValue(nullptr, name.c_str(), value.c_str());
    AssertThrow(ierr == 0, ExcPETScError(ierr));
  }
 
 
 
  inline void
  set_matrix_option(Mat            &matrix,
                    const MatOption option_name,
                    const PetscBool option_value = PETSC_FALSE)
  {
    const PetscErrorCode ierr = MatSetOption(matrix, option_name, option_value);
    AssertThrow(ierr == 0, ExcPETScError(ierr));
  }
 
 
 
  inline void
  close_matrix(Mat &matrix)
  {
    if constexpr (running_in_debug_mode())
      {
        set_matrix_option(matrix, MAT_NEW_NONZERO_LOCATION_ERR, PETSC_TRUE);
      }
    else
      {
        set_matrix_option(matrix, MAT_NEW_NONZERO_LOCATIONS, PETSC_FALSE);
      }
  }
 
 
 
  inline void
  set_keep_zero_rows(Mat &matrix)
  {
    set_matrix_option(matrix, MAT_KEEP_NONZERO_PATTERN, PETSC_TRUE);
  }
 
 
 
  void
  petsc_increment_state_counter(Vec v);
 
 
 
  void
  petsc_increment_state_counter(Mat A);
 
 
  PetscErrorCode
  pc_set_failed_reason(PC pc, PCFailedReason reason);
 
 
 
  void
  snes_reset_domain_flags(SNES snes);
 
 
 
  void
  snes_set_jacobian_domain_error(SNES snes);
 
 
 
  void
  set_use_matrix_free(SNES snes, const bool mf_operator, const bool mf);
 
 
 
  void
  set_use_matrix_free(TS ts, const bool mf_operator, const bool mf);
 
 
 
  void
  ts_reset_dm(TS ts);
 
 
 
  void
  ts_set_max_time(TS ts, const PetscReal maxtime);
 
 
 
  void
  ts_set_max_steps(TS ts, const PetscInt maxsteps);
 
 
 
  unsigned int
  ts_get_step_number(TS ts);
 
 
 
  bool
  ts_has_snes(TS ts);
 
} // namespace PETScWrappers
 
#endif // DEAL_II_WITH_PETSC
 
DEAL_II_NAMESPACE_CLOSE
#endif // dealii_petsc_compatibility_h