OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation for vector_operations.hpp.

Browse Source
This commit is contained in:
Kjetil Olsen Lye 2023-05-16 09:56:21 +02:00
parent bc3cb8c1db
commit b4aa427bbe
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
opm/simulators/linalg/cuistl/detail/vector_operations.hpp
View File

@ -33,24 +33,24 @@ void setVectorValue(T* deviceData, size_t numberOfElements, const T& value);
/**
* @brief setZeroAtIndexSet sets deviceData to zero in the indices of contained in indices
* @param deviceData the data to operate on
* @param deviceData the data to operate on (device memory)
* @param numberOfElements number of indices
* @param indices the indices to use
* @param indices the indices to use (device memory)
*/
template <class T>
void setZeroAtIndexSet(T* deviceData, size_t numberOfElements, const int* indices);
/**
* @brief innerProductAtIndices computes the inner product between deviceA[indices] and deviceB[indices]
* @param deviceA data A
* @param deviceB data B
* @param buffer a buffer with number of elements equal to numberOfElements
* @param deviceA data A (device memory)
* @param deviceB data B (device memory)
* @param buffer a buffer with number of elements equal to numberOfElements (device memory)
* @param numberOfElements number of indices
* @param indices the indices to compute the inner product over
* @param indices the indices to compute the inner product over (device memory)
* @return 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 indices.
* of those projected vectors.
*/
template <class T>
T innerProductAtIndices(const T* deviceA, const T* deviceB, T* buffer, size_t numberOfElements, const int* indices);