GMRESsolver.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_SOLVERS_GMRESSOLVER_HPP_
#define GEOSX_LINEARALGEBRA_SOLVERS_GMRESSOLVER_HPP_

#include "linearAlgebra/solvers/KrylovSolver.hpp"

namespace geosx
{

template< typename VECTOR >
class GMRESsolver : public KrylovSolver< VECTOR >
{
public:

  using Base = KrylovSolver< VECTOR >;

  using Vector = typename Base::Vector;


  GMRESsolver( LinearOperator< Vector > const & matrix,
               LinearOperator< Vector > const & precond,
               real64 const tolerance,
               localIndex const maxIterations,
               integer const verbosity = 0,
               localIndex const maxRestart = 100 );

  virtual ~GMRESsolver() override;



  virtual void solve( Vector const & b, Vector & x ) const override final;

  virtual string methodName() const override final
  {
    return "GMRES";
  };


protected:

  using VectorTemp = typename KrylovSolver< VECTOR >::VectorTemp;

  using Base::m_operator;
  using Base::m_precond;
  using Base::m_tolerance;
  using Base::m_maxIterations;
  using Base::m_logLevel;
  using Base::m_result;
  using Base::m_residualNorms;
  using Base::createTempVector;
  using Base::logProgress;
  using Base::logResult;

  localIndex m_maxRestart;

  array1d< VectorTemp > m_kspace;

  bool m_kspaceInitialized;
};

} // namespace geosx

#endif //GEOSX_LINEARALGEBRA_SOLVERS_GMRESSOLVER_HPP_