SparseMatrix: rename om to omega

diff --git a/include/deal.II/lac/sparse_matrix.h b/include/deal.II/lac/sparse_matrix.h
index 2cd998e33cffb7ed4230bb44456e27c5e0d74200..d2c5f619b0d150c8f0785848f09496a3c11c836c 100644 (file)
--- a/include/deal.II/lac/sparse_matrix.h
+++ b/include/deal.II/lac/sparse_matrix.h
@@ -1385,7 +1385,7 @@ public:
   void
   precondition_SOR(Vector<somenumber> &      dst,
                    const Vector<somenumber> &src,
-                   const number              om = 1.) const;
+                   const number              omega = 1.) const;
 
   /**
    * Apply transpose SOR preconditioning matrix to <tt>src</tt>.
@@ -1394,7 +1394,7 @@ public:
   void
   precondition_TSOR(Vector<somenumber> &      dst,
                     const Vector<somenumber> &src,
-                    const number              om = 1.) const;
+                    const number              omega = 1.) const;
 
   /**
    * Perform SSOR preconditioning in-place.  Apply the preconditioner matrix
@@ -1411,7 +1411,7 @@ public:
    */
   template <typename somenumber>
   void
-  SOR(Vector<somenumber> &v, const number om = 1.) const;
+  SOR(Vector<somenumber> &v, const number omega = 1.) const;
 
   /**
    * Perform a transpose SOR preconditioning in-place.  <tt>omega</tt> is the
@@ -1419,7 +1419,7 @@ public:
    */
   template <typename somenumber>
   void
