From 29c985feec579cec96c4328cf3065a545c2dad0f Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Sat, 21 May 2016 20:26:23 +0100
Subject: [PATCH] temperatureCoupledBase: Rationalized the selection of the
 method for obtaining the thermal conductivity

kappa -> kappaMethod
kappaName -> kappa
---
 .../temperatureCoupledBase.C                  | 13 +++---
 .../temperatureCoupledBase.H                  | 40 +++++++++----------
 2 files changed, 25 insertions(+), 28 deletions(-)

diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.C b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.C
index 03b93bf10f5..7e6ede53d10 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.C
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.C
@@ -1,4 +1,4 @@
- /*---------------------------------------------------------------------------*\
+/*---------------------------------------------------------------------------*\
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
@@ -76,9 +76,9 @@ Foam::temperatureCoupledBase::temperatureCoupledBase
 )
 :
     patch_(patch),
-    method_(KMethodTypeNames_.read(dict.lookup("kappa"))),
-    kappaName_(dict.lookup("kappaName")),
-    alphaAniName_(dict.lookupOrDefault<word>("alphaAniName","Anialpha"))
+    method_(KMethodTypeNames_.read(dict.lookup("kappaMethod"))),
+    kappaName_(dict.lookupOrDefault<word>("kappa", "none")),
+    alphaAniName_(dict.lookupOrDefault<word>("alphaAni","Anialpha"))
 {}
 
 
@@ -224,9 +224,10 @@ Foam::tmp<Foam::scalarField> Foam::temperatureCoupledBase::kappa
 
 void Foam::temperatureCoupledBase::write(Ostream& os) const
 {
-    os.writeKeyword("kappa") << KMethodTypeNames_[method_]
+    os.writeKeyword("kappaMethod") << KMethodTypeNames_[method_]
         << token::END_STATEMENT << nl;
-    os.writeKeyword("kappaName") << kappaName_ << token::END_STATEMENT << nl;
+    os.writeKeyword("kappa") << kappaName_ << token::END_STATEMENT << nl;
+    os.writeKeyword("alphaAni") << alphaAniName_ << token::END_STATEMENT << nl;
 }
 
 
diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H
index d64cdef42be..21bafe0db44 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H
@@ -25,28 +25,24 @@ Class
     Foam::temperatureCoupledBase
 
 Description
-    Common functions for use in temperature coupled boundaries.
-
-    For now only provides the following methods:
-
-    - kappa() : heat conduction at patch. Gets supplied how to lookup/calculate
-      'kappa':
-        - 'lookup' : lookup volScalarField (or volSymmTensorField) with name
-           defined in 'kappaName'
-        - 'fluidThermo' : use fluidThermo and default
-          compressible::turbulenceModel to calculate kappa
-        - 'solidThermo' : use solidThermo kappa()
-        - 'directionalSolidThermo': uses look up for volSymmTensorField for
-          transformed kappa vector. Field name definable in 'alphaAniName',
-          named 'Anialpha' in solid solver by default
+    Common functions used in temperature coupled boundaries.
+
+    The thermal conductivity \c kappa may be obtained by the following methods:
+      - 'lookup' : lookup volScalarField (or volSymmTensorField) with name
+        defined by 'kappa'
+      - 'fluidThermo' : use fluidThermo and default
+        compressible::turbulenceModel to calculate kappa
+      - 'solidThermo' : use solidThermo kappa()
+      - 'directionalSolidThermo': uses look up for volSymmTensorField for
+        transformed kappa vector. Field name definable in 'alphaAni',
+        named 'Anialpha' in solid solver by default
 
     \heading Keywords provided by this class
-
     \table
-        Property     | Description             | Required    | Default value
-        kappa        | heat conduction type at patch, as listed above | yes |
-        kappaName    | Name of thermal conductivity field | yes |
-        alphaAniName | name of the non-isotropic alpha | no | 'Anialpha'
+        Property     | Description                | Required    | Default value
+        kappaMethod  | Thermal conductivity method        | yes |
+        kappa        | Name of thermal conductivity field | no  | none
+        alphaAni     | Name of the non-isotropic alpha    | no  | Anialpha
     \endtable
 
     Usage examples:
@@ -54,9 +50,9 @@ Description
     nonIsotropicWall
     {
         ...
-        kappa           directionalSolidThermo;
-        kappaName       none;
-        alphaAniName    Anialpha;
+        kappaMethod     directionalSolidThermo;
+        kappa           none;
+        alphaAni        Anialpha;
         ...
     }
     \endverbatim
-- 
GitLab