Opm::cuistl::detail Namespace Reference

Classes
class	CuBlasHandle
	The CuBlasHandle class provides a singleton for the simulator universal cuBlasHandle. More...
class	CuSparseHandle
	The CuSparseHandle class provides a singleton for the simulator universal cuSparseHandle. More...
class	CuSparseResource
	The CuSparseResource class wraps a CuSparse resource in a proper RAII pattern. More...
class	has_communication
	The has_communication class checks if the type has the member function getCommunication. More...
class	has_should_call_post
	The has_should_call_post class detects the presence of the method shouldCallPost. More...
class	has_should_call_pre
	The has_should_call_pre class detects the presence of the method shouldCallPre. More...
class	is_a_well_operator
	The is_a_well_operator class tries to guess if the operator is a well type operator. More...

Typedefs
using	CuSparseMatrixDescription = CuSparseResource< cusparseMatDescr_t >
using	CuSparseMatrixDescriptionPtr = std::shared_ptr< CuSparseResource< cusparseMatDescr_t > >

Functions
std::string	getCublasErrorMessage (cublasStatus_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	getCublasErrorMessage generates the error message to display for a given error. More...
void	cublasSafeCall (cublasStatus_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	cublasSafeCall checks the return type of the CUBLAS expression (function call) and throws an exception if it does not equal CUBLAS_STATUS_SUCCESS. More...
cublasStatus_t	cublasWarnIfError (cublasStatus_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	cublasWarnIfError checks the return type of the CUBLAS expression (function call) and issues a warning if it does not equal CUBLAS_STATUS_SUCCESS. More...
cublasStatus_t	cublasScal (cublasHandle_t handle, int n, const double *alpha, double *x, int incx)
cublasStatus_t	cublasScal (cublasHandle_t handle, int n, const float *alpha, float *x, int incx)
cublasStatus_t	cublasScal (cublasHandle_t handle, int n, const int *alpha, int *x, int incx)
cublasStatus_t	cublasAxpy (cublasHandle_t handle, int n, const double *alpha, const double *x, int incx, double *y, int incy)
cublasStatus_t	cublasAxpy (cublasHandle_t handle, int n, const float *alpha, const float *x, int incx, float *y, int incy)
cublasStatus_t	cublasAxpy (cublasHandle_t handle, int n, const int *alpha, const int *x, int incx, int *y, int incy)
cublasStatus_t	cublasDot (cublasHandle_t handle, int n, const double *x, int incx, const double *y, int incy, double *result)
cublasStatus_t	cublasDot (cublasHandle_t handle, int n, const float *x, int incx, const float *y, int incy, float *result)
cublasStatus_t	cublasDot (cublasHandle_t handle, int n, const int *x, int incx, const int *y, int incy, int *result)
cublasStatus_t	cublasNrm2 (cublasHandle_t handle, int n, const double *x, int incx, double *result)
cublasStatus_t	cublasNrm2 (cublasHandle_t handle, int n, const float *x, int incx, float *result)
cublasStatus_t	cublasNrm2 (cublasHandle_t handle, int n, const int *x, int incx, int *result)
std::string	getCudaErrorMessage (cudaError_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	getCudaErrorMessage generates the error message to display for a given error. More...
void	cudaSafeCall (cudaError_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	cudaSafeCall checks the return type of the CUDA expression (function call) and throws an exception if it does not equal cudaSuccess. More...
cudaError_t	cudaWarnIfError (cudaError_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	cudaWarnIfError checks the return type of the CUDA expression (function call) and issues a warning if it does not equal cudaSuccess. More...
CuSparseMatrixDescriptionPtr	createMatrixDescription ()
	createMatrixDescription creates a default matrix description More...
CuSparseMatrixDescriptionPtr	createLowerDiagonalDescription ()
	createLowerDiagonalDescription creates a lower diagonal matrix description More...
CuSparseMatrixDescriptionPtr	createUpperDiagonalDescription ()
	createUpperDiagonalDescription creates an upper diagonal matrix description More...
template<class T , int blocksize>
void	invertDiagonalAndFlatten (T *mat, int *rowIndices, int *colIndices, size_t numberOfRows, T *vec)
	This function receives a matrix, and the inverse of the matrix containing only its diagonal is stored in d_vec. More...
template<class T , int blocksize>
void	computeLowerSolveLevelSet (T *reorderedMat, int *rowIndices, int *colIndices, int *indexConversion, int startIdx, int rowsInLevelSet, const T *dInv, const T *d, T *v)
	Perform a lower solve on certain rows in a matrix that can safely be computed in parallel. More...
template<class T , int blocksize>
void	computeUpperSolveLevelSet (T *reorderedMat, int *rowIndices, int *colIndices, int *indexConversion, int startIdx, int rowsInLevelSet, const T *dInv, T *v)
	Perform an upper solve on certain rows in a matrix that can safely be computed in parallel. More...
template<class T , int blocksize>
void	computeDiluDiagonal (T *reorderedMat, int *rowIndices, int *colIndices, int *reorderedToNatural, int *naturalToReordered, int startIdx, int rowsInLevelSet, T *dInv)
	Computes the ILU0 of the diagonal elements of the reordered matrix and stores it in a reordered vector containing the diagonal blocks. More...
template<class T , int blocksize>
void	copyMatDataToReordered (T *srcMatrix, int *srcRowIndices, T *dstMatrix, int *dstRowIndices, int *naturalToReordered, size_t numberOfRows)
	Reorders the elements of a matrix by copying them from one matrix to another using a permutation list. More...
std::string	getCusparseErrorCodeToString (int code)
	getCusparseErrorCodeToString Converts an error code returned from a cusparse function a human readable string. More...
std::string	getCusparseErrorMessage (cusparseStatus_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	getCusparseErrorMessage generates the error message to display for a given error. More...
void	cusparseSafeCall (cusparseStatus_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	cusparseSafeCall checks the return type of the CUSPARSE expression (function call) and throws an exception if it does not equal CUSPARSE_STATUS_SUCCESS. More...
cusparseStatus_t	cusparseWarnIfError (cusparseStatus_t error, const std::string_view &expression, const std::string_view &filename, const std::string_view &functionName, size_t lineNumber)
	cusparseWarnIfError checks the return type of the CUSPARSE expression (function call) and issues a warning if it does not equal CUSPARSE_STATUS_SUCCESS. More...
cusparseStatus_t	cusparseBsrilu02_analysis (cusparseHandle_t handle, cusparseDirection_t dirA, int mb, int nnzb, const cusparseMatDescr_t descrA, double *bsrSortedVal, const int *bsrSortedRowPtr, const int *bsrSortedColInd, int blockDim, bsrilu02Info_t info, cusparseSolvePolicy_t policy, void *pBuffer)
cusparseStatus_t	cusparseBsrsv2_analysis (cusparseHandle_t handle, cusparseDirection_t dirA, cusparseOperation_t transA, int mb, int nnzb, const cusparseMatDescr_t descrA, const double *bsrSortedValA, const int *bsrSortedRowPtrA, const int *bsrSortedColIndA, int blockDim, bsrsv2Info_t info, cusparseSolvePolicy_t policy, void *pBuffer)
cusparseStatus_t	cusparseBsrsv2_analysis (cusparseHandle_t handle, cusparseDirection_t dirA, cusparseOperation_t transA, int mb, int nnzb, const cusparseMatDescr_t descrA, const float *bsrSortedValA, const int *bsrSortedRowPtrA, const int *bsrSortedColIndA, int blockDim, bsrsv2Info_t info, cusparseSolvePolicy_t policy, void *pBuffer)
cusparseStatus_t	cusparseBsrilu02_analysis (cusparseHandle_t handle, cusparseDirection_t dirA, int mb, int nnzb, const cusparseMatDescr_t descrA, float *bsrSortedVal, const int *bsrSortedRowPtr, const int *bsrSortedColInd, int blockDim, bsrilu02Info_t info, cusparseSolvePolicy_t policy, void *pBuffer)
cusparseStatus_t	cusparseBsrsv2_solve (cusparseHandle_t handle, cusparseDirection_t dirA, cusparseOperation_t transA, int mb, int nnzb, const double *alpha, const cusparseMatDescr_t descrA, const double *bsrSortedValA, const int *bsrSortedRowPtrA, const int *bsrSortedColIndA, int blockDim, bsrsv2Info_t info, const double *f, double *x, cusparseSolvePolicy_t policy, void *pBuffer)
cusparseStatus_t	cusparseBsrsv2_solve (cusparseHandle_t handle, cusparseDirection_t dirA, cusparseOperation_t transA, int mb, int nnzb, const float *alpha, const cusparseMatDescr_t descrA, const float *bsrSortedValA, const int *bsrSortedRowPtrA, const int *bsrSortedColIndA, int blockDim, bsrsv2Info_t info, const float *f, float *x, cusparseSolvePolicy_t policy, void *pBuffer)
cusparseStatus_t	cusparseBsrilu02_bufferSize (cusparseHandle_t handle, cusparseDirection_t dirA, int mb, int nnzb, const cusparseMatDescr_t descrA, double *bsrSortedVal, const int *bsrSortedRowPtr, const int *bsrSortedColInd, int blockDim, bsrilu02Info_t info, int *pBufferSizeInBytes)
cusparseStatus_t	cusparseBsrilu02_bufferSize (cusparseHandle_t handle, cusparseDirection_t dirA, int mb, int nnzb, const cusparseMatDescr_t descrA, float *bsrSortedVal, const int *bsrSortedRowPtr, const int *bsrSortedColInd, int blockDim, bsrilu02Info_t info, int *pBufferSizeInBytes)
cusparseStatus_t	cusparseBsrsv2_bufferSize (cusparseHandle_t handle, cusparseDirection_t dirA, cusparseOperation_t transA, int mb, int nnzb, const cusparseMatDescr_t descrA, double *bsrSortedValA, const int *bsrSortedRowPtrA, const int *bsrSortedColIndA, int blockDim, bsrsv2Info_t info, int *pBufferSizeInBytes)
cusparseStatus_t	cusparseBsrsv2_bufferSize (cusparseHandle_t handle, cusparseDirection_t dirA, cusparseOperation_t transA, int mb, int nnzb, const cusparseMatDescr_t descrA, float *bsrSortedValA, const int *bsrSortedRowPtrA, const int *bsrSortedColIndA, int blockDim, bsrsv2Info_t info, int *pBufferSizeInBytes)
cusparseStatus_t	cusparseBsrilu02 (cusparseHandle_t handle, cusparseDirection_t dirA, int mb, int nnzb, const cusparseMatDescr_t descrA, double *bsrSortedVal, const int *bsrSortedRowPtr, const int *bsrSortedColInd, int blockDim, bsrilu02Info_t info, cusparseSolvePolicy_t policy, void *pBuffer)
cusparseStatus_t	cusparseBsrilu02 (cusparseHandle_t handle, cusparseDirection_t dirA, int mb, int nnzb, const cusparseMatDescr_t descrA, float *bsrSortedVal, const int *bsrSortedRowPtr, const int *bsrSortedColInd, int blockDim, bsrilu02Info_t info, cusparseSolvePolicy_t policy, void *pBuffer)
cusparseStatus_t	cusparseBsrmv (cusparseHandle_t handle, cusparseDirection_t dirA, cusparseOperation_t transA, int mb, int nb, int nnzb, const double *alpha, const cusparseMatDescr_t descrA, const double *bsrSortedValA, const int *bsrSortedRowPtrA, const int *bsrSortedColIndA, int blockDim, const double *x, const double *beta, double *y)
cusparseStatus_t	cusparseBsrmv (cusparseHandle_t handle, cusparseDirection_t dirA, cusparseOperation_t transA, int mb, int nb, int nnzb, const float *alpha, const cusparseMatDescr_t descrA, const float *bsrSortedValA, const int *bsrSortedRowPtrA, const int *bsrSortedColIndA, int blockDim, const float *x, const float *beta, float *y)
template<class Matrix >
const Matrix	makeMatrixWithNonzeroDiagonal (const Matrix &matrix, const typename Matrix::field_type replacementValue=std::numeric_limits< typename Matrix::field_type >::epsilon())
	makeMatrixWithNonzeroDiagonal creates a new matrix with the zero diagonal elements (when viewed as a matrix of scalrars) set to replacementValue More...
template<class PreconditionerType >
constexpr bool	shouldCallPreconditionerPre ()
	Tests (compile time) if the preconditioner type needs to call pre() before a call to apply() More...
template<class PreconditionerType >
constexpr bool	shouldCallPreconditionerPost ()
	Tests (compile time) if the preconditioner type needs to call post() after a call to apply(...) More...
int	to_int (std::size_t s)
	to_int converts a (on most relevant platforms) 64 bits unsigned size_t to a signed 32 bits signed int More...
std::size_t	to_size_t (int i)
	to_size_t converts a (on most relevant platforms) a 32 bit signed int to a 64 bits unsigned int More...
template<class T >
void	setVectorValue (T *deviceData, size_t numberOfElements, const T &value)
	setVectorValue sets every element of deviceData to value More...
template<class T >
void	setZeroAtIndexSet (T *deviceData, size_t numberOfElements, const int *indices)
	setZeroAtIndexSet sets deviceData to zero in the indices of contained in indices More...
template<class T >
T	innerProductAtIndices (const T *deviceA, const T *deviceB, T *buffer, size_t numberOfElements, const int *indices)
	innerProductAtIndices computes the inner product between deviceA[indices] and deviceB[indices] More...
template<class T >
void	weightedDiagMV (const T *squareBlockVector, const size_t numberOfRows, const size_t blocksize, T relaxationFactor, const T *srcVec, T *dstVec)
	Compue the weighted matrix vector product where the matrix is diagonal, the diagonal is a vector, meaning we compute the Hadamard product. More...

Variables
const constexpr auto	CUSPARSE_MATRIX_ORDER = CUSPARSE_DIRECTION_ROW

Detailed Description

Contains wrappers to make the CuBLAS library behave as a modern C++ library with function overlading.

In simple terms, this allows one to call say cublasScal on both double and single precisision, instead of calling cublasDscal and cublasSscal respectively.

Contains wrappers to make the CuSPARSE library behave as a modern C++ library with function overlading.

In simple terms, this allows one to call say cusparseBsrilu02_analysis on both double and single precisision, instead of calling cusparseDbsrilu02_analysis and cusparseDbsrilu02_analysis respectively.

Simple utility structs to test for the existence of functions in types.

Note that there are alternatives to this, see for instance https://stackoverflow.com/questions/257288/templated-check-for-the-existence-of-a-class-member-function , however, this is by far the cleanest approach for where this is going to be used for now.

TODO: Use the requires-keyword once C++20 becomes availble (https://en.cppreference.com/w/cpp/language/constraints ). With C++20 this file can be removed.

Provides various utilities for doing signed to unsigned conversion, unsigned to signed, 32 bits to 64 bits and 64 bits to 32 bits.

The main use case within cuistl is that the cusparse library requires signed int for all its size parameters, while Dune::BlockVector (and relatives) use unsigned size_t.

Typedef Documentation

CuSparseMatrixDescription

using Opm::cuistl::detail::CuSparseMatrixDescription = typedef CuSparseResource<cusparseMatDescr_t>

CuSparseMatrixDescription holder. This is internal information needed for most calls to the CuSparse API.

CuSparseMatrixDescriptionPtr

using Opm::cuistl::detail::CuSparseMatrixDescriptionPtr = typedef std::shared_ptr<CuSparseResource<cusparseMatDescr_t> >

Pointer to CuSparseMatrixDescription holder. This is internal information needed for most calls to the CuSparse API.

Function Documentation

computeDiluDiagonal()

template<class T , int blocksize>

void Opm::cuistl::detail::computeDiluDiagonal	(	T *	reorderedMat,
		int *	rowIndices,
		int *	colIndices,
		int *	reorderedToNatural,
		int *	naturalToReordered,
		int	startIdx,
		int	rowsInLevelSet,
		T *	dInv
	)

Computes the ILU0 of the diagonal elements of the reordered matrix and stores it in a reordered vector containing the diagonal blocks.

Parameters

	reorderedMat	pointer to GPU memory containing nonzerovalues of the sparse matrix. The matrix reordered such that rows in the same level sets are contiguous
	rowIndices	Pointer to vector on GPU containing row indices compliant wiht bsr format
	colIndices	Pointer to vector on GPU containing col indices compliant wiht bsr format
	reorderedToNatural	Integer array containing mapping an index in the reordered matrix to its corresponding index in the natural ordered matrix
	naturalToreordered	Integer array containing mapping an index in the reordered matrix to its corresponding index in the natural ordered matrix
	startIdx	Index of the first row of the matrix to be solve
	rowsInLevelSet	Number of rows in this level set, which number the amount of rows solved in parallel by this function
[out]	dInv	The diagonal matrix used by the Diagonal ILU preconditioner

computeLowerSolveLevelSet()

template<class T , int blocksize>

void Opm::cuistl::detail::computeLowerSolveLevelSet	(	T *	reorderedMat,
		int *	rowIndices,
		int *	colIndices,
		int *	indexConversion,
		int	startIdx,
		int	rowsInLevelSet,
		const T *	dInv,
		const T *	d,
		T *	v
	)

Perform a lower solve on certain rows in a matrix that can safely be computed in parallel.

Parameters

	reorderedMat	pointer to GPU memory containing nonzerovalues of the sparse matrix. The matrix reordered such that rows in the same level sets are contiguous
	rowIndices	Pointer to vector on GPU containing row indices compliant wiht bsr format
	colIndices	Pointer to vector on GPU containing col indices compliant wiht bsr format
	indexConversion	Integer array containing mapping an index in the reordered matrix to its corresponding index in the natural ordered matrix
	startIdx	Index of the first row of the matrix to be solve
	rowsInLevelSet	Number of rows in this level set, which number the amount of rows solved in parallel by this function
	dInv	The diagonal matrix used by the Diagonal ILU preconditioner. Must be reordered in the same way as reorderedMat
	d	Stores the defect
[out]	v	Will store the results of the lower solve

computeUpperSolveLevelSet()

template<class T , int blocksize>

void Opm::cuistl::detail::computeUpperSolveLevelSet	(	T *	reorderedMat,
		int *	rowIndices,
		int *	colIndices,
		int *	indexConversion,
		int	startIdx,
		int	rowsInLevelSet,
		const T *	dInv,
		T *	v
	)

Perform an upper solve on certain rows in a matrix that can safely be computed in parallel.

Parameters

	reorderedMat	pointer to GPU memory containing nonzerovalues of the sparse matrix. The matrix reordered such that rows in the same level sets are contiguous
	rowIndices	Pointer to vector on GPU containing row indices compliant wiht bsr format
	colIndices	Pointer to vector on GPU containing col indices compliant wiht bsr format
	indexConversion	Integer array containing mapping an index in the reordered matrix to its corresponding index in the natural ordered matrix
	startIdx	Index of the first row of the matrix to be solve
	rowsInLevelSet	Number of rows in this level set, which number the amount of rows solved in parallel by this function
	dInv	The diagonal matrix used by the Diagonal ILU preconditioner
[out]	v	Will store the results of the lower solve. To begin with it should store the output from the lower solve

copyMatDataToReordered()

template<class T , int blocksize>

void Opm::cuistl::detail::copyMatDataToReordered	(	T *	srcMatrix,
		int *	srcRowIndices,
		T *	dstMatrix,
		int *	dstRowIndices,
		int *	naturalToReordered,
		size_t	numberOfRows
	)

Reorders the elements of a matrix by copying them from one matrix to another using a permutation list.

Parameters

	srcMatrix	The source matrix we will copy data from
	srcRowIndices	Pointer to vector on GPU containing row indices for the source matrix compliant wiht bsr format
[out]	dstMatrix	The destination matrix that we copy data to
	dstRowIndices	Pointer to vector on GPU containing riw indices for the destination matrix compliant wiht bsr format
	naturalToReordered	Permuation list that converts indices in the src matrix to the indices in the dst matrix
	numberOfRows	The number of rows in the matrices

createLowerDiagonalDescription()

CuSparseMatrixDescriptionPtr Opm::cuistl::detail::createLowerDiagonalDescription ( )

inline

createLowerDiagonalDescription creates a lower diagonal matrix description

Returns

a lower diagonal matrix description overlapped with options from Opm::cuistl::detail::createMatrixDescription()

Note

This will assume it has a unit diagonal

References createMatrixDescription(), and OPM_CUSPARSE_SAFE_CALL.

createMatrixDescription()

CuSparseMatrixDescriptionPtr Opm::cuistl::detail::createMatrixDescription ( )

inline

createMatrixDescription creates a default matrix description

Returns

a matrix description to a general sparse matrix with zero based indexing.

References OPM_CUSPARSE_SAFE_CALL.

Referenced by createLowerDiagonalDescription(), and createUpperDiagonalDescription().

createUpperDiagonalDescription()

CuSparseMatrixDescriptionPtr Opm::cuistl::detail::createUpperDiagonalDescription ( )

inline

createUpperDiagonalDescription creates an upper diagonal matrix description

Returns

an upper diagonal matrix description overlapped with options from Opm::cuistl::detail::createMatrixDescription()

Note

This will assume it has a non-unit diagonal.

References createMatrixDescription(), and OPM_CUSPARSE_SAFE_CALL.

cublasAxpy() [1/3]

cublasStatus_t Opm::cuistl::detail::cublasAxpy ( cublasHandle_t  handle, int  n, const double *  alpha, const double *  x, int  incx, double *  y, int  incy  )

inline

cublasAxpy() [2/3]

cublasStatus_t Opm::cuistl::detail::cublasAxpy ( cublasHandle_t  handle, int  n, const float *  alpha, const float *  x, int  incx, float *  y, int  incy  )

inline

cublasAxpy() [3/3]

cublasStatus_t Opm::cuistl::detail::cublasAxpy ( cublasHandle_t  handle, int  n, const int *  alpha, const int *  x, int  incx, int *  y, int  incy  )

inline

cublasDot() [1/3]

cublasStatus_t Opm::cuistl::detail::cublasDot ( cublasHandle_t  handle, int  n, const double *  x, int  incx, const double *  y, int  incy, double *  result  )

inline

cublasDot() [2/3]

cublasStatus_t Opm::cuistl::detail::cublasDot ( cublasHandle_t  handle, int  n, const float *  x, int  incx, const float *  y, int  incy, float *  result  )

inline

cublasDot() [3/3]

cublasStatus_t Opm::cuistl::detail::cublasDot ( cublasHandle_t  handle, int  n, const int *  x, int  incx, const int *  y, int  incy, int *  result  )

inline

cublasNrm2() [1/3]

cublasStatus_t Opm::cuistl::detail::cublasNrm2 ( cublasHandle_t  handle, int  n, const double *  x, int  incx, double *  result  )

inline

cublasNrm2() [2/3]

cublasStatus_t Opm::cuistl::detail::cublasNrm2 ( cublasHandle_t  handle, int  n, const float *  x, int  incx, float *  result  )

inline

cublasNrm2() [3/3]

cublasStatus_t Opm::cuistl::detail::cublasNrm2 ( cublasHandle_t  handle, int  n, const int *  x, int  incx, int *  result  )

inline

cublasSafeCall()

void Opm::cuistl::detail::cublasSafeCall ( cublasStatus_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

cublasSafeCall checks the return type of the CUBLAS expression (function call) and throws an exception if it does not equal CUBLAS_STATUS_SUCCESS.

Parameters

error	the error code from cublas
expression	the expresison (say "cublasCreate(&handle)")
filename	the code file the error occured in (typically FILE)
functionName	name of the function the error occured in (typically func)
lineNumber	the line number the error occured in (typically LINE)

Example usage:

#include <opm/simulators/linalg/cuistl/detail/cublas_safe_call.hpp>
#include <cublas_v2.h>
 
void some_function() {
    cublasHandle_t cublasHandle;
    cudaSafeCall(cublasCreate(&cublasHandle), "cublasCreate(&cublasHandle)", __FILE__, __func__, __LINE__);
}

Note

It is probably easier to use the macro OPM_CUBLAS_SAFE_CALL

References getCublasErrorMessage().

cublasScal() [1/3]

cublasStatus_t Opm::cuistl::detail::cublasScal ( cublasHandle_t  handle, int  n, const double *  alpha, double *  x, int  incx  )

inline

cublasScal() [2/3]

cublasStatus_t Opm::cuistl::detail::cublasScal ( cublasHandle_t  handle, int  n, const float *  alpha, float *  x, int  incx  )

inline

cublasScal() [3/3]

cublasStatus_t Opm::cuistl::detail::cublasScal ( cublasHandle_t  handle, int  n, const int *  alpha, int *  x, int  incx  )

inline

cublasWarnIfError()

cublasStatus_t Opm::cuistl::detail::cublasWarnIfError ( cublasStatus_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

cublasWarnIfError checks the return type of the CUBLAS expression (function call) and issues a warning if it does not equal CUBLAS_STATUS_SUCCESS.

Parameters

error	the error code from cublas
expression	the expresison (say "cublasCreate(&handle)")
filename	the code file the error occured in (typically FILE)
functionName	name of the function the error occured in (typically func)
lineNumber	the line number the error occured in (typically LINE)

Returns

the error sent in (for convenience).

Example usage:

#include <opm/simulators/linalg/cuistl/detail/cublas_safe_call.hpp>
#include <cublas_v2.h>
 
void some_function() {
    cublasHandle_t cublasHandle;
    cublasWarnIfError(cublasCreate(&cublasHandle), "cublasCreate(&cublasHandle)", __FILE__, __func__, __LINE__);
}

Note

It is probably easier to use the macro OPM_CUBLAS_WARN_IF_ERROR

Prefer the cublasSafeCall/OPM_CUBLAS_SAFE_CALL counterpart unless you really don't want to throw an exception.

References getCublasErrorMessage().

cudaSafeCall()

void Opm::cuistl::detail::cudaSafeCall ( cudaError_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

cudaSafeCall checks the return type of the CUDA expression (function call) and throws an exception if it does not equal cudaSuccess.

Example usage:

#include <opm/simulators/linalg/cuistl/detail/cuda_safe_call.hpp>
#include <cuda_runtime.h>
 
void some_function() {
    void* somePointer;
    cudaSafeCall(cudaMalloc(&somePointer, 1), "cudaMalloc(&somePointer, 1)", __FILE__, __func__, __LINE__);
}

Note

It is probably easier to use the macro OPM_CUDA_SAFE_CALL

References getCudaErrorMessage().

cudaWarnIfError()

cudaError_t Opm::cuistl::detail::cudaWarnIfError ( cudaError_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

cudaWarnIfError checks the return type of the CUDA expression (function call) and issues a warning if it does not equal cudaSuccess.

Parameters

error	the error code from cublas
expression	the expresison (say "cudaMalloc(&pointer, 1)")
filename	the code file the error occured in (typically FILE)
functionName	name of the function the error occured in (typically func)
lineNumber	the line number the error occured in (typically LINE)

Returns

the error sent in (for convenience).

Example usage:

#include <opm/simulators/linalg/cuistl/detail/cuda_safe_call.hpp>
#include <cuda_runtime.h>
 
void some_function() {
    void* somePointer;
    cudaWarnIfError(cudaMalloc(&somePointer, 1), "cudaMalloc(&somePointer, 1)", __FILE__, __func__, __LINE__);
}

Note

It is probably easier to use the macro OPM_CUDA_WARN_IF_ERROR

Prefer the cudaSafeCall/OPM_CUDA_SAFE_CALL counterpart unless you really don't want to throw an exception.

References getCudaErrorMessage().

cusparseBsrilu02() [1/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrilu02 ( cusparseHandle_t  handle, cusparseDirection_t  dirA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, double *  bsrSortedVal, const int *  bsrSortedRowPtr, const int *  bsrSortedColInd, int  blockDim, bsrilu02Info_t  info, cusparseSolvePolicy_t  policy, void *  pBuffer  )

inline

cusparseBsrilu02() [2/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrilu02 ( cusparseHandle_t  handle, cusparseDirection_t  dirA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, float *  bsrSortedVal, const int *  bsrSortedRowPtr, const int *  bsrSortedColInd, int  blockDim, bsrilu02Info_t  info, cusparseSolvePolicy_t  policy, void *  pBuffer  )

inline

cusparseBsrilu02_analysis() [1/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrilu02_analysis ( cusparseHandle_t  handle, cusparseDirection_t  dirA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, double *  bsrSortedVal, const int *  bsrSortedRowPtr, const int *  bsrSortedColInd, int  blockDim, bsrilu02Info_t  info, cusparseSolvePolicy_t  policy, void *  pBuffer  )

inline

cusparseBsrilu02_analysis() [2/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrilu02_analysis ( cusparseHandle_t  handle, cusparseDirection_t  dirA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, float *  bsrSortedVal, const int *  bsrSortedRowPtr, const int *  bsrSortedColInd, int  blockDim, bsrilu02Info_t  info, cusparseSolvePolicy_t  policy, void *  pBuffer  )

inline

cusparseBsrilu02_bufferSize() [1/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrilu02_bufferSize ( cusparseHandle_t  handle, cusparseDirection_t  dirA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, double *  bsrSortedVal, const int *  bsrSortedRowPtr, const int *  bsrSortedColInd, int  blockDim, bsrilu02Info_t  info, int *  pBufferSizeInBytes  )

inline

cusparseBsrilu02_bufferSize() [2/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrilu02_bufferSize ( cusparseHandle_t  handle, cusparseDirection_t  dirA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, float *  bsrSortedVal, const int *  bsrSortedRowPtr, const int *  bsrSortedColInd, int  blockDim, bsrilu02Info_t  info, int *  pBufferSizeInBytes  )

inline

cusparseBsrmv() [1/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrmv ( cusparseHandle_t  handle, cusparseDirection_t  dirA, cusparseOperation_t  transA, int  mb, int  nb, int  nnzb, const double *  alpha, const cusparseMatDescr_t  descrA, const double *  bsrSortedValA, const int *  bsrSortedRowPtrA, const int *  bsrSortedColIndA, int  blockDim, const double *  x, const double *  beta, double *  y  )

inline

cusparseBsrmv() [2/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrmv ( cusparseHandle_t  handle, cusparseDirection_t  dirA, cusparseOperation_t  transA, int  mb, int  nb, int  nnzb, const float *  alpha, const cusparseMatDescr_t  descrA, const float *  bsrSortedValA, const int *  bsrSortedRowPtrA, const int *  bsrSortedColIndA, int  blockDim, const float *  x, const float *  beta, float *  y  )

inline

cusparseBsrsv2_analysis() [1/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrsv2_analysis ( cusparseHandle_t  handle, cusparseDirection_t  dirA, cusparseOperation_t  transA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, const double *  bsrSortedValA, const int *  bsrSortedRowPtrA, const int *  bsrSortedColIndA, int  blockDim, bsrsv2Info_t  info, cusparseSolvePolicy_t  policy, void *  pBuffer  )

inline

cusparseBsrsv2_analysis() [2/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrsv2_analysis ( cusparseHandle_t  handle, cusparseDirection_t  dirA, cusparseOperation_t  transA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, const float *  bsrSortedValA, const int *  bsrSortedRowPtrA, const int *  bsrSortedColIndA, int  blockDim, bsrsv2Info_t  info, cusparseSolvePolicy_t  policy, void *  pBuffer  )

inline

cusparseBsrsv2_bufferSize() [1/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrsv2_bufferSize ( cusparseHandle_t  handle, cusparseDirection_t  dirA, cusparseOperation_t  transA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, double *  bsrSortedValA, const int *  bsrSortedRowPtrA, const int *  bsrSortedColIndA, int  blockDim, bsrsv2Info_t  info, int *  pBufferSizeInBytes  )

inline

cusparseBsrsv2_bufferSize() [2/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrsv2_bufferSize ( cusparseHandle_t  handle, cusparseDirection_t  dirA, cusparseOperation_t  transA, int  mb, int  nnzb, const cusparseMatDescr_t  descrA, float *  bsrSortedValA, const int *  bsrSortedRowPtrA, const int *  bsrSortedColIndA, int  blockDim, bsrsv2Info_t  info, int *  pBufferSizeInBytes  )

inline

cusparseBsrsv2_solve() [1/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrsv2_solve ( cusparseHandle_t  handle, cusparseDirection_t  dirA, cusparseOperation_t  transA, int  mb, int  nnzb, const double *  alpha, const cusparseMatDescr_t  descrA, const double *  bsrSortedValA, const int *  bsrSortedRowPtrA, const int *  bsrSortedColIndA, int  blockDim, bsrsv2Info_t  info, const double *  f, double *  x, cusparseSolvePolicy_t  policy, void *  pBuffer  )

inline

cusparseBsrsv2_solve() [2/2]

cusparseStatus_t Opm::cuistl::detail::cusparseBsrsv2_solve ( cusparseHandle_t  handle, cusparseDirection_t  dirA, cusparseOperation_t  transA, int  mb, int  nnzb, const float *  alpha, const cusparseMatDescr_t  descrA, const float *  bsrSortedValA, const int *  bsrSortedRowPtrA, const int *  bsrSortedColIndA, int  blockDim, bsrsv2Info_t  info, const float *  f, float *  x, cusparseSolvePolicy_t  policy, void *  pBuffer  )

inline

cusparseSafeCall()

void Opm::cuistl::detail::cusparseSafeCall ( cusparseStatus_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

cusparseSafeCall checks the return type of the CUSPARSE expression (function call) and throws an exception if it does not equal CUSPARSE_STATUS_SUCCESS.

Example usage:

#include <opm/simulators/linalg/cuistl/detail/cusparse_safe_call.hpp>
#include <cublas_v2.h>
 
void some_function() {
    cusparseHandle_t cusparseHandle;
    cusparseSafeCall(cusparseCreate(&cusparseHandle), "cusparseCreate(&cusparseHandle)", __FILE__, __func__,
__LINE__);
}

Note

It is probably easier to use the macro OPM_CUBLAS_SAFE_CALL

References getCusparseErrorMessage().

cusparseWarnIfError()

cusparseStatus_t Opm::cuistl::detail::cusparseWarnIfError ( cusparseStatus_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

cusparseWarnIfError checks the return type of the CUSPARSE expression (function call) and issues a warning if it does not equal CUSPARSE_STATUS_SUCCESS.

Parameters

error	the error code from cublas
expression	the expresison (say "cublasCreate(&handle)")
filename	the code file the error occured in (typically FILE)
functionName	name of the function the error occured in (typically func)
lineNumber	the line number the error occured in (typically LINE)

Returns

the error sent in (for convenience).

Example usage:

#include <opm/simulators/linalg/cuistl/detail/cusparse_safe_call.hpp>
#include <cublas_v2.h>
 
void some_function() {
    cusparseHandle_t cusparseHandle;
    cusparseWarnIfError(cusparseCreate(&cusparseHandle), "cusparseCreate(&cusparseHandle)", __FILE__, __func__,
__LINE__);
}

Note

It is probably easier to use the macro OPM_CUSPARSE_WARN_IF_ERROR

Prefer the cusparseSafeCall/OPM_CUSPARSE_SAFE_CALL counterpart unless you really don't want to throw an exception.

References getCusparseErrorMessage().

getCublasErrorMessage()

std::string Opm::cuistl::detail::getCublasErrorMessage ( cublasStatus_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

getCublasErrorMessage generates the error message to display for a given error.

Parameters

error	the error code from cublas
expression	the expresison (say "cublasCreate(&handle)")
filename	the code file the error occured in (typically FILE)
functionName	name of the function the error occured in (typically func)
lineNumber	the line number the error occured in (typically LINE)

Returns

An error message to be displayed.

Note

This function is mostly for internal use.

Referenced by cublasSafeCall(), and cublasWarnIfError().

getCudaErrorMessage()

std::string Opm::cuistl::detail::getCudaErrorMessage ( cudaError_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

getCudaErrorMessage generates the error message to display for a given error.

Parameters

error	the error code from cublas
expression	the expresison (say "cudaMalloc(&pointer, 1)")
filename	the code file the error occured in (typically FILE)
functionName	name of the function the error occured in (typically func)
lineNumber	the line number the error occured in (typically LINE)

Returns

An error message to be displayed.

Note

This function is mostly for internal use.

Referenced by cudaSafeCall(), and cudaWarnIfError().

getCusparseErrorCodeToString()

std::string Opm::cuistl::detail::getCusparseErrorCodeToString ( int  code )

inline

getCusparseErrorCodeToString Converts an error code returned from a cusparse function a human readable string.

Parameters

code	an error code from a cusparse routine

Returns

a human readable string.

References CHECK_CUSPARSE_ERROR_TYPE.

Referenced by getCusparseErrorMessage().

getCusparseErrorMessage()

std::string Opm::cuistl::detail::getCusparseErrorMessage ( cusparseStatus_t  error, const std::string_view &  expression, const std::string_view &  filename, const std::string_view &  functionName, size_t  lineNumber  )

inline

getCusparseErrorMessage generates the error message to display for a given error.

Parameters

error	the error code from cublas
expression	the expresison (say "cusparseCreate(&handle)")
filename	the code file the error occured in (typically FILE)
functionName	name of the function the error occured in (typically func)
lineNumber	the line number the error occured in (typically LINE)

Returns

An error message to be displayed.

Note

This function is mostly for internal use.

References getCusparseErrorCodeToString().

Referenced by cusparseSafeCall(), and cusparseWarnIfError().

innerProductAtIndices()

template<class T >

T Opm::cuistl::detail::innerProductAtIndices	(	const T *	deviceA,
		const T *	deviceB,
		T *	buffer,
		size_t	numberOfElements,
		const int *	indices
	)

innerProductAtIndices computes the inner product between deviceA[indices] and deviceB[indices]

Parameters

deviceA	data A (device memory)
deviceB	data B (device memory)
buffer	a buffer with number of elements equal to numberOfElements (device memory)
numberOfElements	number of indices
indices	the indices to compute the inner product over (device memory)

Returns

the result of the inner product

Note

This is equivalent to projecting the vectors to the indices contained in indices, then doing the inner product of those projected vectors.

invertDiagonalAndFlatten()

template<class T , int blocksize>

void Opm::cuistl::detail::invertDiagonalAndFlatten	(	T *	mat,
		int *	rowIndices,
		int *	colIndices,
		size_t	numberOfRows,
		T *	vec
	)

This function receives a matrix, and the inverse of the matrix containing only its diagonal is stored in d_vec.

Parameters

	mat	pointer to GPU memory containing nonzerovalues of the sparse matrix
	rowIndices	Pointer to vector on GPU containing row indices compliant wiht bsr format
	colIndices	Pointer to vector on GPU containing col indices compliant wiht bsr format
	numberOfRows	Integer describing the number of rows in the matrix
[out]	vec	Pointer to the vector where the inverse of the diagonal matrix should be stored

makeMatrixWithNonzeroDiagonal()

template<class Matrix >

const Matrix Opm::cuistl::detail::makeMatrixWithNonzeroDiagonal	(	const Matrix &	matrix,
		const typename Matrix::field_type	replacementValue = std::numeric_limits<typename Matrix::field_type>::epsilon()
	)

makeMatrixWithNonzeroDiagonal creates a new matrix with the zero diagonal elements (when viewed as a matrix of scalrars) set to replacementValue

Parameters

matrix	the matrix to replace
replacementValue	the value to set in the diagonal elements that are zero

Returns

a new matrix with non non-zero diagonal elements.

Note

This modification is needed for the CuSparse implementation of ILU0. While the the algorithm operates on block matrices, it still requires that the scalar matrix has no zero diagonal elements.

setVectorValue()

template<class T >

void Opm::cuistl::detail::setVectorValue	(	T *	deviceData,
		size_t	numberOfElements,
		const T &	value
	)

setVectorValue sets every element of deviceData to value

Parameters

deviceData	pointer to GPU memory
numberOfElements	number of elements to set to value
value	the value to use

setZeroAtIndexSet()

template<class T >

void Opm::cuistl::detail::setZeroAtIndexSet	(	T *	deviceData,
		size_t	numberOfElements,
		const int *	indices
	)

setZeroAtIndexSet sets deviceData to zero in the indices of contained in indices

Parameters

deviceData	the data to operate on (device memory)
numberOfElements	number of indices
indices	the indices to use (device memory)

shouldCallPreconditionerPost()

template<class PreconditionerType >

constexpr bool Opm::cuistl::detail::shouldCallPreconditionerPost ( )

constexpr

Tests (compile time) if the preconditioner type needs to call post() after a call to apply(...)

Note

This is mostly used to avoid unneeded copying back and front to the GPU, as well as avoiding communication.

shouldCallPreconditionerPre()

template<class PreconditionerType >

constexpr bool Opm::cuistl::detail::shouldCallPreconditionerPre ( )

constexpr

Tests (compile time) if the preconditioner type needs to call pre() before a call to apply()

Note

This is mostly used to avoid unneeded copying back and front to the GPU, as well as avoiding communication.

to_int()

int Opm::cuistl::detail::to_int ( std::size_t  s )

inline

to_int converts a (on most relevant platforms) 64 bits unsigned size_t to a signed 32 bits signed int

Parameters

s	the unsigned integer

Exceptions

std::invalid_argument

exception if s is out of range for an int

Returns

converted s to int if s is within the range of int

to_size_t()

std::size_t Opm::cuistl::detail::to_size_t ( int  i )

inline

to_size_t converts a (on most relevant platforms) a 32 bit signed int to a 64 bits unsigned int

Parameters

i	the signed integer

Returns

converted i to size_t if it is a non-negative integer.

Exceptions

std::invalid_argument

if i is negative.

Referenced by Opm::cuistl::CuSparseMatrix< T >::blockSize(), Opm::cuistl::CuSparseMatrix< T >::dim(), Opm::cuistl::CuSparseMatrix< T >::N(), and Opm::cuistl::CuSparseMatrix< T >::nonzeroes().

weightedDiagMV()

template<class T >

void Opm::cuistl::detail::weightedDiagMV	(	const T *	squareBlockVector,
		const size_t	numberOfRows,
		const size_t	blocksize,
		T	relaxationFactor,
		const T *	srcVec,
		T *	dstVec
	)

Compue the weighted matrix vector product where the matrix is diagonal, the diagonal is a vector, meaning we compute the Hadamard product.

Parameters

	squareBlockVector	A CuVector whose elements are NxN matrix blocks
	numberOfRows	The number of rows in the vector
	blocksize	The sidelength of the square block elements in the vector
	src_vec	A pointer to the data of the CuVector we multiply the blockvector with
[out]	dst_vec	A pointer to the data of the CuVector we store the result in

Note

This is implemented as a faster way to multiply a diagonal matrix with a blockvector. We need only store the diagonal of the matrix and use this product.

Variable Documentation

CUSPARSE_MATRIX_ORDER

const constexpr auto Opm::cuistl::detail::CUSPARSE_MATRIX_ORDER = CUSPARSE_DIRECTION_ROW

constexpr