From 491ae5678b90c24fa46d508962f0922244959fcc Mon Sep 17 00:00:00 2001
From: Wenqing Wang <wenqing.wang@ufz.de>
Date: Thu, 8 Jun 2017 10:12:46 +0200
Subject: [PATCH] [PETsc] Added more comments to some members of PETScVector
---
MathLib/LinAlg/PETSc/PETScVector.h | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/MathLib/LinAlg/PETSc/PETScVector.h b/MathLib/LinAlg/PETSc/PETScVector.h
index 187f8758f5f..3a936f11ee6 100644
--- a/MathLib/LinAlg/PETSc/PETScVector.h
+++ b/MathLib/LinAlg/PETSc/PETScVector.h
@@ -161,10 +161,12 @@ class PETScVector
/// Call this before call operator[] or get(...).
void setLocalAccessibleVector() const;
- /// Get several entries
+ /// Get several entries. setLocalAccessibleVector() must be
+ /// called beforehand.
std::vector<double> get(std::vector<IndexType> const& indices) const;
- // Get the value of an entry by [] operator
+ /// Get the value of an entry by [] operator.
+ /// setLocalAccessibleVector() must be called beforehand.
double operator[] (PetscInt idx) const
{
return get(idx);
@@ -182,8 +184,11 @@ class PETScVector
*/
void copyValues(std::vector<double>& u) const;
- /// Get an entry value. This is an expensive operation,
- /// and it only get local value. Use it for only test purpose
+ /* Get an entry value. This is an expensive operation,
+ and it only get local value. Use it for only test purpose
+ Get the value of an entry by [] operator.
+ setLocalAccessibleVector() must be called beforehand.
+ */
PetscScalar get(const PetscInt idx) const;
// TODO eliminate in favour of getRawVector()
--
GitLab