[cig-commits] [commit] master: Update a few pieces of the documentation. (8767d45)

[cig_noreply at geodynamics.org]

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

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/3811725812cafa918bbabc2515f52af7857aad31...9a8086507e7ed22ed2a4d13771930e4ae6bc3a7d

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

commit 8767d45eb7839ee32a2bb338377a0064670dfdc6
Author: Wolfgang Bangerth <bangerth at math.tamu.edu>
Date:   Thu Jul 24 16:44:55 2014 -0500

    Update a few pieces of the documentation.


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

8767d45eb7839ee32a2bb338377a0064670dfdc6
 source/geometry_model/spherical_shell.cc     | 9 +++++----
 source/initial_conditions/spherical_shell.cc | 8 ++++----
 2 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/source/geometry_model/spherical_shell.cc b/source/geometry_model/spherical_shell.cc
index 0a5b8e2..d5c1911 100644
--- a/source/geometry_model/spherical_shell.cc
+++ b/source/geometry_model/spherical_shell.cc
@@ -188,10 +188,11 @@ namespace aspect
                              "that we want to build. Units: degrees.");
          
           prm.declare_entry ("Cells along circumference", "12",
-                              Patterns::Integer (),
-                              "The number of tangential cells that are "
-                              "created in the coarse mesh."); 
-
+			     Patterns::Integer (),
+			     "The number of cells in circumferential direction that are "
+			     "created in the coarse mesh in 2d. In 3d, the number of "
+			     "cells is computed differently and does not have an "
+			     "easy interpretation. It is best left at its default in 3d.");
         }
         prm.leave_subsection();
       }
diff --git a/source/initial_conditions/spherical_shell.cc b/source/initial_conditions/spherical_shell.cc
index 6339416..4ff84de 100644
--- a/source/initial_conditions/spherical_shell.cc
+++ b/source/initial_conditions/spherical_shell.cc
@@ -184,8 +184,8 @@ namespace aspect
 
          prm.declare_entry  ("Rotation offset", "-45",
                               Patterns::Double (),
-                              "Amount of clockwise rotation in degrees to apply to"
-                              "the perturbations. Default is set to -45 in order"
+                              "Amount of clockwise rotation in degrees to apply to "
+                              "the perturbations. Default is set to -45 in order "
                               "to provide backwards compatibility.");    
         }
         prm.leave_subsection ();
@@ -274,10 +274,10 @@ namespace aspect
     ASPECT_REGISTER_INITIAL_CONDITIONS(SphericalHexagonalPerturbation,
                                        "spherical hexagonal perturbation",
                                        "An initial temperature field in which the temperature "
-                                       "is perturbed following an N-fold pattern in a specified "
+                                       "is perturbed following an $N$-fold pattern in a specified "
                                        "direction from an otherwise spherically symmetric "
                                        "state. The class's name comes from previous versions"
-                                       "when the only opiton was N=6")
+                                       "when the only opiton was $N=6$.")
 
     ASPECT_REGISTER_INITIAL_CONDITIONS(SphericalGaussianPerturbation,
                                        "spherical gaussian perturbation",