SuperLUDist.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_LINEARALGEBRA_INTERFACES_SUPERLU_DIST_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_SUPERLU_DIST_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 SuperLUDistData;
 
template< typename LAI >
class SuperLUDist final : public LinearSolverBase< LAI >
{
public:
 
  using Base = LinearSolverBase< LAI >;
 
  using Vector = typename Base::Vector;
 
  using Matrix = typename Base::Matrix;
 
  explicit SuperLUDist( LinearSolverParameters params );
 
  virtual ~SuperLUDist() override;
 
  using Base::ready;
  using Base::matrix;
 
  virtual void setup( Matrix const & mat ) override;
 
  virtual void apply( Vector const & src, Vector & dst ) const override;
 
  virtual void clear() override;
 
  virtual void solve( Vector const & rhs, Vector & sol ) const override;
 
private:
 
  using Base::m_params;
  using Base::m_result;
 
  void setOptions();
 
  void factorize();
 
  real64 estimateConditionNumberBasic() const;
 
  real64 estimateConditionNumberAdvanced() const;
 
  std::unique_ptr< SuperLUDistData > m_data;
 
  mutable real64 m_condEst;
};
 
}
 
#endif /*GEOS_LINEARALGEBRA_INTERFACES_SUPERLU_DIST_HPP_*/