[cig-commits] [commit] master: Augment documentation slightly. (586c90b)

[cig_noreply at geodynamics.org]

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

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/36d87031b9d5259810f221b3b17377d9d8944a24...586c90b1a92e2e5718f052f6dba3463d53fdbe70

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

commit 586c90b1a92e2e5718f052f6dba3463d53fdbe70
Author: Wolfgang Bangerth <bangerth at math.tamu.edu>
Date:   Tue May 27 18:18:39 2014 -0500

    Augment documentation slightly.


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

586c90b1a92e2e5718f052f6dba3463d53fdbe70
 include/aspect/material_model/simpler.h | 5 ++++-
 source/material_model/simple.cc         | 9 ++++++++-
 source/material_model/simpler.cc        | 8 ++++++--
 3 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/include/aspect/material_model/simpler.h b/include/aspect/material_model/simpler.h
index f32c8bc..d9ebd04 100644
--- a/include/aspect/material_model/simpler.h
+++ b/include/aspect/material_model/simpler.h
@@ -33,9 +33,12 @@ namespace aspect
 
     /**
      * A material model that consists of globally constant values for all
-     * material parameters except the density, that depends linearly on the
+     * material parameters except the density, which depends linearly on the
      * temperature. The model is considered incompressible.
      *
+     * This material model implements what the "Simple" model was originally
+     * intended to do, before it got too complicated.
+     *
      * @ingroup MaterialModels
      */
     template <int dim>
diff --git a/source/material_model/simple.cc b/source/material_model/simple.cc
index b654495..4f96db8 100644
--- a/source/material_model/simple.cc
+++ b/source/material_model/simple.cc
@@ -378,6 +378,13 @@ namespace aspect
                                    "\n\n"
                                    "Note that this model uses the formulation that assumes an incompressible "
                                    "medium despite the fact that the density follows the law "
-                                   "$\\rho(T)=\\rho_0(1-\\beta(T-T_{\\text{ref}})$. ")
+                                   "$\\rho(T)=\\rho_0(1-\\beta(T-T_{\\text{ref}})$. "
+                                   "\n\n"
+                                   "\\note{Despite its name, this material model is not exactly ``simple'', "
+                                   "as indicated by the formulas above. While it was originally intended "
+                                   "to be simple, it has over time acquired all sorts of temperature "
+                                   "and compositional dependencies that weren't initially intended. "
+                                   "Consequently, there is now a ``simpler'' material model that now fills "
+                                   "the role the current model was originally intended to fill.}")
   }
 }
diff --git a/source/material_model/simpler.cc b/source/material_model/simpler.cc
index f101727..86e5770 100644
--- a/source/material_model/simpler.cc
+++ b/source/material_model/simpler.cc
@@ -183,7 +183,11 @@ namespace aspect
                                    "A material model that has constant values "
                                    "except for density, which depends linearly on temperature: "
                                    "\\begin{align}"
-                                   "  \\rho(p,T) &= \\left(1-\\alpha (T-T_0)\\right)\\rho_0"
-                                   "\\end{align}")
+                                   "  \\rho(p,T) &= \\left(1-\\alpha (T-T_0)\\right)\\rho_0."
+                                   "\\end{align}"
+                                   "\n\n"
+                                   "\\note{This material model fills the role the ``simple'' material "
+                                   "model was originally intended to fill, before the latter acquired "
+                                   "all sorts of complicated temperature and compositional dependencies.}")
   }
 }