From 52482e5b8fa9627d52eda7fe0b15817395c13188 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Wed, 31 May 2017 23:12:54 +0100
Subject: [PATCH] fvDOM: renamed "convergence" -> "tolerance" for consistency
 with the rest of OpenFOAM

Maintains optional "convergence" keyword for backward-compatibility.
---
 .../radiationModels/fvDOM/fvDOM/fvDOM.C       | 27 ++++++++++++++-----
 .../radiationModels/fvDOM/fvDOM/fvDOM.H       |  4 +--
 .../constant/radiationProperties              |  6 ++---
 .../constant/radiationProperties              |  2 +-
 .../constant/radiationProperties              |  8 +++---
 .../constant/radiationProperties              |  8 +++---
 .../constant/radiationProperties              |  8 +++---
 7 files changed, 39 insertions(+), 24 deletions(-)

diff --git a/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.C b/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.C
index 01db9565a..7b922f3af 100644
--- a/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.C
+++ b/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.C
@@ -281,7 +281,12 @@ Foam::radiation::fvDOM::fvDOM(const volScalarField& T)
     aLambda_(nLambda_),
     blackBody_(nLambda_, T),
     IRay_(0),
-    convergence_(coeffs_.lookupOrDefault<scalar>("convergence", 0.0)),
+    tolerance_
+    (
+        coeffs_.found("convergence")
+      ? readScalar(coeffs_.lookup("convergence"))
+      : coeffs_.lookupOrDefault<scalar>("tolerance", 0.0)
+    ),
     maxIter_(coeffs_.lookupOrDefault<label>("maxIter", 50)),
     omegaMax_(0)
 {
@@ -368,7 +373,12 @@ Foam::radiation::fvDOM::fvDOM
     aLambda_(nLambda_),
     blackBody_(nLambda_, T),
     IRay_(0),
-    convergence_(coeffs_.lookupOrDefault<scalar>("convergence", 0.0)),
+    tolerance_
+    (
+        coeffs_.found("convergence")
+      ? readScalar(coeffs_.lookup("convergence"))
+      : coeffs_.lookupOrDefault<scalar>("tolerance", 0.0)
+    ),
     maxIter_(coeffs_.lookupOrDefault<label>("maxIter", 50)),
     omegaMax_(0)
 {
@@ -389,7 +399,12 @@ bool Foam::radiation::fvDOM::read()
     if (radiationModel::read())
     {
         // Only reading solution parameters - not changing ray geometry
-        coeffs_.readIfPresent("convergence", convergence_);
+
+        // For backward-compatibility
+        coeffs_.readIfPresent("convergence", tolerance_);
+
+        coeffs_.readIfPresent("tolerance", tolerance_);
+
         coeffs_.readIfPresent("maxIter", maxIter_);
 
         return true;
@@ -407,7 +422,7 @@ void Foam::radiation::fvDOM::calculate()
 
     updateBlackBodyEmission();
 
-    // Set rays convergence false
+    // Set rays converged false
     List<bool> rayIdConv(nRay_, false);
 
     scalar maxResidual = 0.0;
@@ -425,14 +440,14 @@ void Foam::radiation::fvDOM::calculate()
                 scalar maxBandResidual = IRay_[rayI].correct();
                 maxResidual = max(maxBandResidual, maxResidual);
 
-                if (maxBandResidual < convergence_)
+                if (maxBandResidual < tolerance_)
                 {
                     rayIdConv[rayI] = true;
                 }
             }
         }
 
-    } while (maxResidual > convergence_ && radIter < maxIter_);
+    } while (maxResidual > tolerance_ && radIter < maxIter_);
 
     updateG();
 }
diff --git a/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.H b/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.H
index ed853850e..4b187ab40 100644
--- a/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.H
+++ b/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.H
@@ -121,8 +121,8 @@ class fvDOM
         //- List of pointers to radiative intensity rays
         PtrList<radiativeIntensityRay> IRay_;
 
-        //- Convergence criterion
-        scalar convergence_;
+        //- Convergence tolerance
+        scalar tolerance_;
 
         //- Maximum number of iterations
         label maxIter_;
diff --git a/tutorials/combustion/fireFoam/LES/flameSpreadWaterSuppressionPanel/constant/radiationProperties b/tutorials/combustion/fireFoam/LES/flameSpreadWaterSuppressionPanel/constant/radiationProperties
index c8eb0182a..5dc5fa64f 100644
--- a/tutorials/combustion/fireFoam/LES/flameSpreadWaterSuppressionPanel/constant/radiationProperties
+++ b/tutorials/combustion/fireFoam/LES/flameSpreadWaterSuppressionPanel/constant/radiationProperties
@@ -22,9 +22,9 @@ radiationModel  fvDOM;
 
 fvDOMCoeffs
 {
-    nPhi    2;           // azimuthal angles in PI/2 on X-Y.(from Y to X)
-    nTheta  2;           // polar angles in PI (from Z to X-Y plane)
-    convergence 1e-2;   // convergence criteria for radiation iteration
+    nPhi    2;          // azimuthal angles in PI/2 on X-Y.(from Y to X)
+    nTheta  2;          // polar angles in PI (from Z to X-Y plane)
+    tolerance   1e-2;   // convergence tolerance for radiation iteration
     maxIter 3;          // maximum number of iterations
 }
 
