PetscPreconditioner.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_PETSCPRECONDITIONER_HPP
#define GEOSX_PETSCPRECONDITIONER_HPP

#include "linearAlgebra/solvers/PreconditionerBase.hpp"
#include "linearAlgebra/interfaces/petsc/PetscInterface.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"


extern "C" struct _p_PC;
extern "C" struct _p_MatNullSpace;

using PC = _p_PC *;
using MatNullSpace = _p_MatNullSpace *;


namespace geosx
{

class PetscPreconditioner final : public PreconditionerBase< PetscInterface >
{
public:

  using Base = PreconditionerBase< PetscInterface >;

  using Vector = typename Base::Vector;

  using Matrix = typename Base::Matrix;

  using Base::compute;

  explicit PetscPreconditioner( LinearSolverParameters params );

  PetscPreconditioner( LinearSolverParameters params, array1d< Vector > const & nearNullKernel );

  virtual ~PetscPreconditioner() override;

  virtual void compute( Matrix const & mat ) override;

  virtual void apply( Vector const & src, Vector & dst ) const override;

  virtual void clear() override;

  PC const & unwrapped() const;

private:

  LinearSolverParameters m_parameters;

  PC m_precond;

  MatNullSpace m_nullsp;
};

}

#endif //GEOSX_PETSCPRECONDITIONER_HPP