From bfcf50e0279d9dc50e6dbe39676e73c0b8868d8f Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Sun, 25 Oct 2015 15:29:33 +0000
Subject: [PATCH] turbulentHeatFluxTemperatureFvPatchScalarField: Updated docs
 Resolves report http://www.openfoam.org/mantisbt/view.php?id=1875

---
 ...entHeatFluxTemperatureFvPatchScalarField.H | 35 ++++++++++++++-----
 1 file changed, 26 insertions(+), 9 deletions(-)

diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H
index 94f75fead..e31aff890 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H
@@ -29,18 +29,35 @@ Description
     heat source either specified in terms of an absolute power [W], or as a
     flux [W/m^2].
 
+    \heading Patch usage
+
+    \table
+        Property     | Description             | Required    | Default value
+        heatSource   | 'power' [W] or 'flux' [W/m^2] | yes |
+        q            | heat power or flux field      | yes |
+        kappa        | inherited from Foam::temperatureCoupledBase | yes |
+        Qr           | name of the radiative flux field | yes |
+        value        | initial temperature value     | no | calculated
+        gradient     | initial gradient value        | no | 0.0
+    \endtable
+
     Example usage:
+    \verbatim
+    hotWall
+    {
+        type            compressible::turbulentHeatFluxTemperature;
+        heatSource      flux;
+        q               uniform 10;
+        kappa           fluidThermo;
+        Qr              none;
+        gradient        uniform 0;
+        value           uniform 300;
+    }
+    \endverbatim
 
-        hotWall
-        {
-            type            compressible::turbulentHeatFluxTemperature;
-            heatSource      flux;        // power [W]; flux [W/m^2]
-            q               uniform 10;  // heat power or flux
-            kappa           fluidThermo; // calculate kappa=alphaEff*thermo.Cp
-            Qr              none;        // name of the radiative flux
-            value           uniform 300; // initial temperature value
-        }
 
+SeeAlso
+    Foam::temperatureCoupledBase
 
 SourceFiles
     turbulentHeatFluxTemperatureFvPatchScalarField.C