From a3327b3761355863ceb400a4b367634a6c8f4df3 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 21 Aug 2018 12:53:29 +0100
Subject: [PATCH] STYLE: runTimeControl FO conditions - refactor to use the Log
 macro

---
 .../averageCondition/averageCondition.C          |  4 ++--
 .../averageCondition/averageConditionTemplates.C |  7 ++-----
 .../equationInitialResidualCondition.C           | 16 +++++-----------
 .../equationMaxIterCondition.C                   | 16 +++++-----------
 .../maxDurationCondition/maxDurationCondition.C  |  3 +++
 .../minMaxCondition/minMaxCondition.C            | 11 ++++-------
 .../runTimeCondition/runTimeCondition.C          |  4 ++--
 .../runTimeCondition/runTimeCondition.H          |  8 +++++---
 8 files changed, 28 insertions(+), 41 deletions(-)

diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
index 0c66af7fb0..59405f6dcc 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
@@ -116,7 +116,7 @@ bool Foam::functionObjects::runTimeControls::averageCondition::apply()
 
     const scalar dt = obr_.time().deltaTValue();
 
-    if (log_) Info<< "    " << type() << ": " << name_ << " averages:" << nl;
+    Log << "    " << type() << ": " << name_ << " averages:" << nl;
 
     DynamicList<label> unprocessedFields(fieldNames_.size());
 
@@ -149,7 +149,7 @@ bool Foam::functionObjects::runTimeControls::averageCondition::apply()
         }
     }
 
-    if (log_) Info<< endl;
+    Log << endl;
 
     return satisfied;
 }
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C
index 1631bd43fb..6a651f3f2e 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C
@@ -159,11 +159,8 @@ void Foam::functionObjects::runTimeControls::averageCondition::calc
 
     scalar delta = mag(meanValue - currentValue);
 
-    if (log_)
-    {
-        Info<< "        " << meanName << ": " << meanValue
-            << ", delta: " << delta << nl;
-    }
+    Log << "        " << meanName << ": " << meanValue
+        << ", delta: " << delta << nl;
 
     // Note: Writing result to owner function object and not the local run-time
     // condition
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
index 0ad3bf5879..050e598434 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
@@ -183,24 +183,18 @@ apply()
 
     if (satisfied && valid)
     {
-        if (log_)
-        {
-            Info<< type() << ": " << name_
-                << ": satisfied using threshold value: " << value_ << nl;
-        }
+        Log << type() << ": " << name_
+            << ": satisfied using threshold value: " << value_ << nl;
 
         forAll(result, resulti)
         {
             if (result[resulti] > 0)
             {
-                if (log_)
-                {
-                    Info<< "    field: " << fieldNames_[resulti]
-                        << ", residual: " << result[resulti] << nl;
-                }
+                Log << "    field: " << fieldNames_[resulti]
+                    << ", residual: " << result[resulti] << nl;
             }
         }
-        if (log_) Info<< endl;
+        Log << endl;
     }
 
     return satisfied;
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C
index deed871bda..d01ab02f97 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C
@@ -141,24 +141,18 @@ bool Foam::functionObjects::runTimeControls::equationMaxIterCondition::apply()
 
     if (satisfied && valid)
     {
-        if (log_)
-        {
-            Info<< type() << ": " << name_
-                << ": satisfied using threshold value: " << threshold_ << nl;
-        }
+        Log << type() << ": " << name_
+            << ": satisfied using threshold value: " << threshold_ << nl;
 
         forAll(result, resulti)
         {
             if (result[resulti] != -1)
             {
-                if (log_)
-                {
-                    Info<< "    field: " << fieldNames_[resulti]
-                        << ", iterations: " << result[resulti] << nl;
-                }
+                Log << "    field: " << fieldNames_[resulti]
+                    << ", iterations: " << result[resulti] << nl;
             }
         }
-        if (log_) Info<< endl;
+        Log << endl;
     }
 
     return satisfied;
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C
index 86f955cb74..f867ea09ea 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C
@@ -94,6 +94,9 @@ bool Foam::functionObjects::runTimeControls::maxDurationCondition::apply()
     scalar delta = obr_.time().value() - startTime_;
     delta = obr_.time().timeToUserTime(delta);
 
+    Log << "    " << type() << ": " << name_ << nl
+        << "        Completed " << delta << " out of " << duration_ << nl;
+
     return delta >= duration_;
 }
 
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
index 72a1fee939..475a2a5bb6 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
@@ -145,13 +145,10 @@ bool Foam::functionObjects::runTimeControls::minMaxCondition::apply()
             }
         }
 
-        if (log_)
-        {
-            Info<< "    " << type() << ": " << modeTypeNames_[mode_] << " "
-                << fieldName << ": value = " << v
-                << ", threshold value = " << value_
-                << ", satisfied = " << ok << endl;
-        }
+        Log << "    " << type() << ": " << modeTypeNames_[mode_] << " "
+            << fieldName << ": value = " << v
+            << ", threshold value = " << value_
+            << ", satisfied = " << ok << endl;
 
         satisfied = satisfied && ok;
     }
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C
index 5573f54761..83148d7ab2 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C
@@ -84,8 +84,8 @@ Foam::functionObjects::runTimeControls::runTimeCondition::runTimeCondition
     state_(state),
     active_(dict.lookupOrDefault("active", true)),
     conditionDict_(setConditionDict()),
-    log_(dict.lookupOrDefault("log", true)),
-    groupID_(dict.lookupOrDefault("groupID", -1))
+    groupID_(dict.lookupOrDefault("groupID", -1)),
+    log(dict.lookupOrDefault("log", true))
 {}
 
 
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H
index a9168b82cd..60cd98ffb2 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H
@@ -78,9 +78,6 @@ protected:
         //- Reference to the condition dictionary
         dictionary& conditionDict_;
 
-        //- Switch to send output to Info
-        Switch log_;
-
         //- Group index - if applied, all conditions in a group must be
         //  satisfied before condition is met
         label groupID_;
@@ -140,6 +137,11 @@ public:
         stateFunctionObject& state
     );
 
+    // Public Data
+
+        //- Switch to send output to Info
+        Switch log;
+
 
     // Public Member Functions