[cig-commits] [commit] master: Work on language (f6e293b)

[cig_noreply at geodynamics.org]

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

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/ed4caebc0ab942d8c7bc1a6a3ba70e37f93accde...dbe66e1b6d25d5ff21653c48f14f343e10ae69f4

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

commit f6e293bf601f3c2c20b07dff7da8d7da028302e2
Author: ian-r-rose <ian.r.rose at gmail.com>
Date:   Mon May 19 15:57:14 2014 -0500

    Work on language


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

f6e293bf601f3c2c20b07dff7da8d7da028302e2
 include/aspect/material_model/multicomponent.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/include/aspect/material_model/multicomponent.h b/include/aspect/material_model/multicomponent.h
index 1189c42..bc455a8 100644
--- a/include/aspect/material_model/multicomponent.h
+++ b/include/aspect/material_model/multicomponent.h
@@ -33,14 +33,21 @@ namespace aspect
 
     /**
      * A material model which is intended for use with multiple compositional fields. 
-     * For each material parameter the user supplies a comma delimited list of length N+1,
+     * Each compositional field is meant to be a single rock type, where the value of the
+     * field at a point is interpreted to be a volume fraction of that rock type.  If the sum
+     * of the compositional field volume fractions is less than one, then the remainder of
+     * the volume is assumed to be ``background mantle''.  If the sum of the compositional
+     * field volume fractions is greater than one, then they are renormalized to sum to one 
+     * and there is no background mantle.
+     *
+     * For each material parameter the user supplies a comma delimited list of length N+1, where
      * N is the number of compositional fields.  The additional field corresponds to the value
      * for background mantle.  They should be ordered ``background, composition1, composition2...''
      *
      * If a single value is given, then all the compositional fields are given that value. 
      * Other lengths of lists are not allowed.  For a given compositional field the material 
      * parameters are treated as constant, except density, which varies linearly with temperature
-     * according to the thermal expansivity.. 
+     * according to the thermal expansivity.
      *
      * When more than one field is present at a point, they are averaged arithmetically.
      * An exception is viscosity, which may be averaged arithmetically, harmonically, geometrically,