mixed: more documentation

Author: kjetil

opm/simulators/linalg/mixed/bslv.c

@@ -72,6 +72,16 @@ void bslv_init(bslv_memory *mem, double tol, int max_iter, bsr_matrix const *A,
     prec_init(mem->P, A); // initialize structure of L,D,U components of P
 }
 
+/**
+ * @brief Inner product of two vectors.
+ *
+ * @note Function assumes vectors buffered to be an
+ *       integer multiple of cacheline size (64 bytes)
+ *
+ * @param a First input vector.
+ * @param b Second input vector.
+ * @param n Vector length.
+ */
 double __attribute__((noinline)) vec_inner2(const double *a, const double *b, int n)
 {
     const double *x = __builtin_assume_aligned(a,64);
@@ -84,13 +94,11 @@ double __attribute__((noinline)) vec_inner2(const double *a, const double *b, in
     {
         for(int j=0;j<N;j++) agg[j]+=x[i+j]*y[i+j];
     }
-    //for(int j=0;j<8;j++) agg[j]+=agg[j+8];
     for(int j=0;j<4;j++) agg[j]+=agg[j+4];
     for(int j=0;j<2;j++) agg[j]+=agg[j+2];
     for(int j=0;j<1;j++) agg[j]+=agg[j+1];
 
     return agg[0];
-
 }
 
 int bslv_pbicgstab3m(bslv_memory *mem, bsr_matrix *A, const double *b, double *x)

opm/simulators/linalg/mixed/prec.c

@@ -175,7 +175,7 @@ void mat3_matfms(double *C, const double *A, const double *B)
 }
 
 /**
- * @brief Matrix invese for 3x3 matrix.
+ * @brief Matrix inverse for 3x3 matrix.
  *
  * @param invA Pointer to inverse matrix.
  * @param    A Pointer to input matrix.
@@ -467,7 +467,12 @@ void prec_ilu0_factorize(prec_t *P, bsr_matrix *A)
     }
 }
 
-
+/**
+ * @brief In-place matrix-vector multiplication for 3x3 matrices.
+ *
+ * @param A Pointer to input matrix.
+ * @param x Pointer to input/output vector.
+ */
 static inline void mat3_vecmul(const double *A, double *x)
 {
     const int b=3;
@@ -483,6 +488,13 @@ static inline void mat3_vecmul(const double *A, double *x)
     for(int k=0;k<3;k++) x[k]=z[k];
 }
 
+/**
+ * @brief In-place fused matrix-vector multiply-subtract for 3x3 matrices.
+ *
+ * @param y Pointer to input/output vector.
+ * @param A Pointer to input matrix.
+ * @param x Pointer to input vector.
+ */
 
 static inline void mat3_vecfms(double *y, const double *A, const double *x)
 {