diff --git a/tutorials/combustion/fireFoam/LES/oppositeBurningPanels/constant/radiationProperties b/tutorials/combustion/fireFoam/LES/oppositeBurningPanels/constant/radiationProperties
index 53e91a9c7..c4f0ed134 100644
--- a/tutorials/combustion/fireFoam/LES/oppositeBurningPanels/constant/radiationProperties
+++ b/tutorials/combustion/fireFoam/LES/oppositeBurningPanels/constant/radiationProperties
@@ -24,7 +24,7 @@ fvDOMCoeffs
 {
     nPhi    3;          // azimuthal angles in PI/2 on X-Y.(from Y to X)
     nTheta  6;          // polar angles in PI (from Z to X-Y plane)
-    convergence 0.05;   // convergence criteria for radiation iteration
+    tolerance   0.05;   // convergence tolerance for radiation iteration
     maxIter 3;          // maximum number of iterations
 }
 
diff --git a/tutorials/combustion/fireFoam/LES/smallPoolFire2D/constant/radiationProperties b/tutorials/combustion/fireFoam/LES/smallPoolFire2D/constant/radiationProperties
index d8da2d50c..7f31662ab 100644
--- a/tutorials/combustion/fireFoam/LES/smallPoolFire2D/constant/radiationProperties
+++ b/tutorials/combustion/fireFoam/LES/smallPoolFire2D/constant/radiationProperties
@@ -21,10 +21,10 @@ radiationModel  fvDOM;
 
 fvDOMCoeffs
 {
-    nPhi        4;          // azimuthal angles in PI/2 on X-Y.(from Y to X)
-    nTheta      0;          // polar angles in PI (from Z to X-Y plane)
-    convergence 1e-2;       // convergence criteria for radiation iteration
-    maxIter     4;          // maximum number of iterations
+    nPhi        4;      // azimuthal angles in PI/2 on X-Y.(from Y to X)
+    nTheta      0;      // polar angles in PI (from Z to X-Y plane)
+    tolerance   1e-2;   // convergence tolerance for radiation iteration
+    maxIter     4;      // maximum number of iterations
 }
 
 // Number of flow iterations per radiation iteration
diff --git a/tutorials/combustion/fireFoam/LES/smallPoolFire3D/constant/radiationProperties b/tutorials/combustion/fireFoam/LES/smallPoolFire3D/constant/radiationProperties
index d7a5e81b9..55b52ef93 100644
--- a/tutorials/combustion/fireFoam/LES/smallPoolFire3D/constant/radiationProperties
+++ b/tutorials/combustion/fireFoam/LES/smallPoolFire3D/constant/radiationProperties
@@ -22,10 +22,10 @@ radiationModel  fvDOM;
 
 fvDOMCoeffs
 {
-    nPhi        2;          // azimuthal angles in PI/2 on X-Y.(from Y to X)
-    nTheta      2;          // polar angles in PI (from Z to X-Y plane)
-    convergence 1e-1;       // convergence criteria for radiation iteration
-    maxIter     1;          // maximum number of iterations
+    nPhi        2;      // azimuthal angles in PI/2 on X-Y.(from Y to X)
+    nTheta      2;      // polar angles in PI (from Z to X-Y plane)
+    tolerance   1e-1;   // convergence tolerance for radiation iteration
+    maxIter     1;      // maximum number of iterations
 }
 
 // Number of flow iterations per radiation iteration
diff --git a/tutorials/heatTransfer/buoyantSimpleFoam/hotRadiationRoomFvDOM/constant/radiationProperties b/tutorials/heatTransfer/buoyantSimpleFoam/hotRadiationRoomFvDOM/constant/radiationProperties
index 0c47e3668..ef9968ae5 100644
--- a/tutorials/heatTransfer/buoyantSimpleFoam/hotRadiationRoomFvDOM/constant/radiationProperties
+++ b/tutorials/heatTransfer/buoyantSimpleFoam/hotRadiationRoomFvDOM/constant/radiationProperties
@@ -21,10 +21,10 @@ radiationModel  fvDOM;
 
 fvDOMCoeffs
 {
-    nPhi        3;          // azimuthal angles in PI/2 on X-Y.(from Y to X)
-    nTheta      5;          // polar angles in PI (from Z to X-Y plane)
-    convergence 1e-3;   // convergence criteria for radiation iteration
-    maxIter     10;         // maximum number of iterations
+    nPhi        3;      // azimuthal angles in PI/2 on X-Y.(from Y to X)
+    nTheta      5;      // polar angles in PI (from Z to X-Y plane)
+    tolerance   1e-3;   // convergence tolerance for radiation iteration
+    maxIter     10;     // maximum number of iterations
 }
 
 // Number of flow iterations per radiation iteration