Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Private Member Functions | Private Attributes | List of all members
AMP::LinearAlgebra::HypreMatrixAdaptor Class Reference

Wrapper class for constructing a hypre IJ matrix for use with solvers. More...

#include <HypreMatrixAdaptor.h>

Public Member Functions

HYPRE_IJMatrix getHypreMatrix (void)
 Returns the handle to the HYPRE IJMatrix.
 
 HypreMatrixAdaptor ()=delete
 
 HypreMatrixAdaptor (std::shared_ptr< MatrixData >)
 ! Main constructor using a MatrixData object
 
 ~HypreMatrixAdaptor ()
 

Private Member Functions

template<class csr_data_type >
void initializeHypreMatrix (std::shared_ptr< csr_data_type >, HYPRE_MemoryLocation memory_location)
 Main internal routine for initializing the matrix.
 

Private Attributes

std::shared_ptr< MatrixDatad_csrdata_dev
 Storage for migrated matrix data.
 
HYPRE_IJMatrix d_matrix
 hypre IJ matrix that this class wraps
 

Detailed Description

Wrapper class for constructing a hypre IJ matrix for use with solvers.

It is initialized based on CSR data.

Definition at line 17 of file HypreMatrixAdaptor.h.

Constructor & Destructor Documentation

◆ HypreMatrixAdaptor() [1/2]

AMP::LinearAlgebra::HypreMatrixAdaptor::HypreMatrixAdaptor ( )
delete

◆ ~HypreMatrixAdaptor()

AMP::LinearAlgebra::HypreMatrixAdaptor::~HypreMatrixAdaptor ( )

◆ HypreMatrixAdaptor() [2/2]

AMP::LinearAlgebra::HypreMatrixAdaptor::HypreMatrixAdaptor ( std::shared_ptr< MatrixData )

! Main constructor using a MatrixData object

Member Function Documentation

◆ getHypreMatrix()

HYPRE_IJMatrix AMP::LinearAlgebra::HypreMatrixAdaptor::getHypreMatrix ( void  )
inline

Returns the handle to the HYPRE IJMatrix.

Definition at line 28 of file HypreMatrixAdaptor.h.

References d_matrix.

◆ initializeHypreMatrix()

template<class csr_data_type >
void AMP::LinearAlgebra::HypreMatrixAdaptor::initializeHypreMatrix ( std::shared_ptr< csr_data_type >  ,
HYPRE_MemoryLocation  memory_location 
)
private

Main internal routine for initializing the matrix.

Member Data Documentation

◆ d_csrdata_dev

std::shared_ptr<MatrixData> AMP::LinearAlgebra::HypreMatrixAdaptor::d_csrdata_dev
private

Storage for migrated matrix data.

Definition at line 40 of file HypreMatrixAdaptor.h.

◆ d_matrix

HYPRE_IJMatrix AMP::LinearAlgebra::HypreMatrixAdaptor::d_matrix
private

hypre IJ matrix that this class wraps

Definition at line 37 of file HypreMatrixAdaptor.h.

Referenced by getHypreMatrix().


The documentation for this class was generated from the following file:



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:42.
Comments on this page