Corrected documentation in classes derived from temperatureCoupleBase

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

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

@@ -44,22 +44,21 @@ Description
         q  | heat flux [W/m^2]
     \endvartable
 
-    The thermal conductivity, \c kappa, can either be retrieved from the
+    The thermal conductivity \c kappa can either be retrieved from various
-    mesh database using the \c lookup option, or from a \c solidThermo
+    possible sources, as detailed in the class temperatureCoupledBase.
-    thermophysical package.
 
 Usage
     \table
         Property     | Description                 | Required | Default value
-        kappa        | thermal conductivity option | yes      |
         q            | heat flux [W/m^2]           | yes*     |
         Ta           | ambient temperature [K]     | yes*     |
         h            | heat transfer coefficient [W/m^2/K] | yes*|
         thicknessLayers | list of thicknesses per layer [m] | yes |
-        kappaLayers  | list of thermal conductivites per layer [W/m/K] | yes |
+        kappaLayers  | list of thermal conductivities per layer [W/m/K] | yes |
-        kappaName    | name of thermal conductivity field | yes  |
         Qr           | name of the radiative field | no | no
         relaxation   | relaxation factor for radiative field | no | 1
+        kappaMethod  | inherited from temperatureCoupledBase | inherited |
+        kappa        | inherited from temperatureCoupledBase | inherited |
     \endtable
 
     Example of the boundary condition specification:
@@ -67,22 +66,21 @@ Usage
     <patchName>
     {
         type            externalWallHeatFluxTemperature;
-        kappa           fluidThermo;
         q               uniform 1000;
         Ta              uniform 300.0;
         h               uniform 10.0;
         thicknessLayers (0.1 0.2 0.3 0.4);
         kappaLayers     (1 2 3 4);
         value           uniform 300.0;
-        kappaName       none;
         Qr              none;
         relaxation      1;
+        kappaMethod           fluidThermo;
+        kappa       none;
     }
     \endverbatim
 
     Note:
       - Only supply \c h and \c Ta, or \c q in the dictionary (see above)
-      - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
 
 See also
     Foam::temperatureCoupledBase

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

@@ -29,16 +29,19 @@ Description
     heat source either specified in terms of an absolute power [W], or as a
     flux [W/m^2].
 
+    The thermal conductivity \c kappa can either be retrieved from various
+    possible sources, as detailed in the class temperatureCoupledBase.
+
 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 temperatureCoupledBase | yes |
-        kappaName    | inherited from temperatureCoupledBase | yes |
         Qr           | name of the radiative flux field | yes |
         value        | initial temperature value | no | calculated
         gradient     | initial gradient value | no | 0.0
+        kappaMethod  | inherited from temperatureCoupledBase | inherited |
+        kappa        | inherited from temperatureCoupledBase | inherited |
     \endtable
 
     Note: If needed, both 'value' and 'gradient' must be defined to be used.
@@ -50,13 +53,12 @@ Usage
         type            compressible::turbulentHeatFluxTemperature;
         heatSource      flux;
         q               uniform 10;
-        kappa           fluidThermo;
+        kappaMethod     fluidThermo;
-        kappaName       none;
+        kappa           none;
         Qr              none;
     }
     \endverbatim
 
-
 See also
     Foam::temperatureCoupledBase
 

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

@@ -30,10 +30,6 @@ Description
     on back-to-back baffles. Optional thin thermal layer resistances can be
     specified through thicknessLayers and kappaLayers 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
@@ -42,14 +38,17 @@ Description
 
     where KDelta is heat-transfer coefficient K * deltaCoeffs
 
+    The thermal conductivity \c kappa can either be retrieved from various
+    possible sources, as detailed in the class temperatureCoupledBase.
+
 Usage
     \table
         Property     | Description             | Required    | Default value
-        kappa        | thermal conductivity option | yes     |
-        kappaName    | name of thermal conductivity field | no  |
         Tnbr         | name of the field    | no | T
         thicknessLayers | list of thicknesses per layer [m] | no |
-        kappaLayers  | list of thermal conductivites per layer [W/m/K] | no |
+        kappaLayers  | list of thermal conductivities per layer [W/m/K] | no |
+        kappaMethod  | inherited from temperatureCoupledBase | inherited |
+        kappa        | inherited from temperatureCoupledBase | inherited |
     \endtable
 
     Example of the boundary condition specification:
@@ -58,20 +57,16 @@ Usage
     {
         type            compressible::turbulentTemperatureCoupledBaffleMixed;
         Tnbr            T;
-        kappa           lookup;
-        kappaName       kappa;
         thicknessLayers (0.1 0.2 0.3 0.4);
         kappaLayers     (1 2 3 4);
+        kappaMethod     lookup;
+        kappa           kappa;
         value           uniform 300;
     }
     \endverbatim
 
     Needs to be on underlying mapped(Wall)FvPatch.
 
-    Note:
-      - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
-
-
 See also
     Foam::temperatureCoupledBase
 

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

@@ -31,20 +31,19 @@ Description
     resistances can be specified through thicknessLayers and kappaLayers
     entries.
 
-    The thermal conductivity, \c kappa, can either be retrieved from the
+    The thermal conductivity \c kappa can either be retrieved from various
-    mesh database using the \c lookup option, or from a \c solidThermo
+    possible sources, as detailed in the class temperatureCoupledBase.
-    or \c fluidThermo thermophysical package.
 
 Usage
     \table
         Property     | Description             | Required    | Default value
-        kappa        | thermal conductivity option | yes     |
-        kappaName    | name of thermal conductivity field | no  |
         Tnbr         | name of the field    | no | T
         QrNbr      | name of the radiative flux in the nbr region | no | none
         Qr         | name of the radiative flux in this region | no | none
         thicknessLayers | list of thicknesses per layer [m] | no |
         kappaLayers  | list of thermal conductivites per layer [W/m/K] | no |
+        kappaMethod  | inherited from temperatureCoupledBase | inherited |
+        kappa        | inherited from temperatureCoupledBase | inherited |
     \endtable
 
     Example of the boundary condition specification:
@@ -53,22 +52,18 @@ Usage
     {
         type            compressible::turbulentTemperatureRadCoupledMixed;
         Tnbr            T;
-        kappa           lookup;
-        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);
+        kappaMethod     lookup;
+        kappa           kappa;
         value           uniform 300;
     }
     \endverbatim
 
     Needs to be on underlying mapped(Wall)FvPatch.
 
-    Note:
-      - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
-
-
 See also
     Foam::temperatureCoupledBase