-  TSOR(Vector<somenumber> &v, const number om = 1.) const;
+  TSOR(Vector<somenumber> &v, const number omega = 1.) const;
 
   /**
    * Perform a permuted SOR preconditioning in-place.
@@ -1436,7 +1436,7 @@ public:
   PSOR(Vector<somenumber> &          v,
        const std::vector<size_type> &permutation,
        const std::vector<size_type> &inverse_permutation,
-       const number                  om = 1.) const;
+       const number                  omega = 1.) const;
 
   /**
    * Perform a transposed permuted SOR preconditioning in-place.
@@ -1453,7 +1453,7 @@ public:
   TPSOR(Vector<somenumber> &          v,
         const std::vector<size_type> &permutation,
         const std::vector<size_type> &inverse_permutation,
-        const number                  om = 1.) const;
+        const number                  omega = 1.) const;
 
   /**
    * Do one Jacobi step on <tt>v</tt>.  Performs a direct Jacobi step with
@@ -1464,7 +1464,7 @@ public:
   void
   Jacobi_step(Vector<somenumber> &      v,
               const Vector<somenumber> &b,
-              const number              om = 1.) const;
+              const number              omega = 1.) const;
 
   /**
    * Do one SOR step on <tt>v</tt>.  Performs a direct SOR step with right
@@ -1474,7 +1474,7 @@ public:
   void
   SOR_step(Vector<somenumber> &      v,
            const Vector<somenumber> &b,
-           const number              om = 1.) const;
+           const number              omega = 1.) const;
 
   /**
    * Do one adjoint SOR step on <tt>v</tt>.  Performs a direct TSOR step with
@@ -1484,7 +1484,7 @@ public:
   void
   TSOR_step(Vector<somenumber> &      v,
             const Vector<somenumber> &b,
-            const number              om = 1.) const;
+            const number              omega = 1.) const;
 
   /**
    * Do one SSOR step on <tt>v</tt>.  Performs a direct SSOR step with right
@@ -1494,7 +1494,7 @@ public:
   void
   SSOR_step(Vector<somenumber> &      v,
             const Vector<somenumber> &b,
-            const number              om = 1.) const;
+            const number              omega = 1.) const;
   //@}
   /**
    * @name Iterators

diff --git a/include/deal.II/lac/sparse_matrix.templates.h b/include/deal.II/lac/sparse_matrix.templates.h
index 9e62e33f9c2d2132bb3e1b17d3d16dbf96ffb09c..74fba0265f9cd3b30e56c24204022b14066e86ba 100644 (file)
--- a/include/deal.II/lac/sparse_matrix.templates.h
+++ b/include/deal.II/lac/sparse_matrix.templates.h
@@ -1398,7 +1398,7 @@ template <typename somenumber>
 void
 SparseMatrix<number>::precondition_Jacobi(Vector<somenumber> &      dst,
                                           const Vector<somenumber> &src,
-                                          const number              om) const
+                                          const number              omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
@@ -1424,9 +1424,9 @@ SparseMatrix<number>::precondition_Jacobi(Vector<somenumber> &      dst,
   // in each row, i.e. at index
   // rowstart[i]. and we do have a
   // square matrix by above assertion
-  if (om != number(1.))
+  if (omega != number(1.))
     for (size_type i = 0; i < n; ++i, ++dst_ptr, ++src_ptr, ++rowstart_ptr)
-      *dst_ptr = somenumber(om) * *src_ptr / somenumber(val[*rowstart_ptr]);
+      *dst_ptr = somenumber(omega) * *src_ptr / somenumber(val[*rowstart_ptr]);
   else
     for (size_type i = 0; i < n; ++i, ++dst_ptr, ++src_ptr, ++rowstart_ptr)
       *dst_ptr = *src_ptr / somenumber(val[*rowstart_ptr]);
@@ -1440,7 +1440,7 @@ void
 SparseMatrix<number>::precondition_SSOR(
   Vector<somenumber> &            dst,
   const Vector<somenumber> &      src,
-  const number                    om,
+  const number                    omega,
   const std::vector<std::size_t> &pos_right_of_diagonal) const
 {
   // to understand how this function works
@@ -1482,15 +1482,15 @@ SparseMatrix<number>::precondition_SSOR(
             s += val[j] * number(dst(cols->colnums[j]));
 
           // divide by diagonal element
-          *dst_ptr -= s * om;
+          *dst_ptr -= s * omega;
           *dst_ptr /= val[*rowstart_ptr];
         }
 
       rowstart_ptr = cols->rowstart.get();
       dst_ptr      = &dst(0);
       for (; rowstart_ptr != &cols->rowstart[n]; ++rowstart_ptr, ++dst_ptr)
-        *dst_ptr *=
-          somenumber(om * (number(2.) - om)) * somenumber(val[*rowstart_ptr]);
+        *dst_ptr *= somenumber(omega * (number(2.) - omega)) *
+                    somenumber(val[*rowstart_ptr]);
 
       // backward sweep
       rowstart_ptr = &cols->rowstart[n - 1];
@@ -1504,7 +1504,7 @@ SparseMatrix<number>::precondition_SSOR(
           for (size_type j = first_right_of_diagonal_index; j < end_row; ++j)
             s += val[j] * number(dst(cols->colnums[j]));
 
-          *dst_ptr -= s * om;
+          *dst_ptr -= s * omega;
           *dst_ptr /= val[*rowstart_ptr];
         };
       return;
@@ -1536,7 +1536,7 @@ SparseMatrix<number>::precondition_SSOR(
         s += val[j] * number(dst(cols->colnums[j]));
 
       // divide by diagonal element
-      *dst_ptr -= s * om;
+      *dst_ptr -= s * omega;
       Assert(val[*rowstart_ptr] != number(), ExcDivideByZero());
       *dst_ptr /= val[*rowstart_ptr];
     };
@@ -1544,7 +1544,8 @@ SparseMatrix<number>::precondition_SSOR(
   rowstart_ptr = cols->rowstart.get();
   dst_ptr      = &dst(0);
   for (size_type row = 0; row < n; ++row, ++rowstart_ptr, ++dst_ptr)
-    *dst_ptr *= somenumber((number(2.) - om)) * somenumber(val[*rowstart_ptr]);
+    *dst_ptr *=
+      somenumber((number(2.) - omega)) * somenumber(val[*rowstart_ptr]);
 
   // backward sweep
   rowstart_ptr = &cols->rowstart[n - 1];
@@ -1560,7 +1561,7 @@ SparseMatrix<number>::precondition_SSOR(
       number s = 0;
       for (size_type j = first_right_of_diagonal_index; j < end_row; ++j)
         s += val[j] * number(dst(cols->colnums[j]));
-      *dst_ptr -= s * om;
+      *dst_ptr -= s * omega;
       Assert(val[*rowstart_ptr] != number(), ExcDivideByZero());
       *dst_ptr /= val[*rowstart_ptr];
     };
@@ -1572,13 +1573,13 @@ template <typename somenumber>
 void
 SparseMatrix<number>::precondition_SOR(Vector<somenumber> &      dst,
                                        const Vector<somenumber> &src,
-                                       const number              om) const
+                                       const number              omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
 
   dst = src;
-  SOR(dst, om);
+  SOR(dst, omega);
 }
 
 
@@ -1587,20 +1588,20 @@ template <typename somenumber>
 void
 SparseMatrix<number>::precondition_TSOR(Vector<somenumber> &      dst,
                                         const Vector<somenumber> &src,
-                                        const number              om) const
+                                        const number              omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
 
   dst = src;
-  TSOR(dst, om);
+  TSOR(dst, omega);
 }
 
 
 template <typename number>
 template <typename somenumber>
 void
-SparseMatrix<number>::SOR(Vector<somenumber> &dst, const number om) const
+SparseMatrix<number>::SOR(Vector<somenumber> &dst, const number omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
@@ -1619,7 +1620,7 @@ SparseMatrix<number>::SOR(Vector<somenumber> &dst, const number om) const
             s -= somenumber(val[j]) * dst(col);
         }
 
-      dst(row) = s * somenumber(om) / somenumber(val[cols->rowstart[row]]);
+      dst(row) = s * somenumber(omega) / somenumber(val[cols->rowstart[row]]);
     }
 }
 
@@ -1627,7 +1628,7 @@ SparseMatrix<number>::SOR(Vector<somenumber> &dst, const number om) const
 template <typename number>
 template <typename somenumber>
 void
-SparseMatrix<number>::TSOR(Vector<somenumber> &dst, const number om) const
+SparseMatrix<number>::TSOR(Vector<somenumber> &dst, const number omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
@@ -1644,7 +1645,7 @@ SparseMatrix<number>::TSOR(Vector<somenumber> &dst, const number om) const
         if (cols->colnums[j] > row)
           s -= somenumber(val[j]) * dst(cols->colnums[j]);
 
-      dst(row) = s * somenumber(om) / somenumber(val[cols->rowstart[row]]);
+      dst(row) = s * somenumber(omega) / somenumber(val[cols->rowstart[row]]);
 
       if (row == 0)
         break;
@@ -1660,7 +1661,7 @@ void
 SparseMatrix<number>::PSOR(Vector<somenumber> &          dst,
                            const std::vector<size_type> &permutation,
                            const std::vector<size_type> &inverse_permutation,
-                           const number                  om) const
+                           const number                  omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
@@ -1688,7 +1689,7 @@ SparseMatrix<number>::PSOR(Vector<somenumber> &          dst,
             }
         }
 
-      dst(row) = s * somenumber(om) / somenumber(val[cols->rowstart[row]]);
+      dst(row) = s * somenumber(omega) / somenumber(val[cols->rowstart[row]]);
     }
 }
 
@@ -1699,7 +1700,7 @@ void
 SparseMatrix<number>::TPSOR(Vector<somenumber> &          dst,
                             const std::vector<size_type> &permutation,
                             const std::vector<size_type> &inverse_permutation,
-                            const number                  om) const
+                            const number                  omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
@@ -1725,7 +1726,7 @@ SparseMatrix<number>::TPSOR(Vector<somenumber> &          dst,
             s -= somenumber(val[j]) * dst(col);
         }
 
-      dst(row) = s * somenumber(om) / somenumber(val[cols->rowstart[row]]);
+      dst(row) = s * somenumber(omega) / somenumber(val[cols->rowstart[row]]);
     }
 }
 
@@ -1736,7 +1737,7 @@ template <typename somenumber>
 void
 SparseMatrix<number>::Jacobi_step(Vector<somenumber> &      v,
                                   const Vector<somenumber> &b,
-                                  const number              om) const
+                                  const number              omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
@@ -1756,7 +1757,7 @@ SparseMatrix<number>::Jacobi_step(Vector<somenumber> &      v,
     }
   else
     w->equ(-1., b);
-  precondition_Jacobi(*w, *w, om);
+  precondition_Jacobi(*w, *w, omega);
   v -= *w;
 }
 
@@ -1767,7 +1768,7 @@ template <typename somenumber>
 void
 SparseMatrix<number>::SOR_step(Vector<somenumber> &      v,
                                const Vector<somenumber> &b,
-                               const number              om) const
+                               const number              omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
@@ -1784,7 +1785,7 @@ SparseMatrix<number>::SOR_step(Vector<somenumber> &      v,
         {
           s -= somenumber(val[j]) * v(cols->colnums[j]);
         }
-      v(row) += s * somenumber(om) / somenumber(val[cols->rowstart[row]]);
+      v(row) += s * somenumber(omega) / somenumber(val[cols->rowstart[row]]);
     }
 }
 
@@ -1795,7 +1796,7 @@ template <typename somenumber>
 void
 SparseMatrix<number>::TSOR_step(Vector<somenumber> &      v,
                                 const Vector<somenumber> &b,
-                                const number              om) const
+                                const number              omega) const
 {
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
   Assert(val != nullptr, ExcNotInitialized());
@@ -1812,7 +1813,7 @@ SparseMatrix<number>::TSOR_step(Vector<somenumber> &      v,
         {
           s -= somenumber(val[j]) * v(cols->colnums[j]);
         }
-      v(row) += s * somenumber(om) / somenumber(val[cols->rowstart[row]]);
+      v(row) += s * somenumber(omega) / somenumber(val[cols->rowstart[row]]);
     }
 }
 
@@ -1823,10 +1824,10 @@ template <typename somenumber>
 void
 SparseMatrix<number>::SSOR_step(Vector<somenumber> &      v,
                                 const Vector<somenumber> &b,
-                                const number              om) const
+                                const number              omega) const
 {
-  SOR_step(v, b, om);
-  TSOR_step(v, b, om);
+  SOR_step(v, b, omega);
+  TSOR_step(v, b, omega);
 }
 
 
@@ -1834,10 +1835,10 @@ SparseMatrix<number>::SSOR_step(Vector<somenumber> &      v,
 template <typename number>
 template <typename somenumber>
 void
-SparseMatrix<number>::SSOR(Vector<somenumber> &dst, const number om) const
+SparseMatrix<number>::SSOR(Vector<somenumber> &dst, const number omega) const
 {
-  // TODO: Is this called anywhere? If so, multiplication with om(2-om)D is
-  // missing
+  // TODO: Is this called anywhere? If so, multiplication with omega(2-omega)D
+  // is missing
   Assert(false, ExcNotImplemented());
 
   Assert(cols != nullptr, ExcNeedsSparsityPattern());
@@ -1863,7 +1864,7 @@ SparseMatrix<number>::SSOR(Vector<somenumber> &dst, const number om) const
                 s += somenumber(val[j]) * dst(p);
             }
         }
-      dst(i) -= s * somenumber(om);
+      dst(i) -= s * somenumber(omega);
       dst(i) /= somenumber(val[cols->rowstart[i]]);
     }
 
@@ -1880,7 +1881,7 @@ SparseMatrix<number>::SSOR(Vector<somenumber> &dst, const number om) const
                 s += somenumber(val[j]) * dst(p);
             }
         }
-      dst(i) -= s * somenumber(om) / somenumber(val[cols->rowstart[i]]);
+      dst(i) -= s * somenumber(omega) / somenumber(val[cols->rowstart[i]]);
     }
 }