turbulentFluidThermoModels/derivedFvPatchFields: Updated documentation to conform to style-guide

Patch contributed by Bruno Santos
Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=2078

src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H

@@ -28,44 +28,56 @@ Group
     grpCoupledBoundaryConditions
 
 Description
-    This boundary condition provides a temperatue interface to an external
+    This boundary condition provides a temperature interface to an external
     application.  Values are transferred as plain text files, where OpenFOAM
     data is written as:
 
-        # Patch: \<patch name\>
+    \verbatim
-        \<magSf1\> \<value1\> \<qDot1\> \<htc1\>
+        # Patch: <patch name>
-        \<magSf2\> \<value2\> \<qDot2\> \<htc2\>
+        <magSf1> <value1> <qDot1> <htc1>
-        \<magSf3\> \<value3\> \<qDot3\> \<htc2\>
+        <magSf2> <value2> <qDot2> <htc2>
+        <magSf3> <value3> <qDot3> <htc2>
         ...
-        \<magSfN\> \<valueN\> \<qDotN\> \<htcN\>
+        <magSfN> <valueN> <qDotN> <htcN>
+    \endverbatim
 
     and received as the constituent pieces of the `mixed' condition, i.e.
 
-        # Patch: \<patch name\>
+    \verbatim
-        \<value1\> \<gradient1\> \<valueFracion1\>
+        # Patch: <patch name>
-        \<value2\> \<gradient2\> \<valueFracion2\>
+        <value1> <gradient1> <valueFraction1>
-        \<value3\> \<gradient3\> \<valueFracion3\>
+        <value2> <gradient2> <valueFraction2>
+        <value3> <gradient3> <valueFraction3>
         ...
-        \<valueN\> \<gradientN\> \<valueFracionN\>
+        <valueN> <gradientN> <valueFractionN>
+    \endverbatim
 
     Data is sent/received as a single file for all patches from the directory
 
-        $FOAM_CASE/\<commsDir\>
+    \verbatim
+        $FOAM_CASE/<commsDir>
+    \endverbatim
 
     At start-up, the boundary creates a lock file, i.e..
 
+    \verbatim
         OpenFOAM.lock
+    \endverbatim
 
     ... to signal the external source to wait.  During the boundary condition
     update, boundary values are written to file, e.g.
 
-        \<fileName\>.out
+    \verbatim
+        <fileName>.out
+    \endverbatim
 
     The lock file is then removed, instructing the external source to take
     control of the program execution.  When ready, the external program
     should create the return values, e.g. to file
 
-        \<fileName\>.in
+    \verbatim
+        <fileName>.in
+    \endverbatim
 
     ... and then re-instate the lock file.  The boundary condition will then
     read the return values, and pass program execution back to OpenFOAM.
@@ -85,13 +97,13 @@ Description
 
     Example of the boundary condition specification:
     \verbatim
-    myPatch
+        myPatch
-    {
+        {
-        type            externalCoupledTemperature;
+            type            externalCoupledTemperature;
-        commsDir        "$FOAM_CASE/comms";
+            commsDir        "$FOAM_CASE/comms";
-        fileName        data;
+            fileName        data;
-        calcFrequency   1;
+            calcFrequency   1;
-    }
+        }
     \endverbatim
 
 SeeAlso

src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H

@@ -82,7 +82,7 @@ Description
     }
     \endverbatim
 
-  Note:
+    Note:
 
     \li Only supply \c h and \c Ta, or \c q in the dictionary (see above)
     \li \c kappa and \c kappaName are inherited from temperatureCoupledBase.

src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H

@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::thermalBaffle1DFvPatchScalarField
+    Foam::compressible::thermalBaffle1DFvPatchScalarField
 
 Group
     grpThermoBoundaryConditions

src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::turbulentHeatFluxTemperatureFvPatchScalarField
+    Foam::compressible::turbulentHeatFluxTemperatureFvPatchScalarField
 
 Description
     Fixed heat boundary condition to specify temperature gradient. Input

src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H

@@ -27,15 +27,13 @@ Class
 
 Description
     Mixed boundary condition for temperature, to be used for heat-transfer
-    on back-to-back baffles.Optional thin thermal layer
+    on back-to-back baffles. Optional thin thermal layer resistances can be
-    resistances can be specified through thicknessLayers and kappaLayers
+    specified through thicknessLayers and kappaLayers entries.
-    entries.
 
     The thermal conductivity, \c kappa, can either be retrieved from the
     mesh database using the \c lookup option, or from a \c solidThermo
     or \c fluidThermo thermophysical package.
 
-
     Specifies gradient and temperature such that the equations are the same
     on both sides:
     - refGradient = zero gradient
@@ -64,7 +62,7 @@ Description
         kappa           lookup;
         kappaName       kappa;
         thicknessLayers (0.1 0.2 0.3 0.4);
-        kappaLayers     (1 2 3 4)
+        kappaLayers     (1 2 3 4);
         value           uniform 300;
     }
     \endverbatim

src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -55,24 +55,24 @@ Description
         type            compressible::turbulentTemperatureRadCoupledMixed;
         Tnbr            T;
         kappa           lookup;
-        KappaName       kappa;
+        kappaName       kappa;
         QrNbr           Qr; // or none. Name of Qr field on neighbour region
         Qr              Qr; // or none. Name of Qr field on local region
         thicknessLayers (0.1 0.2 0.3 0.4);
-        kappaLayers     (1 2 3 4)
+        kappaLayers     (1 2 3 4);
         value           uniform 300;
     }
     \endverbatim
 
     Needs to be on underlying mapped(Wall)FvPatch.
 
-    Note: kappa : heat conduction at patch. Gets supplied how to
+    Note:
-            lookup/calculate
+
-     kappa:
+    \li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
-    - 'lookup' : lookup volScalarField (or volSymmTensorField) with name
+
-    - 'fluidThermo' : use fluidThermo and compressible::RASmodel to calculate K
+
-    - 'solidThermo' : use solidThermo kappa()
+SeeAlso
-    - 'directionalSolidThermo' directionalKappa()
+    Foam::temperatureCoupledBase
 
 SourceFiles
     turbulentTemperatureRadCoupledMixedFvPatchScalarField.C