[cig-commits] [commit] master: Augment the documentation. (9a751c0)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/aspect

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/f6886e487ad093a7261b0437a3ebe6fe303b1665...c750436c01183adf620425711d16848a6ba6ead8

>---------------------------------------------------------------

commit 9a751c0d1bf672d63923f408d73bc5e596f1848a
Author: Wolfgang Bangerth <bangerth at math.tamu.edu>
Date:   Wed May 14 13:53:12 2014 -0500

    Augment the documentation.


>---------------------------------------------------------------

9a751c0d1bf672d63923f408d73bc5e596f1848a
 include/aspect/simulator.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/include/aspect/simulator.h b/include/aspect/simulator.h
index 1b03f72..d090a0c 100644
--- a/include/aspect/simulator.h
+++ b/include/aspect/simulator.h
@@ -543,7 +543,9 @@ namespace aspect
        * residual, i.e., if the linear system to be solved is $Ax=b$, then
        * return $\|Ax_0-b\|$ where $x_0$ is the initial guess for the solution
        * variable and is taken from the current_linearization_point member
-       * variable.
+       * variable. For the purpose of this function, this residual is computed
+       * only the velocity and pressure equations (i.e., for the 2x2 block
+       * system involving the velocity and pressure variables).
        *
        * This function is implemented in
        * <code>source/simulator/solver.cc</code>.