CgSolver.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 Total, S.A
 * 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_SOLVERS_CGSOLVER_HPP_
#define GEOS_LINEARALGEBRA_SOLVERS_CGSOLVER_HPP_
 
#include "linearAlgebra/solvers/KrylovSolver.hpp"
 
namespace geos
{
 
template< typename VECTOR >
class CgSolver : public KrylovSolver< VECTOR >
{
public:
 
  using Base = KrylovSolver< VECTOR >;
 
  using Vector = typename Base::Vector;
 
 
  CgSolver( LinearSolverParameters params,
            LinearOperator< Vector > const & A,
            LinearOperator< Vector > const & M );
 
 
 
  virtual void solve( Vector const & b, Vector & x ) const override final;
 
  virtual string methodName() const override final
  {
    return "CG";
  };
 
 
protected:
 
  using VectorTemp = typename KrylovSolver< VECTOR >::VectorTemp;
 
  using Base::m_params;
  using Base::m_operator;
  using Base::m_precond;
  using Base::m_result;
  using Base::m_residualNorms;
  using Base::createTempVector;
  using Base::logProgress;
  using Base::logResult;
 
};
 
} // namespace GEOSX
 
#endif /*GEOS_LINEARALGEBRA_SOLVERS_CGSOLVER_HPP_*/