[cig-commits] commit 2311 by bangerth to /var/svn/dealii/aspect

[dealii.demon at gmail.com]

Revision 2311

Clarify what this postprocessor computes.

U   trunk/aspect/source/postprocess/heat_flux_statistics.cc


http://www.dealii.org/websvn/revision.php?repname=Aspect+Repository&path=%2F&rev=2311&peg=2311

Diff:
Modified: trunk/aspect/source/postprocess/heat_flux_statistics.cc
===================================================================
--- trunk/aspect/source/postprocess/heat_flux_statistics.cc	2014-02-18 03:44:50 UTC (rev 2310)
+++ trunk/aspect/source/postprocess/heat_flux_statistics.cc	2014-02-18 16:13:38 UTC (rev 2311)
@@ -187,10 +187,20 @@
     ASPECT_REGISTER_POSTPROCESSOR(HeatFluxStatistics,
                                   "heat flux statistics",
                                   "A postprocessor that computes some statistics about "
-                                  "the heat flux across boundaries. For each boundary "
+                                  "the (conductive) heat flux across boundaries. For each boundary "
 				  "indicator (see your geometry description for which boundary "
 				  "indicators are used), the heat flux is computed in outward "
-				  "direction, i.e., from the domain to the outside. If you "
+				  "direction, i.e., from the domain to the outside, using the "
+				  "formula $\int_{\Gamma_i} k \nabla T \cdot \mathbf n$ "
+				  "where $\Gamma_i$ is the part of the boundary with indicator $i$, "
+				  "$k$ is the thermal conductivity as reported by the material model, "
+				  "$T$ is the temperature, and $\mathbf n$ is the outward normal. "
+				  "Note that the quantity so computed does not include any energy "
+				  "transported across the boundary by material transport in cases "
+				  "where $\mathbf u \cdot \mathbf n \neq 0$."
+				  "

"
+				  "As stated, this postprocessor computes the \textit{outbound} heat "
+				  "flux. If you "
 				  "are interested in the opposite direction, for example from "
 				  "the core into the mantle when the domain describes the "
 				  "mantle, then you need to multiply the result by -1.")