diff --git a/opm/core/linalg/sparse_sys.h b/opm/core/linalg/sparse_sys.h index b69ce6b9f..5b83d8b04 100644 --- a/opm/core/linalg/sparse_sys.h +++ b/opm/core/linalg/sparse_sys.h @@ -48,8 +48,8 @@ struct CSRMatrix /** - * Allocate a matrix structure and corresponding row pointers, - * @c ia, sufficiently initialised to support "count and push-back" + * Allocate a matrix structure and corresponding row pointers, @c ia, + * sufficiently initialised to support "count and push-back" * construction scheme. * * The matrix will be fully formed in csrmatrix_new_elms_pushback(). @@ -57,10 +57,10 @@ struct CSRMatrix * \param[in] m Number of matrix rows. * * \return Allocated matrix structure with allocated row pointers and - * valid @c m field. The row pointer elements are initialised all zero - * to simplify the non-zero element counting procedure. The @c ja and - * @c sa fields are NULL. This function returns NULL in case of - * allocation failure. + * valid @c m field. The row pointer elements are initialised all + * zero to simplify the non-zero element counting procedure. The @c + * ja and @c sa fields are NULL. This function returns NULL in case + * of allocation failure. */ struct CSRMatrix * csrmatrix_new_count_nnz(size_t m); @@ -71,13 +71,13 @@ csrmatrix_new_count_nnz(size_t m); * sparse matrix with a specified number of (structural) non-zero * elements. * - * The contents of the individual matrix arrays is undefined. In particular, - * the sparsity pattern must be constructed through some other, external, - * means prior to using the matrix in (e.g.,) a global system assembly - * process. + * The contents of the individual matrix arrays is undefined. In + * particular, the sparsity pattern must be constructed through some + * other, external, means prior to using the matrix in (e.g.,) a + * global system assembly process. * - * The memory resources should be released through the csrmatrix_delete() - * function. + * The memory resources should be released through the + * csrmatrix_delete() function. * * \param[in] m Number of matrix rows. * \param[in] nnz Number of structural non-zeros. @@ -90,27 +90,31 @@ csrmatrix_new_known_nnz(size_t m, size_t nnz); /** - * Set row pointers and allocate column index and matrix element arrays of - * a matrix previous obtained from csrmatrix_new_count_nnz(). + * Set row pointers and allocate column index and matrix element + * arrays of a matrix previous obtained from + * csrmatrix_new_count_nnz(). * - * The memory resources should be released through the csrmatrix_delete() - * function. + * The memory resources should be released through the + * csrmatrix_delete() function. * - * This function assumes that, on input, the total number of structurally - * non-zero elements of row @c i are stored in @c A->ia[i+1] for all - * i = 0, ..., A->m - 1 and that A->ia[0] == 0. - * If successful, then on output the row pointers are valid. If not, then - * the @c A->ja and @c A->sa arrays remain unallocated. + * This function assumes that, on input, the total number of + * structurally non-zero elements of row @c i are stored in @c + * A->ia[i+1] for all i = 0, ..., A->m - 1 and that + * A->ia[0] == 0. If successful, then on output the row + * pointers are valid. If not, then the @c A->ja and @c A->sa arrays + * remain unallocated. * - * Following a successful call to csmatrix_new_elms_pushback(), the entire - * matrix structure (sparsity pattern) is structurally consistent, but the - * contents of the @c ja and @c sa arrays is undefined and must be set prior - * to using the matrix in, e.g., a pressure system solve. + * Following a successful call to csmatrix_new_elms_pushback(), the + * entire matrix structure (sparsity pattern) is structurally + * consistent, but the contents of the @c ja and @c sa arrays is + * undefined and must be set prior to using the matrix in, e.g., a + * pressure system solve. * * \param[in,out] A Matrix. * * \return Total number of allocated non-zeros, A->nnz == - * A->ia[A->m] if successful and zero in case of allocation failure. + * A->ia[A->m] if successful and zero in case of allocation + * failure. */ size_t csrmatrix_new_elms_pushback(struct CSRMatrix *A); @@ -135,8 +139,9 @@ csrmatrix_elm_index(int i, int j, const struct CSRMatrix *A); * Sort column indices within each matrix row in ascending order. * * The corresponding matrix elements (i.e., @c sa) are not referenced. - * Consequently, following a call to csrmatrix_sortrows(), all relations - * to any pre-existing matrix elements are lost and must be rebuilt. + * Consequently, following a call to csrmatrix_sortrows(), all + * relations to any pre-existing matrix elements are lost and must be + * rebuilt. * * After a call to csrmatrix_sortrows(), the following relation holds * A->ja[k] < A->ja[k+1] for all k = A->ia[i], ..., @@ -163,8 +168,8 @@ csrmatrix_delete(struct CSRMatrix *A); /** - * Zero all matrix elements, typically in preparation of - * elemental assembly. + * Zero all matrix elements, typically in preparation of elemental + * assembly. * * \param[in,out] A Matrix for which to zero the elements. */ @@ -208,7 +213,8 @@ csrmatrix_write(const struct CSRMatrix *A, const char *fn); * MATLABĀ© or Octave. * * \param[in] A Matrix. - * \param[in] fp Open (text) stream to which matrix contents will be output. + * \param[in] fp Open (text) stream to which matrix contents will be + * output. */ void csrmatrix_write_stream(const struct CSRMatrix *A, FILE *fp); @@ -217,8 +223,8 @@ csrmatrix_write_stream(const struct CSRMatrix *A, FILE *fp); /** * Print vector to file. * - * Elements are printed with one line (separated by '\n') - * per vector element. + * Elements are printed with one line (separated by '\n') per vector + * element. * * This function is implemented in terms of vector_write_stream(). * @@ -233,12 +239,13 @@ vector_write(size_t n, const double *v, const char *fn); /** * Print vector to stream. * - * Elements are printed with one line (separated by '\n') - * per vector element. + * Elements are printed with one line (separated by '\n') per vector + * element. * * \param[in] n Number of vector elements. * \param[in] v Vector. - * \param[in] fp Open (text) stream to which vector contents will be output. + * \param[in] fp Open (text) stream to which vector contents will be + * output. */ void vector_write_stream(size_t n, const double *v, FILE *fp);