HypreMatrix.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_HYPREMATRIX_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_HYPREMATRIX_HPP_
 
#include "common/DataTypes.hpp"
#include "linearAlgebra/DofManager.hpp"
#include "linearAlgebra/interfaces/hypre/HypreVector.hpp"
#include "linearAlgebra/interfaces/hypre/HypreExport.hpp"
#include "linearAlgebra/common/LinearOperator.hpp"
#include "linearAlgebra/interfaces/MatrixBase.hpp"
 
 
extern "C" struct hypre_IJMatrix_struct;
 
extern "C" struct hypre_ParCSRMatrix_struct;
 
 
namespace geos
{
 
class HypreMatrix final : public virtual LinearOperator< HypreVector >,
  private MatrixBase< HypreMatrix, HypreVector >
{
public:
 
  using Vector = HypreVector;
 
  using Export = HypreExport;
 
  using HYPRE_IJMatrix = hypre_IJMatrix_struct *;
 
  using HYPRE_ParCSRMatrix = hypre_ParCSRMatrix_struct *;
 
 
  HypreMatrix();
 
  HypreMatrix( HypreMatrix const & src );
 
  HypreMatrix( HypreMatrix && src ) noexcept;
 
  HypreMatrix & operator=( HypreMatrix const & src );
 
  HypreMatrix & operator=( HypreMatrix && src ) noexcept;
 
  ~HypreMatrix() override;
 
 
 
  using MatrixBase::createWithLocalSize;
  using MatrixBase::createWithGlobalSize;
  using MatrixBase::closed;
  using MatrixBase::assembled;
  using MatrixBase::insertable;
  using MatrixBase::modifiable;
  using MatrixBase::ready;
  using MatrixBase::residual;
  using MatrixBase::setDofManager;
  using MatrixBase::dofManager;
  using MatrixBase::create;
 
  virtual void create( CRSMatrixView< real64 const, globalIndex const > const & localMatrix,
                       localIndex const numLocalColumns,
                       MPI_Comm const & comm ) override;
 
  virtual void createWithLocalSize( localIndex const localRows,
                                    localIndex const localCols,
                                    localIndex const maxEntriesPerRow,
                                    MPI_Comm const & comm ) override;
 
  virtual void createWithGlobalSize( globalIndex const globalRows,
                                     globalIndex const globalCols,
                                     localIndex const maxEntriesPerRow,
                                     MPI_Comm const & comm ) override;
 
  virtual void open() override;
 
  virtual void close() override;
 
  virtual bool created() const override;
 
  virtual void reset() override;
 
  virtual void set( real64 const value ) override;
 
  virtual void zero() override;
 
  virtual void add( globalIndex const rowIndex,
                    globalIndex const colIndex,
                    real64 const value ) override;
 
  virtual void set( globalIndex const rowIndex,
                    globalIndex const colIndex,
                    real64 const value ) override;
 
  virtual void insert( globalIndex const rowIndex,
                       globalIndex const colIndex,
                       real64 const value ) override;
 
  virtual void add( globalIndex const rowIndex,
                    globalIndex const * colIndices,
                    real64 const * values,
                    localIndex const size ) override;
 
  virtual void set( globalIndex const rowIndex,
                    globalIndex const * colIndices,
                    real64 const * values,
                    localIndex const size ) override;
 
  virtual void insert( globalIndex const rowIndex,
                       globalIndex const * colIndices,
                       real64 const * values,
                       localIndex const size ) override;
 
  virtual void add( globalIndex const rowIndex,
                    arraySlice1d< globalIndex const > const & colIndices,
                    arraySlice1d< real64 const > const & values ) override;
 
  virtual void set( globalIndex const rowIndex,
                    arraySlice1d< globalIndex const > const & colIndices,
                    arraySlice1d< real64 const > const & values ) override;
 
  virtual void insert( globalIndex const rowIndex,
                       arraySlice1d< globalIndex const > const & colIndices,
                       arraySlice1d< real64 const > const & values ) override;
 
  virtual void add( arraySlice1d< globalIndex const > const & rowIndices,
                    arraySlice1d< globalIndex const > const & colIndices,
                    arraySlice2d< real64 const > const & values ) override;
 
  virtual void set( arraySlice1d< globalIndex const > const & rowIndices,
                    arraySlice1d< globalIndex const > const & colIndices,
                    arraySlice2d< real64 const > const & values ) override;
 
  virtual void insert( arraySlice1d< globalIndex const > const & rowIndices,
                       arraySlice1d< globalIndex const > const & colIndices,
                       arraySlice2d< real64 const > const & values ) override;
 
  virtual void add( globalIndex const * rowIndices,
                    globalIndex const * colIndices,
                    real64 const * values,
                    localIndex const numRows,
                    localIndex const numCols ) override;
 
  virtual void set( globalIndex const * rowIndices,
                    globalIndex const * colIndices,
                    real64 const * values,
                    localIndex const numRows,
                    localIndex const numCols ) override;
 
  virtual void insert( globalIndex const * rowIndices,
                       globalIndex const * colIndices,
                       real64 const * values,
                       localIndex const numRows,
                       localIndex const numCols ) override;
 
  virtual void insert( arrayView1d< globalIndex const > const & rowIndices,
                       arrayView1d< globalIndex const > const & colIndices,
                       arrayView1d< real64 const > const & values ) override;
 
  virtual void apply( HypreVector const & src,
                      HypreVector & dst ) const override;
 
  virtual void applyTranspose( HypreVector const & src,
                               HypreVector & dst ) const override;
 
  virtual void multiply( HypreMatrix const & src,
                         HypreMatrix & dst ) const override;
 
  virtual void leftMultiplyTranspose( HypreMatrix const & src,
                                      HypreMatrix & dst ) const override;
 
  virtual void rightMultiplyTranspose( HypreMatrix const & src,
                                       HypreMatrix & dst ) const override;
 
  virtual void multiplyRAP( HypreMatrix const & R,
                            HypreMatrix const & P,
                            HypreMatrix & dst ) const override;
 
  virtual void multiplyPtAP( HypreMatrix const & P,
                             HypreMatrix & dst ) const override;
 
  virtual void gemv( real64 const alpha,
                     HypreVector const & x,
                     real64 const beta,
                     HypreVector & y,
                     bool useTranspose = false ) const override;
 
  virtual void scale( real64 const scalingFactor ) override;
 
  virtual void leftScale( HypreVector const & vec ) override;
 
  virtual void rescaleRows( arrayView1d< globalIndex const > const & rowIndices,
                            RowSumType const rowSumType ) override;
 
  virtual void rightScale( HypreVector const & vec ) override;
 
  virtual void computeScalingVector( HypreVector & scaling ) const override;
 
  virtual void leftRightScale( HypreVector const & vecLeft,
                               HypreVector const & vecRight ) override;
 
  virtual void transpose( HypreMatrix & dst ) const override;
 
  virtual void separateComponentFilter( HypreMatrix & dst,
                                        integer const dofPerPoint ) const override;
 
  virtual real64 clearRow( globalIndex const row,
                           bool const keepDiag = false,
                           real64 const diagValue = 0.0 ) override;
 
  virtual void addEntries( HypreMatrix const & src,
                           MatrixPatternOp const op,
                           real64 const scale ) override;
 
  virtual void addDiagonal( HypreVector const & src,
                            real64 const scale ) override;
 
  virtual void clampEntries( real64 const lo,
                             real64 const hi,
                             bool const excludeDiag ) override;
 
  virtual localIndex maxRowLength() const override;
 
  virtual localIndex rowLength( globalIndex const globalRowIndex ) const override;
 
  virtual void getRowLengths( arrayView1d< localIndex > const & lengths ) const override;
 
  virtual void getRowCopy( globalIndex globalRowIndex,
                           arraySlice1d< globalIndex > const & colIndices,
                           arraySlice1d< real64 > const & values ) const override;
 
  virtual void extractDiagonal( HypreVector & dst ) const override;
 
  virtual void getRowSums( HypreVector & dst,
                           RowSumType const rowSumType ) const override;
 
  virtual globalIndex numGlobalRows() const override;
 
  virtual globalIndex numGlobalCols() const override;
 
  virtual localIndex numLocalRows() const override;
 
  virtual localIndex numLocalCols() const override;
 
  virtual globalIndex ilower() const override;
 
  virtual globalIndex iupper() const override;
 
  virtual globalIndex jlower() const override;
 
  virtual globalIndex jupper() const override;
 
  virtual localIndex numLocalNonzeros() const override;
 
  virtual globalIndex numGlobalNonzeros() const override;
 
  virtual real64 normInf() const override;
 
  virtual real64 norm1() const override;
 
  virtual real64 normFrobenius() const override;
 
  virtual real64 normMax() const override;
 
  virtual real64 normMax( arrayView1d< globalIndex const > const & rowIndices ) const override;
 
  virtual localIndex getLocalRowID( globalIndex const index ) const override;
 
  virtual globalIndex getGlobalRowID( localIndex const index ) const override;
 
  virtual MPI_Comm comm() const override;
 
  virtual void print( std::ostream & os = std::cout ) const override;
 
  virtual void write( string const & filename,
                      LAIOutputFormat const format = LAIOutputFormat::MATRIX_MARKET ) const override;
 
 
  HYPRE_ParCSRMatrix const & unwrapped() const;
 
  HYPRE_IJMatrix const & unwrappedIJ() const;
 
private:
 
  void parCSRtoIJ( HYPRE_ParCSRMatrix const & parCSRMatrix );
 
  HYPRE_IJMatrix m_ij_mat{};
 
  HYPRE_ParCSRMatrix m_parcsr_mat{};
 
};
 
} // namespace geos
 
#endif /*GEOS_LINEARALGEBRA_INTERFACES_HYPREMATRIX_HPP_*/