[cig-commits] [commit] master: Revise documentation (02eb1fe)

[cig_noreply at geodynamics.org]

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

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/4a5e27e5690a0e0c1e13e19100af7398e37f36b8...d31f4e9435a1c12781f5b673b672cbd29c41c2c2

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

commit 02eb1fecda854c7ce3dfe25cb63855b8d3d601c1
Author: Siqi Zhang <siqi.zhang at mq.edu.au>
Date:   Wed May 21 10:14:19 2014 -0500

    Revise documentation


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

02eb1fecda854c7ce3dfe25cb63855b8d3d601c1
 source/heating_model/radioactive_decay.cc | 25 ++++++++++++++-----------
 1 file changed, 14 insertions(+), 11 deletions(-)

diff --git a/source/heating_model/radioactive_decay.cc b/source/heating_model/radioactive_decay.cc
index 839d287..b31877f 100644
--- a/source/heating_model/radioactive_decay.cc
+++ b/source/heating_model/radioactive_decay.cc
@@ -97,19 +97,21 @@ namespace aspect
                                 "Heating rate of different element (W/kg)");
             prm.declare_entry("Half decay time","",
                                 Patterns::List (Patterns::Double (0)),
-                                "Half decay time. Units: (Seconds), or (Years) if set 'use years instead of seconds'.");
-            prm.declare_entry("Initial consentration crust","",
+                                "Half decay time. Units: (Seconds), or "
+                                "(Years) if set 'use years instead of seconds'.");
+            prm.declare_entry("Initial concentration crust","",
                                 Patterns::List (Patterns::Double (0)),
-                                "Initial consentration of different elments (ppm)");
-            prm.declare_entry("Initial consentration mantle","",
+                                "Initial concentration of different elements (ppm)");
+            prm.declare_entry("Initial concentration mantle","",
                                 Patterns::List (Patterns::Double (0)),
-                                "Initial consentration of different elments (ppm)");
+                                "Initial concentration of different elements (ppm)");
             prm.declare_entry("Crust defined by composition","false",
                                 Patterns::Bool(),
                                 "Whether crust defined by composition or depth");
             prm.declare_entry("Crust depth","0",
                                 Patterns::Double(),
-                                "Depth of the crust when crust if defined by depth.");
+                                "Depth of the crust when crust if defined by depth. "
+                                "Units: m");
             prm.declare_entry("Crust composition number","0",
                                 Patterns::Integer(0),
                                 "Which composition field should be treated as crust");
@@ -146,16 +148,16 @@ namespace aspect
                            
             radioactive_initial_consentration_crust=Utilities::string_to_double
                 (Utilities::split_string_list
-                (prm.get("Initial consentration crust")));
+                (prm.get("Initial concentration crust")));
             AssertThrow(radioactive_initial_consentration_crust.size()==n_radio_heating_elements,
-                ExcMessage("Number of initial consentration entities does not match "
+                ExcMessage("Number of initial concentration entities does not match "
                            "the number of radioactive elements."));
                            
             radioactive_initial_consentration_mantle=Utilities::string_to_double
                 (Utilities::split_string_list
-                (prm.get("Initial consentration mantle")));
+                (prm.get("Initial concentration mantle")));
             AssertThrow(radioactive_initial_consentration_mantle.size()==n_radio_heating_elements,
-                ExcMessage("Number of initial consentration entities does not match "
+                ExcMessage("Number of initial concentration entities does not match "
                            "the number of radioactive elements."));
 
             is_crust_defined_by_composition = prm.get_bool    ("Crust defined by composition");
@@ -178,9 +180,10 @@ namespace aspect
     ASPECT_REGISTER_HEATING_MODEL(Radioactive_decay,
                                                  "radioactive decay",
                                                  "Implementation of a model in which the heating "
-                                                 "rate is decaying exponetially over time \n"
+                                                 "rate is decaying exponentially over time \n"
                                                  "The formula is interpreted as having units "
                                                  "W/kg."
                                                  "\n\n")
   }
 }
+