PetscPreconditioner.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_LINEARALGEBRA_INTERFACES_PETSCPRECONDITIONER_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_PETSCPRECONDITIONER_HPP_
 
#include "common/PreconditionerBase.hpp"
#include "linearAlgebra/interfaces/petsc/PetscInterface.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"
 
 
extern "C" struct _p_PC;
extern "C" struct _p_MatNullSpace;
 
 
namespace geos
{
 
class PetscPreconditioner final : public PreconditionerBase< PetscInterface >
{
public:
 
  using Base = PreconditionerBase< PetscInterface >;
 
  using Vector = typename Base::Vector;
 
  using Matrix = typename Base::Matrix;
 
  explicit PetscPreconditioner( LinearSolverParameters params );
 
  PetscPreconditioner( LinearSolverParameters params,
                       arrayView1d< Vector const > nearNullKernel );
 
  virtual ~PetscPreconditioner() override;
 
  virtual void setup( Matrix const & mat ) override;
 
  virtual void apply( Vector const & src, Vector & dst ) const override;
 
  virtual void clear() override;
 
private:
 
  using PC = _p_PC *;
 
public:
 
  PC const & unwrapped() const;
 
private:
 
  using MatNullSpace = _p_MatNullSpace *;
 
  PetscMatrix const & setupPreconditioningMatrix( PetscMatrix const & mat );
 
  LinearSolverParameters m_params;
 
  PC m_precond;
 
  PetscMatrix m_precondMatrix;
 
  MatNullSpace m_nullsp;
};
 
}
 
#endif //GEOS_LINEARALGEBRA_INTERFACES_PETSCPRECONDITIONER_HPP_