Skip to content
Snippets Groups Projects
Commit 2bcaf745 authored by Dmitri Naumov's avatar Dmitri Naumov
Browse files

[MaL] Fix various PETSc functions documentation.

parent aafe4cc5
No related branches found
No related tags found
No related merge requests found
......@@ -249,11 +249,12 @@ class PETScMatrix
PetscInt _end_rank;
/*!
\brief Create the matrix, configure memory allocation and set the related member data.
\param Number of nonzeros per row in the diagonal portion of local submatrix
(same value is used for all local rows),
\param Number of nonzeros per row in the off-diagonal portion of local submatrix
(same value is used for all local rows)
\brief Create the matrix, configure memory allocation and set the
related member data.
\param d_nz Number of nonzeros per row in the diagonal portion of
local submatrix (same value is used for all local rows),
\param o_nz Number of nonzeros per row in the off-diagonal portion of
local submatrix (same value is used for all local rows)
*/
void create(const PetscInt d_nz, const PetscInt o_nz);
......
......@@ -27,12 +27,11 @@ namespace MathLib
/*!
\brief apply known solutions to a system of linear equations
\param A Coefficient matrix
\param b RHS vector
\param vec_knownX_id a vector of known solution entry IDs
\param vec_knownX_x a vector of known solutions
\param penalty_scaling value for scaling some matrix and right hand side
entries to enforce some conditions
\param A Coefficient matrix
\param b RHS vector
\param x Solution vector
\param vec_knownX_id A vector of known solution entry IDs
\param vec_knownX_x A vector of known solutions
*/
void applyKnownSolution(PETScMatrix &A, PETScVector &b, PETScVector &x,
const std::vector<PetscInt> &vec_knownX_id,
......
......@@ -282,8 +282,6 @@ class PETScVector
/*!
Get local vector, i.e. entries in the same rank
\param loc_vec Pointer to array where stores the local vector,
memory allocation is not needed
*/
PetscScalar* getLocalVector() const;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment