SuiteSparse.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_INTERFACES_SUITESPARSE_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_SUITESPARSE_HPP_
 
#include "common/DataTypes.hpp"
#include "common/LinearSolverBase.hpp"
#include "common/PreconditionerBase.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"
#include "linearAlgebra/utilities/LinearSolverResult.hpp"
 
#include <memory>
 
namespace geos
{
 
struct SuiteSparseData;
 
template< typename LAI >
class SuiteSparse final : public LinearSolverBase< LAI >
{
public:
 
  using Base = LinearSolverBase< LAI >;
 
  using Vector = typename PreconditionerBase< LAI >::Vector;
 
  using Matrix = typename PreconditionerBase< LAI >::Matrix;
 
  SuiteSparse( LinearSolverParameters params );
 
  virtual ~SuiteSparse() override;
 
  using Base::ready;
  using Base::matrix;
 
  virtual void setup( Matrix const & mat ) override;
 
  virtual void apply( Vector const & src, Vector & dst ) const override;
 
  void applyTranspose( Vector const & src, Vector & dst ) const;
 
  virtual void clear() override;
 
  virtual void solve( Vector const & rhs, Vector & sol ) const override;
 
private:
 
  using Base::m_params;
  using Base::m_result;
 
  void doSolve( Vector const & b, Vector & x, bool transpose ) const;
 
  real64 estimateConditionNumberBasic() const;
 
  real64 estimateConditionNumberAdvanced() const;
 
  std::unique_ptr< SuiteSparseData > m_data;
 
  int m_workingRank;
 
  std::unique_ptr< typename Matrix::Export > m_export;
 
  mutable real64 m_condEst;
};
 
}
 
#endif /*GEOS_LINEARALGEBRA_INTERFACES_SUITESPARSE_HPP_*/