RichardsonSolver.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 TotalEnergies
 * 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_RICHARDSONSOLVER_HPP_
#define GEOS_LINEARALGEBRA_SOLVERS_RICHARDSONSOLVER_HPP_
 
#include "linearAlgebra/solvers/KrylovSolver.hpp"
 
namespace geos
{
 
template< typename VECTOR >
class RichardsonSolver final : public KrylovSolver< VECTOR >
{
public:
 
  using Base = KrylovSolver< VECTOR >;
 
  using Vector = typename Base::Vector;
 
 
  RichardsonSolver( LinearSolverParameters params,
                    LinearOperator< Vector > const & matrix,
                    LinearOperator< Vector > const & precond );
 
 
 
  virtual void solve( Vector const & b, Vector & x ) const override;
 
  virtual string methodName() const override
  {
    return "Richardson";
  };
 
 
protected:
 
  using VectorTemp = typename KrylovSolver< VECTOR >::VectorTemp;
 
  using Base::m_params;
  using Base::m_operator;
  using Base::m_precond;
  using Base::m_residualNorms;
  using Base::m_result;
  using Base::createTempVector;
  using Base::logProgress;
  using Base::logResult;
 
private:
 
  real64 m_omega;
};
 
} // geos
 
#endif //GEOS_LINEARALGEBRA_SOLVERS_RICHARDSONSOLVER_HPP_