LinearSolverBase.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 TotalEnergies
 * 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_LINEARSOLVERBASE_HPP
#define GEOS_LINEARSOLVERBASE_HPP
 
#include "PreconditionerBase.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"
#include "linearAlgebra/utilities/LinearSolverResult.hpp"
#include "common/Stopwatch.hpp"
 
#include <string>
 
namespace geos
{
 
struct LinearSolverExecutionContext
{
  std::string solverName;
  integer cycleNumber = -1;
  integer timeStepAttempt = -1;
  integer configurationAttempt = -1;
  integer nonlinearIteration = -1;
  Timestamp systemSetupTimestamp = 0;
};
 
template< typename LAI >
class LinearSolverBase : public PreconditionerBase< LAI >
{
public:
 
  using Base = PreconditionerBase< LAI >;
 
  using Vector = typename Base::Vector;
 
  using Matrix = typename Base::Matrix;
 
  explicit LinearSolverBase( LinearSolverParameters params )
    : m_params( std::move( params ) )
  {}
 
  virtual void solve( Vector const & rhs, Vector & sol ) const = 0;
 
  virtual void setExecutionContext( LinearSolverExecutionContext const & context )
  {
    GEOS_UNUSED_VAR( context );
  }
 
  LinearSolverParameters const & parameters() const
  {
    return m_params;
  }
 
  LinearSolverResult const & result() const
  {
    return m_result;
  }
 
protected:
 
  LinearSolverParameters m_params;
 
  mutable LinearSolverResult m_result;
};
 
}
 
#endif //GEOS_LINEARSOLVERBASE_HPP