]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some doxygen issues
authorMatthias Maier <tamiko@43-1.org>
Sat, 24 Oct 2015 17:31:00 +0000 (12:31 -0500)
committerMatthias Maier <tamiko@43-1.org>
Mon, 28 Dec 2015 11:36:24 +0000 (12:36 +0100)
doc/doxygen/headers/constraints.h
include/deal.II/lac/constraint_linear_operator.h

index 0a5ed06cb7dfdcaaa26ab2bd0376f0b4ae199aad..93f740e4ae71d816521e31b1e7d2cac31ff3560a 100644 (file)
  *
  * In this case we can solve the modified system
  * @f[
- *   (C^T \cdot A \cdot C + Id_c) \tilde x = C^T (b - A\,k)
+ *   (C^T A C + Id_c) \tilde x = C^T (b - A\,k)
  * @f]
  * instead [1]. Here, $A$ is a given (unconstrained) system matrix $A$ and
  * $b$ the corresponding right hand side of a system of linear equations
  * ConstraintMatrix::distribute() operation applied on a vector $x$ is the
  * operation
  * @f[
-    $x$ \leftarrow C\,x+k.
+    x \leftarrow C\,x+k.
  * @f]
  * And finally, $Id_c$ denotes the identity on the subspace of constrained
  * degrees of freedom.
  *
  * The corresponding solution of $A\,x=b$ that obeys boundary conditions is
- * then recovered by distributing constraints to $\tilde x$: $x=C\tilde
- * x+k$.
+ * then recovered by distributing constraints: $x=C\tilde x+k$.
  *
  * The whole system can be set up and solved with the following snippet of
  * code:
index 347d845da1fef811ba104ff2534df9f026accd77..699d63a3b0e20c968d8456336bb91d2b5dc8054c 100644 (file)
@@ -188,7 +188,7 @@ LinearOperator<Range, Domain> project_to_constrained_linear_operator(
  * constrained_right_hand_side() to build up the following modified system
  * of linear equations:
  * @f[
- *   (C^T \cdot A \cdot C + Id_c) x = C^T (b - A\,k)
+ *   (C^T A C + Id_c) x = C^T (b - A\,k)
  * @f]
  * with a given (unconstrained) system matrix $A$, right hand side $b$, and
  * linear constraints $C$ with inhomogeneities $k$.
@@ -232,7 +232,7 @@ constrained_linear_operator(const ConstraintMatrix &constraint_matrix,
  * constrained_right_hand_side() to build up the following modified system
  * of linear equations:
  * @f[
- *   (C^T \cdot A \cdot C + Id_c) x = C^T (b - A\,k)
+ *   (C^T A C + Id_c) x = C^T (b - A\,k)
  * @f]
  * with a given (unconstrained) system matrix $A$, right hand side $b$, and
  * linear constraints $C$ with inhomogeneities $k$.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.