[cig-commits] [commit] master: Improved parameter documentation. (12e1e96)

[cig_noreply at geodynamics.org]

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

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/a7135c1f7697d39efff2f47a79ca1e1395cff504...73a71ba37f203bfed63bb8b602fdbd30ab99b1af

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

commit 12e1e9601c23a727811dd62793b12066b3a7785d
Author: Rene Gassmoeller <R.Gassmoeller at mailbox.org>
Date:   Wed May 21 15:28:47 2014 -0500

    Improved parameter documentation.


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

12e1e9601c23a727811dd62793b12066b3a7785d
 source/material_model/steinberger.cc           | 20 ++++++++++++--------
 source/velocity_boundary_conditions/gplates.cc |  2 +-
 2 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/source/material_model/steinberger.cc b/source/material_model/steinberger.cc
index 47eb89e..f75e384 100644
--- a/source/material_model/steinberger.cc
+++ b/source/material_model/steinberger.cc
@@ -888,7 +888,11 @@ namespace aspect
         {
           prm.declare_entry ("Data directory", "$ASPECT_SOURCE_DIR/data/material-model/steinberger/",
                              Patterns::DirectoryName (),
-                             "The path to the model data. ");
+                             "The path to the model data. The path may also include the special "
+                             "text '$ASPECT_SOURCE_DIR' which will be interpreted as the path "
+                             "in which the ASPECT source files were located when ASPECT was "
+                             "compiled. This interpretation allows, for example, to reference "
+                             "files located in the 'data/' subdirectory of ASPECT. ");
           prm.declare_entry ("Material file names", "pyr-ringwood88.txt",
                              Patterns::List (Patterns::Anything()),
                              "The file names of the material data. "
@@ -903,20 +907,20 @@ namespace aspect
                              "The file name of the lateral viscosity data. ");
           prm.declare_entry ("Bilinear interpolation", "true",
                              Patterns::Bool (),
-                             "whether to use bilinear interpolation to compute "
-                             "material properties (slower but more accurate).");
+                             "Whether to use bilinear interpolation to compute "
+                             "material properties (slower but more accurate). ");
           prm.declare_entry ("Latent heat", "false",
                              Patterns::Bool (),
-                             "whether to include latent heat effects in the"
+                             "Whether to include latent heat effects in the"
                              "calculation of thermal expansivity and specific heat."
-                             "Following the approach of Nakagawa et al. 2009.");
+                             "Following the approach of Nakagawa et al. 2009. ");
           prm.declare_entry ("Compressible", "false",
                              Patterns::Bool (),
-                             "whether to include a compressible material description."
-                             "For a description see the manual section.");
+                             "Whether to include a compressible material description."
+                             "For a description see the manual section. ");
           prm.declare_entry ("Reference viscosity", "1e23",
                              Patterns::Double(0),
-                             "The reference viscosity that is used for pressure scaling.");
+                             "The reference viscosity that is used for pressure scaling. ");
           prm.leave_subsection();
         }
         prm.leave_subsection();
diff --git a/source/velocity_boundary_conditions/gplates.cc b/source/velocity_boundary_conditions/gplates.cc
index 8842160..ca190f9 100644
--- a/source/velocity_boundary_conditions/gplates.cc
+++ b/source/velocity_boundary_conditions/gplates.cc
@@ -689,7 +689,7 @@ namespace aspect
                              "text '$ASPECT_SOURCE_DIR' which will be interpreted as the path "
                              "in which the ASPECT source files were located when ASPECT was "
                              "compiled. This interpretation allows, for example, to reference "
-                             "files located in the 'data/' subdirectory of ASPECT.");
+                             "files located in the 'data/' subdirectory of ASPECT. ");
           prm.declare_entry ("Velocity file name", "phi.%d",
                              Patterns::Anything (),
                              "The file name of the material data. Provide file in format: (Velocity file name).%d.gpml where %d is any sprintf integer qualifier, specifying the format of the current file number.");