SuperLU_Dist.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 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_LINEARALGEBRA_INTERFACES_SUPERLU_DIST_HPP_
#define GEOSX_LINEARALGEBRA_INTERFACES_SUPERLU_DIST_HPP_

#include "common/DataTypes.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"

#include <superlu_ddefs.h>

namespace geosx
{

inline int_t toSuperLU_intT( globalIndex const index )
{
  return LvArray::integerConversion< int_t >( index );
}

inline int_t * toSuperLU_intT( globalIndex * const index )
{
  return reinterpret_cast< int_t * >( index );
}

class SuperLU_Dist
{

public:

  SuperLU_Dist();

  SuperLU_Dist( LinearSolverParameters const & params );

  ~SuperLU_Dist();

  void create( LinearSolverParameters const & params );

  int setup();

  int solve( real64 const * b, real64 * x );

  real64 condEst();

  real64 relativeTolerance();

  void destroy();

  void setNumGlobalRows( int_t const numGlobalRows );

  int_t numGlobalRows() const;

  void setNumGlobalCols( int_t const numGlobalCols );

  int_t numGlobalCols() const;

  void setNumLocalRows( int_t const numLocalRows );

  int_t numLocalRows() const;

  void setComm( MPI_Comm const comm );

  MPI_Comm getComm() const;

  void resize( localIndex const numLocalRows, localIndex const numLocalNonzeros );

  void createSuperMatrix( globalIndex const ilower );

  int_t * rowPtr();

  int_t * colIndices();

  real64 * values();

  real64 setupTime() const;

  real64 solveTime() const;

  LinearSolverParameters getParameters() const;

  real64 precisionTolerance() const;

private:

  int_t m_numGlobalRows;

  int_t m_numGlobalCols;

  int_t m_numLocalRows;

  int_t m_numLocalNonzeros;

  int_t * m_rowPtr;

  int_t * m_colIndices;

  real64 * m_values;

  SuperMatrix m_mat;

  dScalePermstruct_t m_ScalePermstruct;

  dLUstruct_t m_LUstruct;

  SuperLUStat_t m_stat;

  gridinfo_t m_grid;

  dSOLVEstruct_t m_SOLVEstruct;

  superlu_dist_options_t m_options;

  MPI_Comm m_comm;

  real64 m_condEst;

  real64 m_setupTime;

  real64 m_solveTime;

  LinearSolverParameters m_params;

  real64 const m_precisionTolerance = 100.0 * std::numeric_limits< real64 >::epsilon();
};

}

#endif /*GEOSX_LINEARALGEBRA_INTERFACES_SUPERLU_DIST_HPP_*/