TrilinosPreconditioner.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_LINEARALGEBRA_INTERFACES_TRILINOSAMG_HPP_
#define GEOSX_LINEARALGEBRA_INTERFACES_TRILINOSAMG_HPP_

#include "linearAlgebra/solvers/PreconditionerBase.hpp"
#include "linearAlgebra/interfaces/trilinos/TrilinosInterface.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"

#include <memory>

class Epetra_Operator;

namespace Teuchos
{
class ParameterList;
}

namespace geosx
{

class TrilinosPreconditioner final : public PreconditionerBase< TrilinosInterface >
{
public:

  using Base = PreconditionerBase< TrilinosInterface >;

  using Vector = typename Base::Vector;

  using Matrix = typename Base::Matrix;

  using Base::compute;

  explicit TrilinosPreconditioner( LinearSolverParameters params );

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

  virtual ~TrilinosPreconditioner() override;

  virtual void compute( Matrix const & mat ) override;

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

  virtual void clear() override;

  Epetra_Operator const & unwrapped() const;

  Epetra_Operator & unwrapped();

private:

  LinearSolverParameters m_parameters;

  std::unique_ptr< Epetra_Operator > m_precond;

  array2d< real64 > m_nullSpacePointer;
};

}

#endif //GEOSX_LINEARALGEBRA_INTERFACES_TRILINOSAMG_HPP_