[cig-commits] [commit] master: Improve description in constant heating plugin. (02f034a)

[cig_noreply at geodynamics.org]

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

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/7b658caa05d489ae3f8d61b8049b015e7be94f77...cc43d3ac6f571573118eb54c2103bf92dfe8355f

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

commit 02f034a3a01b358d6120db6ca04644a8db9308e3
Author: Rene Gassmoeller <R.Gassmoeller at mailbox.org>
Date:   Fri May 16 11:43:44 2014 -0500

    Improve description in constant heating plugin.


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

02f034a3a01b358d6120db6ca04644a8db9308e3
 source/heating_model/constant_heating.cc | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/source/heating_model/constant_heating.cc b/source/heating_model/constant_heating.cc
index 691a402..88d3c94 100644
--- a/source/heating_model/constant_heating.cc
+++ b/source/heating_model/constant_heating.cc
@@ -47,10 +47,12 @@ namespace aspect
       {
         prm.enter_subsection("Constant heating");
         {
-          prm.declare_entry ("Radiogenic heating rate", "0",
+          prm.declare_entry ("Radiogenic heating rate", "0e0",
                              Patterns::Double (0),
-                             "The value of the specific radiogenic heating rate. "
-                             "Units: $W/kg$.");
+                             "The specific rate of heating due to radioactive decay (or other bulk sources "
+                             "you may want to describe). This parameter corresponds to the variable "
+                             "$H$ in the temperature equation stated in the manual, and the heating "
+                             "term is $\rho H$. Units: W/kg.");
         }
         prm.leave_subsection();
       }