SuiteSparse.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_SUITESPARSE_HPP_
#define GEOSX_LINEARALGEBRA_INTERFACES_SUITESPARSE_HPP_

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

#include <umfpack.h>

namespace geosx
{

using SSInt = SuiteSparse_long;

inline SSInt toSuiteSparse_Int( globalIndex const index )
{
  return LvArray::integerConversion< SSInt >( index );
}

class SuiteSparse
{

public:

  SuiteSparse();

  SuiteSparse( LinearSolverParameters const & params );

  ~SuiteSparse();

  void create( LinearSolverParameters const & params );

  int setup();

  int solveWorkingRank( real64 * b, real64 * x, bool transpose = false );

  void syncTimes();

  real64 condEst() const;

  real64 relativeTolerance() const;

  void destroy();

  void setWorkingRank( int const workingRank );

  int workingRank() const;

  void setSubCommWorkingRank( int const subCommWorkingRank );

  int subCommWorkingRank() const;

  void setComm( MPI_Comm const comm );

  MPI_Comm getComm() const;

  void setSubComm( MPI_Comm const subComm );

  MPI_Comm getSubComm() const;

  SSInt numRows() const;

  SSInt numCols() const;

  SSInt nonZeros() const;

  void resize( SSInt const numRows, SSInt const numCols, SSInt const nonZeros );

  arrayView1d< SSInt > rowPtr();

  arrayView1d< SSInt > colIndices();

  arrayView1d< real64 > values();

  real64 setupTime() const;

  real64 solveTime() const;

  real64 precisionTolerance() const;

private:

  integer m_logLevel;

  SSInt m_numRows;

  SSInt m_numCols;

  SSInt m_nonZeros;

  array1d< SSInt > m_rowPtr;

  array1d< SSInt > m_colIndices;

  array1d< real64 > m_values;

  real64 m_Info[UMFPACK_INFO];

  real64 m_Control[UMFPACK_CONTROL];

  void * m_Symbolic;

  void * m_Numeric;

  MPI_Comm m_comm;

  MPI_Comm m_subComm;

  bool m_usingSubComm;

  int m_workingRank;

  int m_subCommWorkingRank;

  real64 m_condEst;

  real64 m_setupTime;

  real64 m_solveTime;

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

};

}

#endif /*GEOSX_LINEARALGEBRA_INTERFACES_SUITESPARSE_HPP_*/