From 21d2d7e6c31b3811b77b8276f099f8d3589627e1 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Thu, 16 Aug 2018 12:44:33 +0100
Subject: [PATCH 01/19] ENH: Initial implementation for FO activation by
 trigger

---
 .../functionObjectList/functionObjectList.C   |  9 +++
 .../functionObjectList/functionObjectList.H   |  3 +
 .../stateFunctionObject/stateFunctionObject.C | 28 +++++++
 .../stateFunctionObject/stateFunctionObject.H |  6 ++
 .../timeControl/timeControlFunctionObject.C   | 17 ++++-
 .../timeControl/timeControlFunctionObject.H   |  6 ++
 .../utilities/runTimeControl/runTimeControl.C | 74 +++++++++++++------
 .../utilities/runTimeControl/runTimeControl.H | 25 ++++++-
 8 files changed, 142 insertions(+), 26 deletions(-)

diff --git a/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.C b/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.C
index baafa87b74..879d6bbd79 100644
--- a/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.C
+++ b/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.C
@@ -458,6 +458,15 @@ Foam::autoPtr<Foam::functionObjectList> Foam::functionObjectList::New
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
+Foam::label Foam::functionObjectList::triggerIndex() const
+{
+    label triggeri = labelMin;
+    stateDict().readIfPresent("triggerIndex", triggeri);
+
+    return triggeri;
+}
+
+
 void Foam::functionObjectList::resetState()
 {
     // Reset (re-read) the state dictionary
diff --git a/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H b/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H
index 6be997b516..5cb135612f 100644
--- a/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H
+++ b/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H
@@ -174,6 +174,9 @@ public:
         //- Access to the functionObjects
         using PtrList<functionObject>::operator[];
 
+        //- Return the current trigger index (read from the stateDict)
+        label triggerIndex() const;
+
         //- Reset/read state dictionary for current time
         void resetState();
 
diff --git a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
index 1bfe099f0a..04768c89eb 100644
--- a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
+++ b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
@@ -78,6 +78,34 @@ Foam::dictionary& Foam::functionObjects::stateFunctionObject::propertyDict()
 }
 
 
+bool Foam::functionObjects::stateFunctionObject::setTrigger
+(
+    const label triggeri
+)
+{
+    IOdictionary& stateDict = this->stateDict();
+
+    label oldTriggeri =
+        stateDict.lookupOrDefault<label>("triggerIndex", labelMin);
+
+    if (triggeri > oldTriggeri)
+    {
+        stateDict.set("triggerIndex", triggeri);
+        return true;
+    }
+
+    return false;
+}
+
+
+Foam::label Foam::functionObjects::stateFunctionObject::getTrigger() const
+{
+    const IOdictionary& stateDict = this->stateDict();
+
+    return stateDict.lookupOrDefault<label>("triggerIndex", labelMin);
+}
+
+
 bool Foam::functionObjects::stateFunctionObject::foundProperty
 (
     const word& entryName
diff --git a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.H b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.H
index 5cab13a16d..0511c16734 100644
--- a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.H
+++ b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.H
@@ -125,6 +125,12 @@ public:
             //- Return true if the property exists
             bool foundProperty(const word& entryName) const;
 
+            //- Get the current trigger index
+            label getTrigger() const;
+
+            //- Set the current trigger index
+            bool setTrigger(const label triggeri);
+
             //- Set dictionary, return true if set
             bool getDict
             (
diff --git a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.C b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.C
index e31be0ce22..988a0464c4 100644
--- a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.C
+++ b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.C
@@ -51,6 +51,10 @@ void Foam::functionObjects::timeControl::readControls()
     {
         timeEnd_ = time_.userTimeToTime(timeEnd_);
     }
+
+    dict_.readIfPresent("triggerStart", triggerStart_);
+    dict_.readIfPresent("triggerEnd", triggerEnd_);
+
     deltaTCoeff_ = GREAT;
     if (dict_.readIfPresent("deltaTCoeff", deltaTCoeff_))
     {
@@ -70,9 +74,14 @@ void Foam::functionObjects::timeControl::readControls()
 
 bool Foam::functionObjects::timeControl::active() const
 {
+    label triggeri = time_.functionObjects().triggerIndex();
+
     return
-        time_.value() >= (timeStart_ - 0.5*time_.deltaTValue())
-     && time_.value() <= (timeEnd_ + 0.5*time_.deltaTValue());
+        (triggeri >= triggerStart_)
+     || (
+            time_.value() >= (timeStart_ - 0.5*time_.deltaTValue())
+         && time_.value() <= (timeEnd_ + 0.5*time_.deltaTValue())
+    );
 }
 
 
@@ -403,6 +412,8 @@ Foam::functionObjects::timeControl::timeControl
     dict_(dict),
     timeStart_(-VGREAT),
     timeEnd_(VGREAT),
+    triggerStart_(labelMin),
+    triggerEnd_(labelMax),
     nStepsToStartTimeChange_(labelMax),
     executeControl_(t, dict, "execute"),
     writeControl_(t, dict, "write"),
@@ -426,6 +437,8 @@ bool Foam::functionObjects::timeControl::entriesPresent(const dictionary& dict)
      || Foam::timeControl::entriesPresent(dict, "execute")
      || dict.found("timeStart")
      || dict.found("timeEnd")
+     || dict.found("triggerStart")
+     || dict.found("triggerEnd")
     )
     {
         return true;
diff --git a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H
index 38e657b98e..679e59f92d 100644
--- a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H
+++ b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H
@@ -92,6 +92,12 @@ class timeControl
             //- De-activation time - defaults to VGREAT
             scalar timeEnd_;
 
+            //- Activation trigger index - defaults to labelMin
+            label triggerStart_;
+
+            //- De-activation trigger index - defaults to labelMax
+            label triggerEnd_;
+
             //- Max time step change
             scalar deltaTCoeff_;
 
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.C b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
index 96e040c5b4..43e768e75f 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2015-2016 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2015-2018 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -58,7 +58,9 @@ Foam::functionObjects::runTimeControls::runTimeControl::runTimeControl
     conditions_(),
     groupMap_(),
     nWriteStep_(0),
-    writeStepI_(0)
+    writeStepI_(0),
+    satisfiedAction_(satisfiedAction::end),
+    triggerIndex_(labelMin)
 {
     read(dict);
 }
@@ -99,7 +101,7 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::read
 
         if (groupMap_.insert(groupi, uniqueGroupi))
         {
-            uniqueGroupi++;
+            ++uniqueGroupi;
         }
     }
 
@@ -116,9 +118,9 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::read
     {
         // Check that at least one condition is active
         bool active = false;
-        forAll(conditions_, conditioni)
+        for (const auto& condition : conditions_)
         {
-            if (conditions_[conditioni].active())
+            if (condition.active())
             {
                 active = true;
                 break;
@@ -133,6 +135,21 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::read
         }
     }
 
+    // Set the action to perform when all conditions are satisfied
+    // - set to end fro backwards compatibility with v1806
+    satisfiedAction_ =
+        satisfiedActionNames.lookupOrDefault
+        (
+            "satisfiedAction",
+            dict,
+            satisfiedAction::end
+        );
+
+    if (satisfiedAction_ == satisfiedAction::setTrigger)
+    {
+        triggerIndex_ = readLabel(dict.lookup("trigger"));
+    }
+
     return true;
 }
 
@@ -200,28 +217,39 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
 
     if (done)
     {
-        forAll(IDs, conditioni)
+        for (label conditioni : IDs)
         {
             Info<< "    " << conditions_[conditioni].type() << ": "
-                <<  conditions_[conditioni].name()
+                << conditions_[conditioni].name()
                 << " condition satisfied" << nl;
         }
 
-
-        // Set to write a data dump or finalise the calculation
-        Time& time = const_cast<Time&>(time_);
-
-        if (writeStepI_ < nWriteStep_ - 1)
+        switch (satisfiedAction_)
         {
-            writeStepI_++;
-            Info<< "    Writing fields - step " << writeStepI_ << nl;
-            time.writeNow();
-        }
-        else
-        {
-            Info<< "    Stopping calculation" << nl
-                << "    Writing fields - final step" << nl;
-            time.writeAndEnd();
+            case satisfiedAction::end:
+            {
+                // Set to write a data dump or finalise the calculation
+                Time& time = const_cast<Time&>(time_);
+
+                if (writeStepI_ < nWriteStep_ - 1)
+                {
+                    ++writeStepI_;
+                    Info<< "    Writing fields - step " << writeStepI_ << nl;
+                    time.writeNow();
+                }
+                else
+                {
+                    Info<< "    Stopping calculation" << nl
+                        << "    Writing fields - final step" << nl;
+                    time.writeAndEnd();
+                    break;
+                }
+            }
+            case satisfiedAction::setTrigger:
+            {
+                setTrigger(triggerIndex_);
+                break;
+            }
         }
     }
     else
@@ -237,9 +265,9 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
 
 bool Foam::functionObjects::runTimeControls::runTimeControl::write()
 {
-    forAll(conditions_, conditioni)
+    for (auto& condition : conditions_)
     {
-        conditions_[conditioni].write();
+        condition.write();
     }
 
     return true;
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.H b/src/functionObjects/utilities/runTimeControl/runTimeControl.H
index e3367ebbe6..8cd0037095 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.H
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2015-2016 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2016- OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -45,6 +45,7 @@ SourceFiles
 
 #include "fvMeshFunctionObject.H"
 #include "Map.H"
+#include "Enum.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
@@ -66,6 +67,21 @@ class runTimeControl
 :
     public fvMeshFunctionObject
 {
+public:
+
+    // Public enumerations
+
+        enum class satisfiedAction
+        {
+            end,
+            setTrigger
+        };
+
+        static Enum<satisfiedAction> satisfiedActionNames;
+
+
+private:
+
     // Private data
 
         //- List of conditions to satisfy
@@ -80,6 +96,13 @@ class runTimeControl
         //- Current number of steps written
         label writeStepI_;
 
+        //- Action to take when conditions are satified
+        satisfiedAction satisfiedAction_;
+
+        //- Trigger index if satisfiedAction is setTrigger
+        label triggerIndex_;
+
+
 
     // Private Member Functions
 

From 8b387961d958b9d4d25ecfbc2fcc2f24af599467 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Fri, 17 Aug 2018 16:52:11 +0100
Subject: [PATCH 02/19] ENH: run-time control clean-up

---
 .../stateFunctionObject/stateFunctionObject.C |  4 +--
 .../averageCondition/averageCondition.C       |  9 +------
 .../averageCondition/averageCondition.H       |  2 +-
 .../equationInitialResidualCondition.C        |  7 -----
 .../equationInitialResidualCondition.H        |  2 +-
 .../equationMaxIterCondition.C                |  7 -----
 .../equationMaxIterCondition.H                |  2 +-
 .../minMaxCondition/minMaxCondition.C         | 10 +------
 .../minMaxCondition/minMaxCondition.H         |  2 +-
 .../minTimeStepCondition.C                    |  7 -----
 .../minTimeStepCondition.H                    |  2 +-
 .../runTimeCondition/runTimeCondition.C       |  6 -----
 .../runTimeCondition/runTimeCondition.H       |  2 +-
 .../utilities/runTimeControl/runTimeControl.C | 27 +++++++++++--------
 .../utilities/runTimeControl/runTimeControl.H | 15 ++++++-----
 15 files changed, 35 insertions(+), 69 deletions(-)

diff --git a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
index 04768c89eb..9659fa2deb 100644
--- a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
+++ b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
@@ -205,8 +205,8 @@ Foam::functionObjects::stateFunctionObject::objectResultEntries() const
 }
 
 
-Foam::List<Foam::word> Foam::functionObjects::stateFunctionObject::
-objectResultEntries
+Foam::List<Foam::word>
+Foam::functionObjects::stateFunctionObject::objectResultEntries
 (
     const word& objectName
 ) const
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
index a4dc98cf61..0b3951bf99 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
@@ -78,12 +78,6 @@ Foam::functionObjects::runTimeControls::averageCondition::averageCondition
 }
 
 
-// * * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * //
-
-Foam::functionObjects::runTimeControls::averageCondition::~averageCondition()
-{}
-
-
 // * * * * * * * * * * * * * * Public Member Functions * * * * * * * * * * * //
 
 bool Foam::functionObjects::runTimeControls::averageCondition::apply()
@@ -145,9 +139,8 @@ bool Foam::functionObjects::runTimeControls::averageCondition::apply()
             << "From function object: " << functionObjectName_ << nl
             << "Unprocessed fields:" << nl;
 
-        forAll(unprocessedFields, i)
+        for (const label fieldi : unprocessedFields)
         {
-            label fieldi = unprocessedFields[i];
             Info<< "        " << fieldNames_[fieldi] << nl;
         }
     }
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
index f76163edca..5c647b2981 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
@@ -110,7 +110,7 @@ public:
     );
 
     //- Destructor
-    virtual ~averageCondition();
+    virtual ~averageCondition() = default;
 
 
     // Public Member Functions
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
index ac86c8313e..0ad3bf5879 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
@@ -95,13 +95,6 @@ equationInitialResidualCondition
 }
 
 
-// * * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * //
-
-Foam::functionObjects::runTimeControls::equationInitialResidualCondition::
-~equationInitialResidualCondition()
-{}
-
-
 // * * * * * * * * * * * * * * Public Member Functions * * * * * * * * * * * //
 
 bool Foam::functionObjects::runTimeControls::equationInitialResidualCondition::
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
index 849342ad55..fa0ca263b1 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
@@ -99,7 +99,7 @@ public:
     );
 
     //- Destructor
-    virtual ~equationInitialResidualCondition();
+    virtual ~equationInitialResidualCondition() = default;
 
 
     // Public Member Functions
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C
index 874c96a6ab..deed871bda 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C
@@ -76,13 +76,6 @@ equationMaxIterCondition
 }
 
 
-// * * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * //
-
-Foam::functionObjects::runTimeControls::equationMaxIterCondition::
-~equationMaxIterCondition()
-{}
-
-
 // * * * * * * * * * * * * * * Public Member Functions * * * * * * * * * * * //
 
 bool Foam::functionObjects::runTimeControls::equationMaxIterCondition::apply()
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.H
index d3538c22c7..f5595d8e82 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.H
@@ -84,7 +84,7 @@ public:
     );
 
     //- Destructor
-    virtual ~equationMaxIterCondition();
+    virtual ~equationMaxIterCondition() = default;
 
 
     // Public Member Functions
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
index 9042fcc4d7..72a1fee939 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
@@ -90,12 +90,6 @@ Foam::functionObjects::runTimeControls::minMaxCondition::minMaxCondition
 {}
 
 
-// * * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * //
-
-Foam::functionObjects::runTimeControls::minMaxCondition::~minMaxCondition()
-{}
-
-
 // * * * * * * * * * * * * * * Public Member Functions * * * * * * * * * * * //
 
 bool Foam::functionObjects::runTimeControls::minMaxCondition::apply()
@@ -107,10 +101,8 @@ bool Foam::functionObjects::runTimeControls::minMaxCondition::apply()
         return satisfied;
     }
 
-    forAll(fieldNames_, fieldi)
+    for (const word& fieldName :fieldNames_)
     {
-        const word& fieldName = fieldNames_[fieldi];
-
         const word valueType =
             state_.objectResultType(functionObjectName_, fieldName);
 
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H
index ef95f935cd..f6c177ba7f 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H
@@ -112,7 +112,7 @@ public:
     );
 
     //- Destructor
-    virtual ~minMaxCondition();
+    virtual ~minMaxCondition() = default;
 
 
     // Public Member Functions
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.C
index 50b05b611e..17f5facdd8 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.C
@@ -63,13 +63,6 @@ minTimeStepCondition
 {}
 
 
-// * * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * //
-
-Foam::functionObjects::runTimeControls::minTimeStepCondition::
-~minTimeStepCondition()
-{}
-
-
 // * * * * * * * * * * * * * * Public Member Functions * * * * * * * * * * * //
 
 bool Foam::functionObjects::runTimeControls::minTimeStepCondition::apply()
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.H
index 7b406a9857..45fbdd90a8 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.H
@@ -78,7 +78,7 @@ public:
     );
 
     //- Destructor
-    virtual ~minTimeStepCondition();
+    virtual ~minTimeStepCondition() = default;
 
 
     // Public Member Functions
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C
index 1214378d0d..5573f54761 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C
@@ -89,12 +89,6 @@ Foam::functionObjects::runTimeControls::runTimeCondition::runTimeCondition
 {}
 
 
-// * * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * //
-
-Foam::functionObjects::runTimeControls::runTimeCondition::~runTimeCondition()
-{}
-
-
 // * * * * * * * * * * * * * * Public Member Functions * * * * * * * * * * * //
 
 const Foam::word&
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H
index 53627de320..a9168b82cd 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H
@@ -129,7 +129,7 @@ public:
     );
 
     //- Destructor
-    virtual ~runTimeCondition();
+    virtual ~runTimeCondition() = default;
 
     //- Selector
     static autoPtr<runTimeCondition> New
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.C b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
index 43e768e75f..06621c839f 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
@@ -60,18 +60,13 @@ Foam::functionObjects::runTimeControls::runTimeControl::runTimeControl
     nWriteStep_(0),
     writeStepI_(0),
     satisfiedAction_(satisfiedAction::end),
-    triggerIndex_(labelMin)
+    triggerIndex_(labelMin),
+    active_(getObjectProperty(name, "active", true))
 {
     read(dict);
 }
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::functionObjects::runTimeControls::runTimeControl::~runTimeControl()
-{}
-
-
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 bool Foam::functionObjects::runTimeControls::runTimeControl::read
@@ -117,17 +112,17 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::read
     else
     {
         // Check that at least one condition is active
-        bool active = false;
+        bool check = false;
         for (const auto& condition : conditions_)
         {
             if (condition.active())
             {
-                active = true;
+                check = true;
                 break;
             }
         }
 
-        if (!active)
+        if (!check)
         {
             Info<< type() << " " << name() << " output:" << nl
                 << "    All conditions are inactive" << nl
@@ -156,6 +151,11 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::read
 
 bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
 {
+    if (!active_)
+    {
+        return true;
+    }
+
     Info<< type() << " " << name() << " output:" << nl;
 
     // IDs of satisfied conditions
@@ -242,12 +242,17 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
                     Info<< "    Stopping calculation" << nl
                         << "    Writing fields - final step" << nl;
                     time.writeAndEnd();
-                    break;
                 }
+                break;
             }
             case satisfiedAction::setTrigger:
             {
+                Info<< "    Setting trigger " << triggerIndex_ << nl;
                 setTrigger(triggerIndex_);
+
+                // Deactivate the model
+                active_ = false;
+                setProperty("active", active_);
                 break;
             }
         }
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.H b/src/functionObjects/utilities/runTimeControl/runTimeControl.H
index 8cd0037095..91e3ce7763 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.H
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2015-2016 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2016- OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2016-2018 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -32,7 +32,7 @@ Description
     user-specified conditions.
 
     Optionally specify a number of write steps before the calculation is
-    terminated.  Here, a write is performed each time that all conditons are
+    terminated.  Here, a write is performed each time that all conditions are
     satisfied.
 
 SourceFiles
@@ -96,12 +96,16 @@ private:
         //- Current number of steps written
         label writeStepI_;
 
-        //- Action to take when conditions are satified
+        //- Action to take when conditions are satisfied
         satisfiedAction satisfiedAction_;
 
         //- Trigger index if satisfiedAction is setTrigger
         label triggerIndex_;
 
+        //- Active flag
+        //  Used in the trigger case to bypass any evaluations after the
+        //  trigger has been set
+        bool active_;
 
 
     // Private Member Functions
@@ -121,8 +125,7 @@ public:
 
     // Constructors
 
-        //- Construct for given objectRegistry and dictionary.
-        //  Allow the possibility to load fields from files
+        //- Construct for given objectRegistry and dictionary
         runTimeControl
         (
             const word& name,
@@ -132,7 +135,7 @@ public:
 
 
     //- Destructor
-    virtual ~runTimeControl();
+    virtual ~runTimeControl() = default;
 
 
     // Member Functions

From e64a87cd8e3531a4e4e74e2b0fcd6d078b4bc79a Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 20 Aug 2018 14:03:57 +0100
Subject: [PATCH 03/19] ENH: runTimeControl FO - added exact window averaging
 to the averageCondition

---
 .../averageCondition/averageCondition.C       |  81 ++++++------
 .../averageCondition/averageCondition.H       |  25 +++-
 .../averageConditionTemplates.C               | 120 +++++++++++++++++-
 3 files changed, 176 insertions(+), 50 deletions(-)

diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
index 0b3951bf99..0c66af7fb0 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
@@ -41,6 +41,17 @@ namespace runTimeControls
 }
 }
 
+const Foam::Enum
+<
+    Foam::functionObjects::runTimeControls::averageCondition::windowType
+>
+Foam::functionObjects::runTimeControls::averageCondition::windowTypeNames
+{
+    { windowType::NONE, "none" },
+    { windowType::APPROXIMATE, "approximate" },
+    { windowType::EXACT, "exact" }
+};
+
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
@@ -57,21 +68,35 @@ Foam::functionObjects::runTimeControls::averageCondition::averageCondition
     fieldNames_(dict.get<wordList>("fields")),
     tolerance_(dict.get<scalar>("tolerance")),
     window_(dict.lookupOrDefault<scalar>("window", -1)),
-    totalTime_(fieldNames_.size(), obr_.time().deltaTValue()),
-    resetOnRestart_(false)
+    windowType_
+    (
+        window_ > 0 ?
+            windowTypeNames.read(dict.lookup("windowType"))
+          : windowType::NONE
+    ),
+    totalTime_(fieldNames_.size(), scalar(0)),
+    resetOnRestart_(dict.lookupOrDefault<bool>("resetOnRestart", false))
 {
-    if (resetOnRestart_)
+    dictionary& conditionDict = this->conditionDict();
+
+    forAll(fieldNames_, fieldi)
     {
-        const dictionary& dict = conditionDict();
+        const word& fieldName = fieldNames_[fieldi];
 
-        forAll(fieldNames_, fieldi)
+        if (resetOnRestart_)
         {
-            const word& fieldName = fieldNames_[fieldi];
-
-            if (dict.found(fieldName))
+            conditionDict.set(fieldName, dictionary());
+        }
+        else
+        {
+            if (conditionDict.found(fieldName))
             {
-                const dictionary& valueDict = dict.subDict(fieldName);
-                valueDict.readEntry("totalTime", totalTime_[fieldi]);
+                const dictionary& valueDict = conditionDict.subDict(fieldName);
+                valueDict.readIfPresent("totalTime", totalTime_[fieldi]);
+            }
+            else
+            {
+                conditionDict.set(fieldName, dictionary());
             }
         }
     }
@@ -89,7 +114,7 @@ bool Foam::functionObjects::runTimeControls::averageCondition::apply()
         return satisfied;
     }
 
-    scalar dt = obr_.time().deltaTValue();
+    const scalar dt = obr_.time().deltaTValue();
 
     if (log_) Info<< "    " << type() << ": " << name_ << " averages:" << nl;
 
@@ -97,40 +122,19 @@ bool Foam::functionObjects::runTimeControls::averageCondition::apply()
 
     forAll(fieldNames_, fieldi)
     {
-        const word& fieldName(fieldNames_[fieldi]);
-
-        scalar Dt = totalTime_[fieldi];
-        scalar alpha = (Dt - dt)/Dt;
-        scalar beta = dt/Dt;
-
-        if (window_ > 0)
-        {
-            if (Dt - dt >= window_)
-            {
-                alpha = (window_ - dt)/window_;
-                beta = dt/window_;
-            }
-            else
-            {
-                // Ensure that averaging is performed over window time
-                // before condition can be satisfied
-                satisfied = false;
-            }
-        }
+        totalTime_[fieldi] += dt;
 
         bool processed = false;
-        calc<scalar>(fieldName, alpha, beta, satisfied, processed);
-        calc<vector>(fieldName, alpha, beta, satisfied, processed);
-        calc<sphericalTensor>(fieldName, alpha, beta, satisfied, processed);
-        calc<symmTensor>(fieldName, alpha, beta, satisfied, processed);
-        calc<tensor>(fieldName, alpha, beta, satisfied, processed);
+        calc<scalar>(fieldi, satisfied, processed);
+        calc<vector>(fieldi, satisfied, processed);
+        calc<sphericalTensor>(fieldi, satisfied, processed);
+        calc<symmTensor>(fieldi, satisfied, processed);
+        calc<tensor>(fieldi, satisfied, processed);
 
         if (!processed)
         {
             unprocessedFields.append(fieldi);
         }
-
-        totalTime_[fieldi] += dt;
     }
 
     if (unprocessedFields.size())
@@ -159,7 +163,6 @@ void Foam::functionObjects::runTimeControls::averageCondition::write()
     {
         const word& fieldName = fieldNames_[fieldi];
 
-        // value dictionary should be present - mean values are written there
         if (conditionDict.found(fieldName))
         {
             dictionary& valueDict = conditionDict.subDict(fieldName);
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
index 5c647b2981..c295602515 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2016-2018 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -39,7 +39,7 @@ SourceFiles
 
 #include "runTimeCondition.H"
 #include "Switch.H"
-
+#include "Enum.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
@@ -58,6 +58,20 @@ class averageCondition
 :
     public runTimeCondition
 {
+public:
+
+    // Public enumerations
+
+        enum class windowType
+        {
+            NONE,
+            APPROXIMATE,
+            EXACT
+        };
+
+        static const Enum<windowType> windowTypeNames;
+
+
 protected:
 
     // Protected data
@@ -74,6 +88,9 @@ protected:
         //- Averaging window
         const scalar window_;
 
+        //- Averaging window type
+        windowType windowType_;
+
         //- Average time per field
         List<scalar> totalTime_;
 
@@ -87,9 +104,7 @@ protected:
         template<class Type>
         void calc
         (
-            const word& fieldName,
-            const scalar alpha,
-            const scalar beta,
+            const label fieldi,
             bool& satisfied,
             bool& processed
         );
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C
index 9b0b134987..1631bd43fb 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C
@@ -23,18 +23,21 @@ License
 
 \*---------------------------------------------------------------------------*/
 
+#include "Time.H"
+#include "FIFOStack.H"
+
 // * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
 
 template<class Type>
 void Foam::functionObjects::runTimeControls::averageCondition::calc
 (
-    const word& fieldName,
-    const scalar alpha,
-    const scalar beta,
+    const label fieldi,
     bool& satisfied,
     bool& processed
 )
 {
+    const word& fieldName = fieldNames_[fieldi];
+
     const word valueType =
         state_.objectResultType(functionObjectName_, fieldName);
 
@@ -43,13 +46,116 @@ void Foam::functionObjects::runTimeControls::averageCondition::calc
         return;
     }
 
-    Type currentValue =
-        state_.getObjectResult<Type>(functionObjectName_, fieldName);
+    const scalar dt = obr_.time().deltaTValue();
 
+    const Type currentValue =
+        state_.getObjectResult<Type>(functionObjectName_, fieldName);
     const word meanName(fieldName + "Mean");
 
+    // Current mean value
     Type meanValue = state_.getResult<Type>(meanName);
-    meanValue = alpha*meanValue + beta*currentValue;
+
+    switch (windowType_)
+    {
+        case windowType::NONE:
+        {
+            const scalar Dt = totalTime_[fieldi];
+            const scalar alpha = (Dt - dt)/Dt;
+            const scalar beta = dt/Dt;
+            meanValue = alpha*meanValue + beta*currentValue;
+
+            break;
+        }
+        case windowType::APPROXIMATE:
+        {
+            const scalar Dt = totalTime_[fieldi];
+            scalar alpha = (Dt - dt)/Dt;
+            scalar beta = dt/Dt;
+            if (Dt - dt >= window_)
+            {
+                alpha = (window_ - dt)/window_;
+                beta = dt/window_;
+            }
+            else
+            {
+                // Ensure that averaging is performed over window time
+                // before condition can be satisfied
+                satisfied = false;
+            }
+
+            meanValue = alpha*meanValue + beta*currentValue;
+            totalTime_[fieldi] += dt;
+            break;
+        }
+        case windowType::EXACT:
+        {
+            FIFOStack<scalar> windowTimes;
+            FIFOStack<Type> windowValues;
+            dictionary& dict = this->conditionDict().subDict(fieldName);
+            dict.readIfPresent("windowTimes", windowTimes);
+            dict.readIfPresent("windowValues", windowValues);
+
+            // Increment time for all existing values
+            for (scalar& dti : windowTimes)
+            {
+                dti += dt;
+            }
+
+            // Remove any values outside the window
+            bool removeValue = true;
+            while (removeValue && windowTimes.size())
+            {
+                removeValue = windowTimes.first() > window_;
+
+                if (removeValue)
+                {
+                    windowTimes.pop();
+                    windowValues.pop();
+                }
+            }
+
+            // Add the current value
+            windowTimes.push(dt);
+            windowValues.push(currentValue);
+
+            // Calculate the window average
+            typename FIFOStack<scalar>::const_iterator timeIter =
+                windowTimes.begin();
+            typename FIFOStack<Type>::const_iterator valueIter =
+                windowValues.begin();
+
+            meanValue = pTraits<Type>::zero;
+            Type valueOld(pTraits<Type>::zero);
+
+            for
+            (
+                label i = 0;
+                timeIter != windowTimes.end();
+                ++i, ++timeIter, ++valueIter
+            )
+            {
+                const Type& value = valueIter();
+                const scalar dt = timeIter();
+
+                meanValue += dt*value;
+
+                if (i)
+                {
+                    meanValue -= dt*valueOld;
+                }
+
+                valueOld = value;
+            }
+
+            meanValue /= windowTimes.first();
+
+            // Store the state information for the next step
+            dict.set("windowTimes", windowTimes);
+            dict.set("windowValues", windowValues);
+
+            break;
+        }
+    }
 
     scalar delta = mag(meanValue - currentValue);
 
@@ -59,6 +165,8 @@ void Foam::functionObjects::runTimeControls::averageCondition::calc
             << ", delta: " << delta << nl;
     }
 
+    // Note: Writing result to owner function object and not the local run-time
+    // condition
     state_.setResult(meanName, meanValue);
 
     if (delta > tolerance_)

From bd79f1d5ab9ecbbed2804ca3fd2fb2d23eb46a97 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 20 Aug 2018 14:04:27 +0100
Subject: [PATCH 04/19] ENH: runTimeControl FO - added new maxDuration
 condition

---
 src/functionObjects/utilities/Make/files      |   1 +
 .../maxDurationCondition.C                    | 110 +++++++++++++++++
 .../maxDurationCondition.H                    | 113 ++++++++++++++++++
 3 files changed, 224 insertions(+)
 create mode 100644 src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C
 create mode 100644 src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.H

diff --git a/src/functionObjects/utilities/Make/files b/src/functionObjects/utilities/Make/files
index 4390ef6bf5..8a2d7f9e4b 100644
--- a/src/functionObjects/utilities/Make/files
+++ b/src/functionObjects/utilities/Make/files
@@ -17,6 +17,7 @@ runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C
 runTimeControl/runTimeCondition/runTimeCondition/runTimeConditionNew.C
 runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C
 runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
+runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C
 runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
 runTimeControl/runTimeCondition/averageCondition/averageCondition.C
 runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.C
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C
new file mode 100644
index 0000000000..86f955cb74
--- /dev/null
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C
@@ -0,0 +1,110 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "maxDurationCondition.H"
+#include "addToRunTimeSelectionTable.H"
+#include "Time.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+namespace runTimeControls
+{
+    defineTypeNameAndDebug(maxDurationCondition, 0);
+    addToRunTimeSelectionTable
+    (
+        runTimeCondition,
+        maxDurationCondition,
+        dictionary
+    );
+}
+}
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::runTimeControls::maxDurationCondition::
+maxDurationCondition
+(
+    const word& name,
+    const objectRegistry& obr,
+    const dictionary& dict,
+    stateFunctionObject& state
+)
+:
+    runTimeCondition(name, obr, dict, state),
+    duration_(dict.get<scalar>("duration")),
+    startTime_(-1),
+    initialised_(false),
+    resetOnRestart_(dict.lookupOrDefault("resetOnRestart", false))
+{
+    if
+    (
+        !resetOnRestart_
+     && conditionDict().readIfPresent("startTime", startTime_))
+    {
+        initialised_ = true;
+    }
+
+    duration_ = obr_.time().userTimeToTime(duration_);
+}
+
+
+// * * * * * * * * * * * * * * Public Member Functions * * * * * * * * * * * //
+
+bool Foam::functionObjects::runTimeControls::maxDurationCondition::apply()
+{
+    if (!active_)
+    {
+        return true;
+    }
+
+    if (!initialised_)
+    {
+        startTime_ = obr_.time().value();
+        initialised_ = true;
+    }
+
+    scalar delta = obr_.time().value() - startTime_;
+    delta = obr_.time().timeToUserTime(delta);
+
+    return delta >= duration_;
+}
+
+
+void Foam::functionObjects::runTimeControls::maxDurationCondition::write()
+{
+    if (initialised_)
+    {
+        conditionDict().set("startTime", startTime_);
+    }
+}
+
+
+// ************************************************************************* //
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.H
new file mode 100644
index 0000000000..e508e9304d
--- /dev/null
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.H
@@ -0,0 +1,113 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2018 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Class
+    Foam::functionObjects::runTimeControls::maxDurationCondition
+
+Description
+    Activated after a user-specified duration
+
+SourceFiles
+    maxDurationCondition.H
+    maxDurationCondition.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_runTimeConditions_maxDurationCondition_H
+#define functionObjects_runTimeConditions_maxDurationCondition_H
+
+#include "runTimeCondition.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+namespace runTimeControls
+{
+
+/*---------------------------------------------------------------------------*\
+                    Class maxDurationCondition Declaration
+\*---------------------------------------------------------------------------*/
+
+class maxDurationCondition
+:
+    public runTimeCondition
+{
+protected:
+
+    // Protected data
+
+        //- Duration
+        scalar duration_;
+
+        //- Time when the condition is activated
+        scalar startTime_;
+
+        //- Initialisation flag
+        bool initialised_;
+
+        //- Reset on restart (ignores any state information)
+        Switch resetOnRestart_;
+
+
+public:
+
+    //- Runtime type information
+    TypeName("maxDuration");
+
+    //- Constructor
+    maxDurationCondition
+    (
+        const word& name,
+        const objectRegistry& obr,
+        const dictionary& dict,
+        stateFunctionObject& state
+    );
+
+    //- Destructor
+    virtual ~maxDurationCondition() = default;
+
+
+    // Public Member Functions
+
+        //- Apply the condition
+        virtual bool apply();
+
+        //- Write
+        virtual void write();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace runTimeControls
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

From 7ffa7bb923c50ccbca41a1f686490c762e46c5a8 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 21 Jan 2019 10:58:39 +0000
Subject: [PATCH 05/19] ENH: stateFunctionObject - added helper functions to
 retrieve object result info

---
 .../stateFunctionObject/stateFunctionObject.C | 65 ++++++++++++++++++-
 .../stateFunctionObject/stateFunctionObject.H |  9 +++
 2 files changed, 73 insertions(+), 1 deletion(-)

diff --git a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
index 9659fa2deb..b716f50af7 100644
--- a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
+++ b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.C
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2015-2016 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2015-2019 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -238,5 +238,68 @@ Foam::functionObjects::stateFunctionObject::objectResultEntries
     return entries;
 }
 
+void Foam::functionObjects::stateFunctionObject::writeResultEntries
+(
+    Ostream& os
+) const
+{
+    writeResultEntries(name(), os);
+}
+
+
+void Foam::functionObjects::stateFunctionObject::writeResultEntries
+(
+    const word& objectName,
+    Ostream& os
+) const
+{
+    const IOdictionary& stateDict = this->stateDict();
+
+    if (stateDict.found(resultsName_))
+    {
+        const dictionary& resultsDict = stateDict.subDict(resultsName_);
+
+        if (resultsDict.found(objectName))
+        {
+            const dictionary& objectDict = resultsDict.subDict(objectName);
+
+            for (const word& dataFormat : objectDict.sortedToc())
+            {
+                os  << "    Type: " << dataFormat << nl;
+
+                const dictionary& resultDict = objectDict.subDict(dataFormat);
+
+                for (const word& result : resultDict.sortedToc())
+                {
+                    os << "        " << result << nl;
+                }
+            }
+        }
+    }
+}
+
+
+void Foam::functionObjects::stateFunctionObject::writeAllResultEntries
+(
+    Ostream& os
+) const
+{
+    const IOdictionary& stateDict = this->stateDict();
+
+    if (stateDict.found(resultsName_))
+    {
+        const dictionary& resultsDict = stateDict.subDict(resultsName_);
+
+        const wordList allObjectNames = resultsDict.sortedToc();
+
+        for (const word& objectName : allObjectNames)
+        {
+            os  << "Object: " << objectName << endl;
+
+            writeResultEntries(objectName, os);
+        }
+    }
+}
+
 
 // ************************************************************************* //
diff --git a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.H b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.H
index 0511c16734..32e51cd46e 100644
--- a/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.H
+++ b/src/OpenFOAM/db/functionObjects/stateFunctionObject/stateFunctionObject.H
@@ -250,6 +250,15 @@ public:
 
             //- Return result entries for named object
             List<word> objectResultEntries(const word& objectName) const;
+
+            //- Write the results entries for all objects to stream
+            void writeResultEntries(Ostream& os) const;
+
+            //- Write the results entries for named object to stream
+            void writeResultEntries(const word& objectName, Ostream& os) const;
+
+            //- Write the results entries for all objects to stream
+            void writeAllResultEntries(Ostream& os) const;
 };
 
 

From a3327b3761355863ceb400a4b367634a6c8f4df3 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 21 Aug 2018 12:53:29 +0100
Subject: [PATCH 06/19] 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
 

From ef615ed17fa7ecf03a3c8c746a4670d950ffcd67 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 21 Aug 2018 12:58:19 +0100
Subject: [PATCH 07/19] ENH: runTimeControl valueAverage condition - added
 start-up iterations option

---
 .../averageCondition/averageCondition.C          | 16 ++++++++++++----
 .../averageCondition/averageCondition.H          |  5 +++++
 2 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
index 59405f6dcc..f9c3e0a3d7 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
@@ -75,7 +75,9 @@ Foam::functionObjects::runTimeControls::averageCondition::averageCondition
           : windowType::NONE
     ),
     totalTime_(fieldNames_.size(), scalar(0)),
-    resetOnRestart_(dict.lookupOrDefault<bool>("resetOnRestart", false))
+    resetOnRestart_(dict.lookupOrDefault<bool>("resetOnRestart", false)),
+    nIterStartUp_(dict.lookupOrDefault<label>("nIterStartUp", 10)),
+    iter_(-1)
 {
     dictionary& conditionDict = this->conditionDict();
 
@@ -100,6 +102,8 @@ Foam::functionObjects::runTimeControls::averageCondition::averageCondition
             }
         }
     }
+
+    conditionDict.readIfPresent("iter", iter_);
 }
 
 
@@ -107,13 +111,15 @@ Foam::functionObjects::runTimeControls::averageCondition::averageCondition
 
 bool Foam::functionObjects::runTimeControls::averageCondition::apply()
 {
-    bool satisfied = true;
-
     if (!active_)
     {
-        return satisfied;
+        return true;
     }
 
+    bool satisfied = iter_ > nIterStartUp_ ? true : false;
+
+    ++iter_;
+
     const scalar dt = obr_.time().deltaTValue();
 
     Log << "    " << type() << ": " << name_ << " averages:" << nl;
@@ -175,6 +181,8 @@ void Foam::functionObjects::runTimeControls::averageCondition::write()
             conditionDict.add(fieldName, valueDict);
         }
     }
+
+    conditionDict.set("iter", iter_);
 }
 
 
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
index c295602515..355460c4a3 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
@@ -97,6 +97,11 @@ protected:
         //- Reset the averaging process on restart flag
         Switch resetOnRestart_;
 
+        //- Number of start-up iterations before allowing satisfied checks
+        label nIterStartUp_;
+
+        //- Current iteration count
+        label iter_;
 
     // Protected Member Functions
 

From 74dc8b3ce1661815a8540ba0d71ea57bef8222cc Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 21 Aug 2018 13:08:58 +0100
Subject: [PATCH 08/19] ENH: runTimeControl FO - added action for case that
 conditions are satisfied

---
 .../utilities/runTimeControl/runTimeControl.C | 30 +++++++++++++++----
 .../utilities/runTimeControl/runTimeControl.H |  4 +--
 2 files changed, 26 insertions(+), 8 deletions(-)

diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.C b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
index 06621c839f..0e263e8fff 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
@@ -44,6 +44,15 @@ namespace runTimeControls
 }
 }
 
+Foam::Enum
+<
+    Foam::functionObjects::runTimeControls::runTimeControl::satisfiedAction
+>
+Foam::functionObjects::runTimeControls::runTimeControl::satisfiedActionNames
+{
+    { satisfiedAction::END, "end"},
+    { satisfiedAction::SET_TRIGGER, "setTrigger"},
+};
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
@@ -59,7 +68,7 @@ Foam::functionObjects::runTimeControls::runTimeControl::runTimeControl
     groupMap_(),
     nWriteStep_(0),
     writeStepI_(0),
-    satisfiedAction_(satisfiedAction::end),
+    satisfiedAction_(satisfiedAction::END),
     triggerIndex_(labelMin),
     active_(getObjectProperty(name, "active", true))
 {
@@ -137,10 +146,10 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::read
         (
             "satisfiedAction",
             dict,
-            satisfiedAction::end
+            satisfiedAction::END
         );
 
-    if (satisfiedAction_ == satisfiedAction::setTrigger)
+    if (satisfiedAction_ == satisfiedAction::SET_TRIGGER)
     {
         triggerIndex_ = readLabel(dict.lookup("trigger"));
     }
@@ -226,7 +235,7 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
 
         switch (satisfiedAction_)
         {
-            case satisfiedAction::end:
+            case satisfiedAction::END:
             {
                 // Set to write a data dump or finalise the calculation
                 Time& time = const_cast<Time&>(time_);
@@ -240,12 +249,21 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
                 else
                 {
                     Info<< "    Stopping calculation" << nl
-                        << "    Writing fields - final step" << nl;
+                        << "    Writing fields";
+                    if (nWriteStep_ != 0)
+                    {
+                        Info<< " - final step" << nl;
+                    }
+                    else
+                    {
+                        Info<< nl;
+                    }
+
                     time.writeAndEnd();
                 }
                 break;
             }
-            case satisfiedAction::setTrigger:
+            case satisfiedAction::SET_TRIGGER:
             {
                 Info<< "    Setting trigger " << triggerIndex_ << nl;
                 setTrigger(triggerIndex_);
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.H b/src/functionObjects/utilities/runTimeControl/runTimeControl.H
index 91e3ce7763..b3ca51150b 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.H
@@ -73,8 +73,8 @@ public:
 
         enum class satisfiedAction
         {
-            end,
-            setTrigger
+            END,
+            SET_TRIGGER
         };
 
         static Enum<satisfiedAction> satisfiedActionNames;

From 848f0266ebc0d64d4b26b1b847f32d9dfc9fab92 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 21 Aug 2018 13:09:21 +0100
Subject: [PATCH 09/19] ENH: timeControl - extended use of time and triggers

---
 .../timeControl/timeControlFunctionObject.C   | 67 ++++++++++++++-----
 .../timeControl/timeControlFunctionObject.H   | 22 ++++++
 2 files changed, 73 insertions(+), 16 deletions(-)

diff --git a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.C b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.C
index 988a0464c4..b51279da01 100644
--- a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.C
+++ b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.C
@@ -38,6 +38,15 @@ namespace functionObjects
 }
 }
 
+const Foam::Enum<Foam::functionObjects::timeControl::controlMode>
+Foam::functionObjects::timeControl::controlModeNames_
+{
+    { controlMode::TIME, "time" },
+    { controlMode::TRIGGER, "trigger" },
+    { controlMode::TIME_OR_TRIGGER, "timeOrTrigger" },
+    { controlMode::TIME_AND_TRIGGER, "timeAndTrigger" }
+};
+
 
 // * * * * * * * * * * * * * * * Private Members * * * * * * * * * * * * * * //
 
@@ -52,8 +61,11 @@ void Foam::functionObjects::timeControl::readControls()
         timeEnd_ = time_.userTimeToTime(timeEnd_);
     }
 
-    dict_.readIfPresent("triggerStart", triggerStart_);
-    dict_.readIfPresent("triggerEnd", triggerEnd_);
+    if (dict_.readIfPresent("triggerStart", triggerStart_))
+    {
+        dict_.readIfPresent("triggerEnd", triggerEnd_);
+        controlMode_ = controlModeNames_.read(dict_.lookup("controlMode"));
+    }
 
     deltaTCoeff_ = GREAT;
     if (dict_.readIfPresent("deltaTCoeff", deltaTCoeff_))
@@ -76,12 +88,39 @@ bool Foam::functionObjects::timeControl::active() const
 {
     label triggeri = time_.functionObjects().triggerIndex();
 
-    return
-        (triggeri >= triggerStart_)
-     || (
-            time_.value() >= (timeStart_ - 0.5*time_.deltaTValue())
-         && time_.value() <= (timeEnd_ + 0.5*time_.deltaTValue())
-    );
+    bool inTime =
+        time_.value() >= (timeStart_ - 0.5*time_.deltaTValue())
+     && time_.value() <= (timeEnd_ + 0.5*time_.deltaTValue());
+
+    bool inTrigger = triggeri >= triggerStart_ && triggeri <= triggerEnd_;
+
+    switch (controlMode_)
+    {
+        case controlMode::TIME:
+        {
+            return inTime;
+        }
+        case controlMode::TRIGGER:
+        {
+            return inTrigger;
+        }
+        case controlMode::TIME_OR_TRIGGER:
+        {
+            return inTime || inTrigger;
+        }
+        case controlMode::TIME_AND_TRIGGER:
+        {
+            return inTime && inTrigger;
+        }
+        default:
+        {
+            FatalErrorInFunction
+                << "Unhandled enumeration: " << controlModeNames_[controlMode_]
+                << abort(FatalError);
+        }
+    }
+
+    return false;
 }
 
 
@@ -410,9 +449,10 @@ Foam::functionObjects::timeControl::timeControl
     functionObject(name),
     time_(t),
     dict_(dict),
+    controlMode_(controlMode::TIME),
     timeStart_(-VGREAT),
     timeEnd_(VGREAT),
-    triggerStart_(labelMin),
+    triggerStart_(labelMax),
     triggerEnd_(labelMax),
     nStepsToStartTimeChange_(labelMax),
     executeControl_(t, dict, "execute"),
@@ -694,7 +734,7 @@ bool Foam::functionObjects::timeControl::adjustTimeStep()
 
                 // Set time, deltaT adjustments for writeInterval purposes
                 // are already taken care. Hence disable auto-update
-                const_cast<Time&>( time_).setDeltaT(newDeltaT, false);
+                const_cast<Time&>(time_).setDeltaT(newDeltaT, false);
 
                 if (seriesDTCoeff_ < 1.0)
                 {
@@ -759,12 +799,7 @@ bool Foam::functionObjects::timeControl::read(const dictionary& dict)
 
 bool Foam::functionObjects::timeControl::filesModified() const
 {
-    bool mod = false;
-    if (active())
-    {
-        mod = foPtr_->filesModified();
-    }
-    return mod;
+    return active() ? foPtr_->filesModified() : false;
 }
 
 
diff --git a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H
index 679e59f92d..284d73c160 100644
--- a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H
+++ b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H
@@ -75,6 +75,25 @@ class timeControl
 :
     public functionObject
 {
+public:
+
+
+    // Public enumerations
+
+        //- Control mode
+        enum class controlMode
+        {
+            TIME,
+            TRIGGER,
+            TIME_OR_TRIGGER,
+            TIME_AND_TRIGGER
+        };
+
+        static const Enum<controlMode> controlModeNames_;
+
+
+private:
+
     // Private data
 
         //- Reference to the time database
@@ -86,6 +105,9 @@ class timeControl
 
         // Optional user inputs
 
+            //- Control mode (combination of time/trigger behaviour)
+            controlMode controlMode_;
+
             //- Activation time - defaults to -VGREAT
             scalar timeStart_;
 

From 124eb1c922a003f2adb223d4d5b104e951793746 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 21 Jan 2019 11:05:59 +0000
Subject: [PATCH 10/19] TUT: Added example of runTimeControl with triggers

---
 .../simpleFoam/simpleCar/system/controlDict   |  3 ++
 .../simpleFoam/simpleCar/system/fieldAverage  | 18 ++++++++++
 .../simpleCar/system/runTimeControls          | 35 +++++++++++++++++++
 3 files changed, 56 insertions(+)
 create mode 100644 tutorials/incompressible/simpleFoam/simpleCar/system/fieldAverage
 create mode 100644 tutorials/incompressible/simpleFoam/simpleCar/system/runTimeControls

diff --git a/tutorials/incompressible/simpleFoam/simpleCar/system/controlDict b/tutorials/incompressible/simpleFoam/simpleCar/system/controlDict
index bd6bc7b652..c262bb85eb 100644
--- a/tutorials/incompressible/simpleFoam/simpleCar/system/controlDict
+++ b/tutorials/incompressible/simpleFoam/simpleCar/system/controlDict
@@ -48,6 +48,9 @@ runTimeModifiable true;
 functions
 {
     #include "forceCoeffs"
+    #include "fieldAverage"
+    #include "runTimeControls"
 }
 
+
 // ************************************************************************* //
diff --git a/tutorials/incompressible/simpleFoam/simpleCar/system/fieldAverage b/tutorials/incompressible/simpleFoam/simpleCar/system/fieldAverage
new file mode 100644
index 0000000000..b68552f91f
--- /dev/null
+++ b/tutorials/incompressible/simpleFoam/simpleCar/system/fieldAverage
@@ -0,0 +1,18 @@
+fieldAverage1
+{
+    type            fieldAverage;
+    libs            ("libfieldFunctionObjects.so");
+    triggerStart    1;
+    timeStart       500;
+    controlMode     timeOrTrigger;
+    writeControl    writeTime;
+    fields
+    (
+        U
+        {
+            base        iteration;
+            mean        on;
+            prime2Mean  off;
+        }
+    );
+}
diff --git a/tutorials/incompressible/simpleFoam/simpleCar/system/runTimeControls b/tutorials/incompressible/simpleFoam/simpleCar/system/runTimeControls
new file mode 100644
index 0000000000..9999afa443
--- /dev/null
+++ b/tutorials/incompressible/simpleFoam/simpleCar/system/runTimeControls
@@ -0,0 +1,35 @@
+runTimeControl1
+{
+    type            runTimeControl;
+    libs            ("libutilityFunctionObjects.so");
+    conditions
+    {
+        condition1
+        {
+            type            average;
+            functionObject  forceCoeffs1;
+            fields          (Cd);
+            tolerance       1e-3;
+            window          20;
+            windowType      exact;
+        }
+    }
+    satisfiedAction setTrigger;
+    trigger         1;
+}
+runTimeControl2
+{
+    type            runTimeControl;
+    libs            ("libutilityFunctionObjects.so");
+    controlMode     trigger;
+    triggerStart    1;
+    conditions
+    {
+        condition1
+        {
+            type            maxDuration;
+            duration        100;
+        }
+    }
+    satisfiedAction end;
+}

From 93b5559c870a0f555e7ab1a75ce24f728212a6ab Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 4 Dec 2018 14:39:40 +0000
Subject: [PATCH 11/19] ENH: runTimeControl - execute function objects on end

---
 .../utilities/runTimeControl/runTimeControl.C             | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.C b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
index 0e263e8fff..92e26b989c 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
@@ -250,6 +250,7 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
                 {
                     Info<< "    Stopping calculation" << nl
                         << "    Writing fields";
+
                     if (nWriteStep_ != 0)
                     {
                         Info<< " - final step" << nl;
@@ -259,7 +260,14 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
                         Info<< nl;
                     }
 
+                    Info<< endl;
+                    active_ = false;
+
+                    // Write any registered objects and set the end-time
                     time.writeAndEnd();
+
+                    // Trigger any function objects
+                    time.run();
                 }
                 break;
             }

From 2a386064e21a368e6893bcd8e37606018465cc91 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 21 Jan 2019 11:35:36 +0000
Subject: [PATCH 12/19] ENH: Extended fieldSelection to include field
 components

---
 .../fieldSelection/fieldInfo.H                | 142 +++++++++++++++
 .../fieldSelection/fieldSelection.C           |  92 ++++++++--
 .../fieldSelection/fieldSelection.H           |  49 ++++--
 .../fieldSelection/fieldSelectionI.H          |  60 +++++++
 .../fieldSelection/fieldSelectionTemplates.C  |  12 +-
 .../fieldSelection/fileFieldSelection.C       |  34 ++--
 .../fieldSelection/fileFieldSelection.H       |  18 +-
 .../fileFieldSelectionTemplates.C             |  12 +-
 .../fieldSelection/solverFieldSelection.C     |  30 ++--
 .../fieldSelection/solverFieldSelection.H     |  12 +-
 .../fieldSelection/volFieldSelection.C        |  21 +--
 .../fieldSelection/volFieldSelection.H        |  12 +-
 .../volFieldSelectionTemplates.C              |   4 +-
 .../fieldSelection/fieldSelection.H           | 161 ++++++++++++++++++
 14 files changed, 567 insertions(+), 92 deletions(-)
 create mode 100644 src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H
 create mode 100644 src/finiteVolume/functionObjects/fieldSelection/fieldSelectionI.H
 create mode 100644 src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelection.H

diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H b/src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H
new file mode 100644
index 0000000000..8ad94ff1fb
--- /dev/null
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H
@@ -0,0 +1,142 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Class
+    Foam::functionObjects::fieldInfo
+
+Description
+    Helper class to store a wordRe and label used by
+    Foam::functionObjects::fieldSelection
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_fieldInfo_H
+#define functionObjects_fieldInfo_H
+
+#include "label.H"
+#include "wordRe.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                          Class fieldInfo Declaration
+\*---------------------------------------------------------------------------*/
+
+class fieldInfo;
+Istream& operator>>(Istream&, fieldInfo&);
+Ostream& operator<<(Ostream&, const fieldInfo&);
+
+class fieldInfo
+{
+    // Pivate data
+
+        //- Pattern for the field name
+        wordRe name_;
+
+        //- Field component
+        label component_;
+
+
+public:
+
+    // Constructors
+
+        //- Null constructor
+        fieldInfo()
+        :
+            name_(word::null),
+            component_(-1)
+        {}
+
+
+        //- Construct from components
+        fieldInfo(const wordRe& name, const label component = -1)
+        :
+            name_(name),
+            component_(component)
+        {}
+
+        //- Construct from stream
+        fieldInfo(Istream& is)
+        :
+            name_(is),
+            component_(readLabel(is))
+        {}
+
+
+    //- Destructor
+    ~fieldInfo() = default;
+
+
+    // Member Functions
+
+        const wordRe& name() const
+        {
+            return name_;
+        }
+
+        label component() const
+        {
+            return component_;
+        }
+
+        friend bool operator==(const fieldInfo& a, const fieldInfo& b)
+        {
+            return a.name_ == b.name_ && a.component_ == b.component_;
+        }
+
+        friend bool operator!=(const fieldInfo& a, const fieldInfo& b)
+        {
+            return !(a == b);
+        }
+
+
+    // IOstream Operators
+
+        friend Istream& operator>>(Istream& is, fieldInfo& fi)
+        {
+            is  >> fi.name_ >> fi.component_;
+            return is;
+        }
+        friend Ostream& operator<<(Ostream& os, const fieldInfo& fi)
+        {
+            os  << fi.name_ << ' ' << fi.component_;
+            return os;
+        }
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+
+#endif
+
+// ************************************************************************* //
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C
index 63fa608ef5..9fa43e68be 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -31,36 +31,108 @@ License
 
 Foam::functionObjects::fieldSelection::fieldSelection
 (
-    const objectRegistry& obr
+    const objectRegistry& obr,
+    const bool includeComponents
 )
 :
-    HashSet<wordRe>(),
+    List<fieldInfo>(),
     obr_(obr),
+    includeComponents_(includeComponents),
     selection_()
 {}
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+bool Foam::functionObjects::fieldSelection::resetFieldFilters
+(
+    const HashSet<wordRe>& names
+)
+{
+    static word cmptStr(".component(");
+    static string::size_type len(cmptStr.size());
 
-Foam::functionObjects::fieldSelection::~fieldSelection()
-{}
+    DynamicList<fieldInfo> nameAndComponent(names.size());
+
+    for (const wordRe& name : names)
+    {
+        string::size_type n = name.find(cmptStr);
+        if (n != string::npos)
+        {
+            // Field should be written <field>.component(i)
+
+            if (!includeComponents_)
+            {
+                FatalErrorInFunction
+                    << "Component specification not allowed for " << name
+                    << exit(FatalError);
+            }
+
+            if (name.isPattern())
+            {
+                FatalErrorInFunction
+                    << "Cannot use \".component option\" in combination with "
+                    << "wildcards for " << name
+                    << exit(FatalError);
+            }
+
+            word baseName = name.substr(0, n);
+
+            // Extract the component - number between ()'s
+            string::size_type closei = name.find(')', n);
+
+            if (closei == string::npos)
+            {
+                FatalErrorInFunction
+                    << "Invalid field component specification for "
+                    << name << nl
+                    << "Field should be expressed as <field>.component(i)"
+                    << exit(FatalError);
+            }
+
+            string::size_type cmptWidth = closei - n - len;
+
+            label component
+            (
+                readLabel(IStringStream(name.substr(n+len, cmptWidth))())
+            );
+
+            nameAndComponent.append(fieldInfo(wordRe(baseName), component));
+        }
+        else
+        {
+            nameAndComponent.append(fieldInfo(name));
+        }
+    }
+
+    this->transfer(nameAndComponent);
+
+    return true;
+}
+
+
+bool Foam::functionObjects::fieldSelection::resetFieldFilters
+(
+    const wordRe& name
+)
+{
+    return resetFieldFilters(HashSet<wordRe>({name}));
+}
 
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 bool Foam::functionObjects::fieldSelection::read(const dictionary& dict)
 {
-    dict.readEntry("fields", *this);
+    HashSet<wordRe> fields(dict.lookup("fields"));
 
-    return true;
+    return resetFieldFilters(fields);
 }
 
 
 bool Foam::functionObjects::fieldSelection::containsPattern() const
 {
-    for (const wordRe& fieldName : *this)
+    for (const fieldInfo& fi : *this)
     {
-        if (fieldName.isPattern())
+        if (fi.name().isPattern())
         {
             return true;
         }
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
index 72af300dbc..fec94974db 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -27,6 +27,11 @@ Class
 Description
     Helper class to manage field selections
 
+    The class holds a list of field name filters which are then applied to a
+    set of field objects (in derived classes) from which the resulting set is
+    available via the selection() function.  This returns a list of
+    (fieldName, component) objects, e.g. for U.component(0) this is (U, 0).
+
 SourceFiles
     fieldSelection.C
 
@@ -35,8 +40,9 @@ SourceFiles
 #ifndef functionObjects_fieldSelection_H
 #define functionObjects_fieldSelection_H
 
+#include "fieldInfo.H"
+#include "DynamicList.H"
 #include "HashSet.H"
-#include "wordRe.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
@@ -55,7 +61,7 @@ namespace functionObjects
 
 class fieldSelection
 :
-    public HashSet<wordRe>
+    public List<fieldInfo>
 {
 private:
 
@@ -72,35 +78,50 @@ protected:
         //- Reference to the database
         const objectRegistry& obr_;
 
+        //- Flag to indicate whether components are allowed
+        const bool includeComponents_;
+
         //- Current field selection
-        wordHashSet selection_;
+        List<fieldInfo> selection_;
 
 
     // Protected Member Functions
 
         //- Add registered objects of a given type
         template<class Type>
-        void addRegistered(wordHashSet& set) const;
+        void addRegistered(DynamicList<fieldInfo>& set) const;
 
 
 public:
 
     //- Construct from object registry
-    fieldSelection(const objectRegistry& obr);
+    fieldSelection
+    (
+        const objectRegistry& obr,
+        const bool includeComponents = false
+    );
 
 
     //- Destructor
-    virtual ~fieldSelection();
+    virtual ~fieldSelection() = default;
 
 
     // Member Functions
 
-        //- Return the current field selection
-        const wordHashSet& selection() const
-        {
-            return selection_;
-        }
+        //- Return the cuurent filters
+        inline HashSet<wordRe> filters() const;
 
+        inline const List<fieldInfo>& selection() const;
+
+        //- Return the current field selection
+        inline wordHashSet selectionNames() const;
+
+        //- Reset the field filters to the given field names
+        virtual bool resetFieldFilters(const HashSet<wordRe>& names);
+
+        //- Reset the field filters to the given field name
+        virtual bool resetFieldFilters(const wordRe& name);
+ 
         //- Read the fieldSelection data from dictionary
         virtual bool read(const dictionary& dict);
 
@@ -122,6 +143,10 @@ public:
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
+#include "fieldSelectionI.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
 #ifdef NoRepository
     #include "fieldSelectionTemplates.C"
 #endif
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionI.H b/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionI.H
new file mode 100644
index 0000000000..3b656a1681
--- /dev/null
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionI.H
@@ -0,0 +1,60 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\*---------------------------------------------------------------------------*/
+
+inline Foam::HashSet<Foam::wordRe>
+Foam::functionObjects::fieldSelection::filters() const
+{
+    HashSet<wordRe> f;
+    for (const auto fieldInfo : *this)
+    {
+        f.insert(fieldInfo.name());
+    }
+
+    return f;
+}
+
+// * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
+
+inline const Foam::List<Foam::functionObjects::fieldInfo>&
+Foam::functionObjects::fieldSelection::selection() const
+{
+    return selection_;
+}
+
+
+inline Foam::wordHashSet
+Foam::functionObjects::fieldSelection::selectionNames() const
+{
+    wordHashSet names;
+    for (const fieldInfo& fi : *this)
+    {
+        names.insert(fi.name());
+    }
+
+    return names;
+}
+
+
+// ************************************************************************* //
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C b/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C
index 95a692847e..560f8adf4d 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -23,7 +23,6 @@ License
 
 \*---------------------------------------------------------------------------*/
 
-#include "DynamicList.H"
 #include "objectRegistry.H"
 
 // * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
@@ -31,12 +30,17 @@ License
 template<class Type>
 void Foam::functionObjects::fieldSelection::addRegistered
 (
-    wordHashSet& set
+     DynamicList<fieldInfo>& set
 ) const
 {
-    for (const wordRe& name : *this)
+    for (const fieldInfo& fi : *this)
     {
         set.insert(obr_.names<Type>(name));
+        wordList names(obr_.names<Type>(fi.name()));
+        for (const word& name : names)
+        {
+            set.append(fieldInfo(wordRe(name), fi.component()));
+        }
     }
 }
 
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C
index 0456be0dc1..6616562c6d 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -35,7 +35,7 @@ License
 
 void Foam::functionObjects::fileFieldSelection::addInternalFieldTypes
 (
-    wordHashSet& set
+    DynamicList<fieldInfo>& set
 ) const
 {
     const fvMesh& mesh = static_cast<const fvMesh&>(obr_);
@@ -52,7 +52,7 @@ void Foam::functionObjects::fileFieldSelection::addInternalFieldTypes
 
 void Foam::functionObjects::fileFieldSelection::addUniformFieldTypes
 (
-    wordHashSet& set
+    DynamicList<fieldInfo>& set
 ) const
 {
     const fvMesh& mesh = static_cast<const fvMesh&>(obr_);
@@ -71,16 +71,11 @@ void Foam::functionObjects::fileFieldSelection::addUniformFieldTypes
 
 Foam::functionObjects::fileFieldSelection::fileFieldSelection
 (
-    const objectRegistry& obr
+    const objectRegistry& obr,
+    const bool includeComponents
 )
 :
-    fieldSelection(obr)
-{}
-
-
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::functionObjects::fileFieldSelection::~fileFieldSelection()
+    fieldSelection(obr, includeComponents)
 {}
 
 
@@ -88,19 +83,22 @@ Foam::functionObjects::fileFieldSelection::~fileFieldSelection()
 
 bool Foam::functionObjects::fileFieldSelection::updateSelection()
 {
-    wordHashSet oldSet;
-    oldSet.swap(selection_);
+    List<fieldInfo> oldSet(std::move(selection_));
+
+    DynamicList<fieldInfo> newSelection(oldSet.size());
 
     // Geometric fields
-    addGeoFieldTypes<fvPatchField, volMesh>(selection_);
-    addGeoFieldTypes<fvsPatchField, surfaceMesh>(selection_);
-    addGeoFieldTypes<pointPatchField, pointMesh>(selection_);
+    addGeoFieldTypes<fvPatchField, volMesh>(newSelection);
+    addGeoFieldTypes<fvsPatchField, surfaceMesh>(newSelection);
+    addGeoFieldTypes<pointPatchField, pointMesh>(newSelection);
 
     // Internal fields
-    addInternalFieldTypes(selection_);
+    addInternalFieldTypes(newSelection);
 
     // Uniform fields
-    addUniformFieldTypes(selection_);
+    addUniformFieldTypes(newSelection);
+
+    selection_.transfer(newSelection);
 
     return selection_ != oldSet;
 }
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.H b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.H
index cb94ce10b8..3955eb8319 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.H
+++ b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.H
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -69,31 +69,35 @@ protected:
 
         //- Add registered GeometricField types to selection
         template<template<class> class PatchType, class MeshType>
-        void addGeoFieldTypes(wordHashSet& set) const;
+        void addGeoFieldTypes(DynamicList<fieldInfo>& set) const;
 
         //- Add registered Internal types to selection
-        void addInternalFieldTypes(wordHashSet& set) const;
+        void addInternalFieldTypes(DynamicList<fieldInfo>& set) const;
 
         //- Add registered uniform types to selection
-        void addUniformFieldTypes(wordHashSet& set) const;
+        void addUniformFieldTypes(DynamicList<fieldInfo>& set) const;
 
         //- Add objects of a given type
         template<class Type>
         void addFromFile
         (
             const IOobjectList& allFileObjects,
-            wordHashSet& set
+            DynamicList<fieldInfo>& set
         ) const;
 
 
 public:
 
     //- Construct from object registry
-    fileFieldSelection(const objectRegistry& obr);
+    fileFieldSelection
+    (
+        const objectRegistry& obr,
+        const bool includeComponents = false
+    );
 
 
     //- Destructor
-    virtual ~fileFieldSelection();
+    virtual ~fileFieldSelection() = default;
 
 
     // Member Functions
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C
index 463aeac040..3b360ff026 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C
@@ -33,12 +33,16 @@ template<class Type>
 void Foam::functionObjects::fileFieldSelection::addFromFile
 (
     const IOobjectList& allFileObjects,
-    wordHashSet& set
+     DynamicList<fieldInfo>& set
 ) const
 {
-    for (const wordRe& fieldName : *this)
+    for (const fieldInfo& fi : *this)
     {
-        set.insert(allFileObjects.names(Type::typeName, fieldName));
+        const wordList names(allFileObjects.names(Type::typeName, fi.name()));
+        for (const word& name : names)
+        {
+            set.append(fieldInfo(wordRe(name)));
+        }
     }
 }
 
@@ -46,7 +50,7 @@ void Foam::functionObjects::fileFieldSelection::addFromFile
 template<template<class> class PatchType, class MeshType>
 void Foam::functionObjects::fileFieldSelection::addGeoFieldTypes
 (
-    wordHashSet& set
+    DynamicList<fieldInfo>& set
 ) const
 {
     const fvMesh& mesh = static_cast<const fvMesh&>(obr_);
diff --git a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C
index d7508642d2..247051da98 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C
@@ -32,10 +32,11 @@ License
 
 Foam::functionObjects::solverFieldSelection::solverFieldSelection
 (
-    const objectRegistry& obr
+    const objectRegistry& obr,
+    const bool includeComponents
 )
 :
-    volFieldSelection(obr)
+    volFieldSelection(obr, includeComponents)
 {
     if (!isA<fvMesh>(obr))
     {
@@ -46,34 +47,33 @@ Foam::functionObjects::solverFieldSelection::solverFieldSelection
 }
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::functionObjects::solverFieldSelection::~solverFieldSelection()
-{}
-
-
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 bool Foam::functionObjects::solverFieldSelection::updateSelection()
 {
-    wordHashSet oldSet;
-    oldSet.swap(selection_);
+    List<fieldInfo> oldSet(std::move(selection_));
 
-    wordHashSet volFields;
+    DynamicList<fieldInfo> volFields;
     addRegisteredGeoFields<fvPatchField, volMesh>(volFields);
 
+    DynamicList<fieldInfo> newSelection(oldSet.size());
+
     const fvMesh& mesh = static_cast<const fvMesh&>(obr_);
 
-    const Foam::dictionary& solverDict = mesh.solverPerformanceDict();
+    const dictionary& solverDict = mesh.solverPerformanceDict();
 
-    for (const word& fieldName : volFields)
+    for (const fieldInfo& fi : volFields)
     {
-        if (solverDict.found(fieldName))
+        const wordRe& name = fi.name();
+
+        if (solverDict.found(name))
         {
-            selection_.insert(fieldName);
+            newSelection.append(fi);
         }
     }
 
+    selection_.transfer(newSelection);
+
     return selection_ != oldSet;
 }
 
diff --git a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H b/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H
index 7473c9e536..4ae1e670ac 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H
+++ b/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::volFieldSelection
 
 Description
-    Helper class to manage volume field selections
+    Helper class to manage solver field selections
 
 SourceFiles
     volFieldSelection.C
@@ -63,11 +63,15 @@ private:
 public:
 
     //- Construct from object registry
-    solverFieldSelection(const objectRegistry& obr);
+    solverFieldSelection
+    (
+        const objectRegistry& obr,
+        const bool includeComponents = false
+    );
 
 
     //- Destructor
-    virtual ~solverFieldSelection();
+    virtual ~solverFieldSelection() = default;
 
 
     // Member Functions
diff --git a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C
index b0b61eb524..606ff341eb 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2109 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -31,16 +31,11 @@ License
 
 Foam::functionObjects::volFieldSelection::volFieldSelection
 (
-    const objectRegistry& obr
+    const objectRegistry& obr,
+    const bool includeComponents
 )
 :
-    fieldSelection(obr)
-{}
-
-
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::functionObjects::volFieldSelection::~volFieldSelection()
+    fieldSelection(obr, includeComponents)
 {}
 
 
@@ -48,11 +43,13 @@ Foam::functionObjects::volFieldSelection::~volFieldSelection()
 
 bool Foam::functionObjects::volFieldSelection::updateSelection()
 {
-    wordHashSet oldSet;
+    List<fieldInfo> oldSet(std::move(selection_));
 
-    oldSet.swap(selection_);
+    DynamicList<fieldInfo> newSet(oldSet.size());
 
-    addRegisteredGeoFields<fvPatchField, volMesh>(selection_);
+    addRegisteredGeoFields<fvPatchField, volMesh>(newSet);
+
+    selection_.transfer(newSet);
 
     return selection_ != oldSet;
 }
diff --git a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.H b/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.H
index 4dca6608e3..66dcebbbd9 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.H
+++ b/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.H
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -66,17 +66,21 @@ protected:
 
         //- Add registered GeometricField types to selection
         template<template<class> class PatchType, class MeshType>
-        void addRegisteredGeoFields(wordHashSet& set) const;
+        void addRegisteredGeoFields(DynamicList<fieldInfo>& set) const;
 
 
 public:
 
     //- Construct from object registry
-    volFieldSelection(const objectRegistry& obr);
+    volFieldSelection
+    (
+        const objectRegistry& obr,
+        const bool includeComponents = false
+    );
 
 
     //- Destructor
-    virtual ~volFieldSelection();
+    virtual ~volFieldSelection() = default;
 
 
     // Member Functions
diff --git a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelectionTemplates.C b/src/finiteVolume/functionObjects/fieldSelection/volFieldSelectionTemplates.C
index f1e0ea195f..55f53fc939 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelectionTemplates.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/volFieldSelectionTemplates.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -30,7 +30,7 @@ License
 template<template<class> class PatchType, class MeshType>
 void Foam::functionObjects::volFieldSelection::addRegisteredGeoFields
 (
-    wordHashSet& set
+    DynamicList<fieldInfo>& set
 ) const
 {
     addRegistered<GeometricField<scalar, PatchType, MeshType>>(set);
diff --git a/src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelection.H b/src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelection.H
new file mode 100644
index 0000000000..55ed6eb39a
--- /dev/null
+++ b/src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelection.H
@@ -0,0 +1,161 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Class
+    Foam::functionObjects::fieldSelection
+
+Description
+    Helper class to manage field selections
+
+    The class holds a list of field name filters which are then applied to a
+    set of field objects (in derived classes) from which the resulting set is
+    available via the selection() function.  This returns a list of
+    (fieldName, component) objects, e.g. for U.component(0) this is (U, 0).
+
+SourceFiles
+    fieldSelection.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_fieldSelection_H
+#define functionObjects_fieldSelection_H
+
+#include "fieldInfo.H"
+#include "DynamicList.H"
+#include "HashSet.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+class dictionary;
+class objectRegistry;
+
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                       Class fieldSelection Declaration
+\*---------------------------------------------------------------------------*/
+
+class fieldSelection
+:
+    public List<fieldInfo>
+{
+private:
+
+    // Private Member Functions
+
+        //- No copy construct
+        fieldSelection(const fieldSelection&) = delete;
+
+
+protected:
+
+    // Protected member data
+
+        //- Reference to the database
+        const objectRegistry& obr_;
+
+        //- Flag to indicate whether components are allowed
+        const bool includeComponents_;
+
+        //- Current field selection
+        List<fieldInfo> selection_;
+
+
+    // Protected Member Functions
+
+        //- Add registered objects of a given type
+        template<class Type>
+        void addRegistered(DynamicList<fieldInfo>& set) const;
+
+
+public:
+
+    //- Construct from object registry
+    fieldSelection
+    (
+        const objectRegistry& obr,
+        const bool includeComponents = false
+    );
+
+
+    //- Destructor
+    virtual ~fieldSelection() = default;
+
+
+    // Member Functions
+
+        //- Return the cuurent filters
+        inline HashSet<wordRe> filters() const;
+
+        inline const List<fieldInfo>& selection() const;
+
+        //- Return the current field selection
+        inline wordHashSet selectionNames() const;
+
+        //- Reset the field filters to the given field names
+        virtual bool resetFieldFilters(const HashSet<wordRe>& names);
+
+        //- Reset the field filters to the given field name
+        virtual bool resetFieldFilters(const wordRe& name);
+
+        //- Read the fieldSelection data from dictionary
+        virtual bool read(const dictionary& dict);
+
+        //- Return whether the field names contain a pattern
+        virtual bool containsPattern() const;
+
+        //- Clear the current selection
+        virtual void clearSelection();
+
+        //- Update the selection
+        virtual bool updateSelection();
+
+        //- Check that all requested fielda have been found
+        virtual bool checkSelection();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#include "fieldSelectionI.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#ifdef NoRepository
+    #include "fieldSelectionTemplates.C"
+#endif
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

From d11a5091a4617851d94ace49f795704f5919fa64 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 21 Jan 2019 11:42:49 +0000
Subject: [PATCH 13/19] ENH: Extended equationInitialResidualCondition to use
 field components

---
 .../equationInitialResidualCondition.C        | 48 +++++++++----
 .../equationInitialResidualCondition.H        | 32 +++++++--
 ...quationInitialResidualConditionTemplates.C | 68 +++++++++++++++++++
 3 files changed, 130 insertions(+), 18 deletions(-)
 create mode 100644 src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualConditionTemplates.C

diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
index 050e598434..0d96061784 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2015-2016 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2015-2019 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -27,6 +27,10 @@ License
 #include "addToRunTimeSelectionTable.H"
 #include "fvMesh.H"
 #include "Time.H"
+#include "volFields.H"
+
+#define SetResidual(Type)                                                     \
+    setResidual<Type>(mesh, solverDict, fieldName, component, canSet, residual);
 
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
@@ -76,12 +80,14 @@ equationInitialResidualCondition
 )
 :
     runTimeCondition(name, obr, dict, state),
-    fieldNames_(dict.get<wordList>("fields")),
+    fieldSelection_(obr, true),
     value_(dict.get<scalar>("value")),
     timeStart_(dict.lookupOrDefault("timeStart", -GREAT)),
     mode_(operatingModeNames.get("mode", dict))
 {
-    if (fieldNames_.size())
+    fieldSelection_.read(dict);
+
+    if (fieldSelection_.size())
     {
         timeStart_ = obr.time().userTimeToTime(timeStart_);
     }
@@ -97,9 +103,11 @@ equationInitialResidualCondition
 
 // * * * * * * * * * * * * * * Public Member Functions * * * * * * * * * * * //
 
-bool Foam::functionObjects::runTimeControls::equationInitialResidualCondition::
-apply()
+bool Foam::functionObjects::runTimeControls::
+equationInitialResidualCondition::apply()
 {
+    fieldSelection_.updateSelection();
+
     bool satisfied = false;
 
     if (!active_)
@@ -116,16 +124,26 @@ apply()
     const fvMesh& mesh = refCast<const fvMesh>(obr_);
     const dictionary& solverDict = mesh.solverPerformanceDict();
 
-    List<scalar> result(fieldNames_.size(), -VGREAT);
+    const auto& selection = fieldSelection_.selection();
+    List<scalar> result(selection.size(), -VGREAT);
 
-    forAll(fieldNames_, fieldi)
+    forAll(selection, fieldi)
     {
-        const word& fieldName = fieldNames_[fieldi];
+        const auto& fieldInfo = selection[fieldi];
+
+        const word& fieldName = fieldInfo.name();
 
         if (solverDict.found(fieldName))
         {
-            const List<solverPerformance> sp(solverDict.lookup(fieldName));
-            const scalar residual = sp.first().initialResidual();
+            label component = fieldInfo.component();
+            scalar residual = VGREAT;
+            bool canSet = true;
+            SetResidual(scalar);
+            SetResidual(vector);
+            SetResidual(symmTensor);
+            SetResidual(sphericalTensor);
+            SetResidual(tensor);
+
             result[fieldi] = residual;
 
             switch (mode_)
@@ -164,7 +182,9 @@ apply()
         {
             WarningInFunction
                 << "Initial residual data not found for field "
-                << fieldNames_[i] << endl;
+                << selection[i].name()
+                << ".  Solver dictionary contains " << solverDict.sortedToc()
+                << endl;
         }
         else
         {
@@ -190,7 +210,7 @@ apply()
         {
             if (result[resulti] > 0)
             {
-                Log << "    field: " << fieldNames_[resulti]
+                Log << "    field: " << selection[resulti].name()
                     << ", residual: " << result[resulti] << nl;
             }
         }
@@ -201,8 +221,8 @@ apply()
 }
 
 
-void Foam::functionObjects::runTimeControls::equationInitialResidualCondition::
-write()
+void Foam::functionObjects::runTimeControls::
+equationInitialResidualCondition::write()
 {
     // do nothing
 }
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
index fa0ca263b1..fab51aed76 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2016-2019 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -37,12 +37,15 @@ SourceFiles
 #define functionObjects_runTimeControls_equationInitialResidualCondition_H
 
 #include "runTimeCondition.H"
-#include "Enum.H"
+#include "solverFieldSelection.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
 {
+
+class fvMesh;
+
 namespace functionObjects
 {
 namespace runTimeControls
@@ -71,8 +74,8 @@ protected:
 
     // Protected data
 
-        //- Field name
-        const wordList fieldNames_;
+        //- Field names
+        solverFieldSelection fieldSelection_;
 
         //- Value to compare
         const scalar value_;
@@ -84,6 +87,21 @@ protected:
         operatingMode mode_;
 
 
+    // Protected Member Functions
+
+        //- Set the residual (scalar) value
+        template<class Type>
+        void setResidual
+        (
+            const fvMesh& mesh,
+            const dictionary& dict,
+            const word& fieldName,
+            const label componenti,
+            bool& canSet,
+            scalar& residual
+        ) const;
+
+
 public:
 
     //- Runtime type information
@@ -120,6 +138,12 @@ public:
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
+#ifdef NoRepository
+    #include "equationInitialResidualConditionTemplates.C"
+#endif
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
 #endif
 
 // ************************************************************************* //
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualConditionTemplates.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualConditionTemplates.C
new file mode 100644
index 0000000000..5f24cafad5
--- /dev/null
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualConditionTemplates.C
@@ -0,0 +1,68 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "fvMesh.H"
+
+template<class Type>
+void Foam::functionObjects::runTimeControls::
+equationInitialResidualCondition::setResidual
+(
+    const fvMesh& mesh,
+    const dictionary& dict,
+    const word& fieldName,
+    const label componenti,
+    bool& canSet,
+    scalar& residual
+) const
+{
+    typedef GeometricField<Type, fvPatchField, volMesh> volFieldType;
+
+    if (canSet && mesh.foundObject<volFieldType>(fieldName))
+    {
+        const List<SolverPerformance<Type>> sp(dict.lookup(fieldName));
+        const Type& allComponents = sp.first().initialResidual();
+
+        if (componenti != -1)
+        {
+            if (componenti > pTraits<Type>::nComponents - 1)
+            {
+                FatalErrorInFunction
+                    << "Requested component [" << componenti
+                    <<  "] for field " << fieldName
+                    << " is out of range 0.."
+                    << pTraits<Type>::nComponents - 1
+                    << exit(FatalError);
+            }
+
+            residual = component(allComponents, componenti);
+        }
+        else
+        {
+            residual = cmptMax(allComponents);
+        }
+
+        canSet = false;
+    }
+}

From bc12ce2ac9b0eae716988bdc7a9539d6669794fb Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 21 Jan 2019 11:56:53 +0000
Subject: [PATCH 14/19] ENH: Updated fieldSelection dependent code

---
 .../postProcessing/postProcess/postProcess.C  | 23 ++++++++++++-------
 .../field/columnAverage/columnAverage.C       |  4 ++--
 .../fieldCoordinateSystemTransform.C          |  8 +++----
 .../field/fieldExtents/fieldExtents.C         |  5 ++--
 .../field/fieldMinMax/fieldMinMax.C           |  5 ++--
 .../utilities/residuals/residuals.C           |  6 ++---
 6 files changed, 28 insertions(+), 23 deletions(-)

diff --git a/applications/utilities/postProcessing/postProcess/postProcess.C b/applications/utilities/postProcessing/postProcess/postProcess.C
index 767fb9ff95..44d555cad6 100644
--- a/applications/utilities/postProcessing/postProcess/postProcess.C
+++ b/applications/utilities/postProcessing/postProcess/postProcess.C
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2018 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2018-2019 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -164,17 +164,22 @@ int main(int argc, char *argv[])
     functionObjects::fileFieldSelection fields(mesh);
     if (args.found("fields"))
     {
-        fields.insert(args.getList<wordRe>("fields"));
+        fields.resetFieldFilters
+        (
+            HashSet<wordRe>(args.getList<wordRe>("fields"))
+        );
     }
     if (args.found("field"))
     {
-        fields.insert(args.opt<wordRe>("field"));
+        fields.resetFieldFilters(args.opt<wordRe>("field"));
     }
 
     // Externally stored dictionary for functionObjectList
     // if not constructed from runTime
     dictionary functionsDict;
 
+    HashSet<wordRe> fieldFilters(fields.filters());
+
     // Construct functionObjectList
     autoPtr<functionObjectList> functionsPtr
     (
@@ -183,7 +188,7 @@ int main(int argc, char *argv[])
             args,
             runTime,
             functionsDict,
-            fields
+            fieldFilters // include any additional command-line fields
         )
     );
 
@@ -193,8 +198,6 @@ int main(int argc, char *argv[])
 
         Info<< "Time = " << runTime.timeName() << endl;
 
-        fields.updateSelection();
-
         if (mesh.readUpdate() != polyMesh::UNCHANGED)
         {
             // Update functionObjectList if mesh changes
@@ -205,10 +208,14 @@ int main(int argc, char *argv[])
                 args,
                 runTime,
                 functionsDict,
-                fields
+                fieldFilters
             );
         }
 
+        fields.resetFieldFilters(fieldFilters);
+
+        fields.updateSelection();
+
         const bool throwingIOErr = FatalIOError.throwExceptions();
 
         try
@@ -218,7 +225,7 @@ int main(int argc, char *argv[])
                 args,
                 runTime,
                 mesh,
-                fields.selection(),
+                fields.selectionNames(),
                 functionsPtr(),
                 timei == timeDirs.size()-1
             );
diff --git a/src/functionObjects/field/columnAverage/columnAverage.C b/src/functionObjects/field/columnAverage/columnAverage.C
index c0b00cfdab..68fafdfe27 100644
--- a/src/functionObjects/field/columnAverage/columnAverage.C
+++ b/src/functionObjects/field/columnAverage/columnAverage.C
@@ -151,7 +151,7 @@ bool Foam::functionObjects::columnAverage::execute()
     // Make fields up to date with current selection
     fieldSet_.updateSelection();
 
-    for (const word& fieldName : fieldSet_.selection())
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
         columnAverageField<scalar>(fieldName);
         columnAverageField<vector>(fieldName);
@@ -166,7 +166,7 @@ bool Foam::functionObjects::columnAverage::execute()
 
 bool Foam::functionObjects::columnAverage::write()
 {
-    for (const word& fieldName : fieldSet_.selection())
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
         const word resultName("columnAverage(" + fieldName + ")");
         const regIOobject* obj =
diff --git a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.C b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.C
index 7259d24ca8..1b2193450e 100644
--- a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.C
+++ b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.C
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2011-2017 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2017-2018 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2017-2019 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -191,7 +191,7 @@ bool Foam::functionObjects::fieldCoordinateSystemTransform::execute()
 {
     fieldSet_.updateSelection();
 
-    for (const word& fieldName : fieldSet_.selection())
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
         transform<scalar>(fieldName);
         transform<vector>(fieldName);
@@ -210,9 +210,9 @@ bool Foam::functionObjects::fieldCoordinateSystemTransform::execute()
 
 bool Foam::functionObjects::fieldCoordinateSystemTransform::write()
 {
-    forAllConstIters(fieldSet_, iter)
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
-        writeObject(transformFieldName(iter()));
+        writeObject(transformFieldName(fieldName));
     }
 
     return true;
diff --git a/src/functionObjects/field/fieldExtents/fieldExtents.C b/src/functionObjects/field/fieldExtents/fieldExtents.C
index 8e65a802eb..dac26340f4 100644
--- a/src/functionObjects/field/fieldExtents/fieldExtents.C
+++ b/src/functionObjects/field/fieldExtents/fieldExtents.C
@@ -60,9 +60,8 @@ void Foam::functionObjects::fieldExtents::writeFileHeader(Ostream& os)
 
     writeCommented(os, "Time");
 
-    forAllConstIters(fieldSet_.selection(), iter)
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
-        const word& fieldName = iter();
         if (internalField_)
         {
             writeTabbed(os, fieldName + "_internal");
@@ -183,7 +182,7 @@ bool Foam::functionObjects::fieldExtents::write()
 
     Log << type() << " " << name() <<  " write:" << nl;
 
-    for (const word& fieldName : fieldSet_.selection())
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
         calcFieldExtents<scalar>(fieldName, true);
         calcFieldExtents<vector>(fieldName);
diff --git a/src/functionObjects/field/fieldMinMax/fieldMinMax.C b/src/functionObjects/field/fieldMinMax/fieldMinMax.C
index e217e58b7f..d82b655fad 100644
--- a/src/functionObjects/field/fieldMinMax/fieldMinMax.C
+++ b/src/functionObjects/field/fieldMinMax/fieldMinMax.C
@@ -90,9 +90,8 @@ void Foam::functionObjects::fieldMinMax::writeFileHeader(Ostream& os)
     }
     else
     {
-        forAllConstIters(fieldSet_.selection(), iter)
+        for (const word& fieldName : fieldSet_.selectionNames())
         {
-            const word& fieldName = iter();
             writeTabbed(os, "min(" + fieldName + ')');
             writeTabbed(os, "max(" + fieldName + ')');
         }
@@ -153,7 +152,7 @@ bool Foam::functionObjects::fieldMinMax::write()
     if (!location_) writeTime(file());
     Log << type() << " " << name() <<  " write:" << nl;
 
-    for (const word& fieldName : fieldSet_.selection())
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
         calcMinMaxFields<scalar>(fieldName, mdCmpt);
         calcMinMaxFields<vector>(fieldName, mode_);
diff --git a/src/functionObjects/utilities/residuals/residuals.C b/src/functionObjects/utilities/residuals/residuals.C
index bc435c2a41..c06a00837e 100644
--- a/src/functionObjects/utilities/residuals/residuals.C
+++ b/src/functionObjects/utilities/residuals/residuals.C
@@ -64,7 +64,7 @@ void Foam::functionObjects::residuals::writeFileHeader(Ostream& os)
 
     writeCommented(os, "Time");
 
-    for (const word& fieldName : fieldSet_.selection())
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
         writeFileHeader<scalar>(os, fieldName);
         writeFileHeader<vector>(os, fieldName);
@@ -193,7 +193,7 @@ bool Foam::functionObjects::residuals::execute()
 
         if (writeFields_)
         {
-            for (const word& fieldName : fieldSet_.selection())
+            for (const word& fieldName : fieldSet_.selectionNames())
             {
                 initialiseField<scalar>(fieldName);
                 initialiseField<vector>(fieldName);
@@ -214,7 +214,7 @@ bool Foam::functionObjects::residuals::write()
 {
     writeTime(file());
 
-    for (const word& fieldName : fieldSet_.selection())
+    for (const word& fieldName : fieldSet_.selectionNames())
     {
         writeResidual<scalar>(fieldName);
         writeResidual<vector>(fieldName);

From 0abae185b7801d65aa9e1317a3f2965960884283 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 15 Jan 2019 15:05:56 +0000
Subject: [PATCH 15/19] STYLE: Updated output message

---
 src/functionObjects/utilities/runTimeControl/runTimeControl.C | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.C b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
index 92e26b989c..245ad9137c 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
@@ -285,7 +285,7 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::execute()
     }
     else
     {
-        Info<< "    Conditions not met - calculations proceeding" << nl;
+        Info<< "    Conditions not met" << nl;
     }
 
     Info<< endl;

From 9e202d141dfb74170c38ab146fb4073bc18b6a83 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 21 Jan 2019 12:01:11 +0000
Subject: [PATCH 16/19] TUT: Added example of field component specification

---
 .../simpleCar/system/runTimeControls          | 20 +++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/tutorials/incompressible/simpleFoam/simpleCar/system/runTimeControls b/tutorials/incompressible/simpleFoam/simpleCar/system/runTimeControls
index 9999afa443..76719e3d8f 100644
--- a/tutorials/incompressible/simpleFoam/simpleCar/system/runTimeControls
+++ b/tutorials/incompressible/simpleFoam/simpleCar/system/runTimeControls
@@ -17,6 +17,7 @@ runTimeControl1
     satisfiedAction setTrigger;
     trigger         1;
 }
+
 runTimeControl2
 {
     type            runTimeControl;
@@ -33,3 +34,22 @@ runTimeControl2
     }
     satisfiedAction end;
 }
+
+/*
+    runTimeControl3
+    {
+        type            runTimeControl;
+        libs            ("libutilityFunctionObjects.so");
+        conditions
+        {
+            condition1
+            {
+                type            equationInitialResidual;
+                fields          (U.component(0));
+                value           1e-02;
+                mode            minimum;
+            }
+        }
+        satisfiedAction end;
+    }
+*/

From 452a281a00b1a3dd54ba7513f3a0c1181451e8da Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 21 Jan 2019 12:16:13 +0000
Subject: [PATCH 17/19] ENH: fieldSelection - added checks for when fields are
 not found

---
 .../fieldSelection/fieldInfo.H                | 29 ++++++++++++++-----
 .../fieldSelection/fieldSelection.C           | 21 +++++++++++++-
 .../fieldSelection/fieldSelection.H           |  5 +++-
 .../fieldSelection/fieldSelectionTemplates.C  | 10 +++++--
 .../fieldSelection/fileFieldSelection.C       |  2 ++
 .../fileFieldSelectionTemplates.C             | 11 +++++--
 .../fieldSelection/solverFieldSelection.C     | 28 ++++++++++++------
 .../fieldSelection/solverFieldSelection.H     |  6 ++--
 .../fieldSelection/volFieldSelection.C        |  2 ++
 .../equationInitialResidualCondition.C        |  5 ++--
 10 files changed, 89 insertions(+), 30 deletions(-)

diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H b/src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H
index 8ad94ff1fb..7eb048005b 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H
@@ -33,8 +33,9 @@ Description
 #ifndef functionObjects_fieldInfo_H
 #define functionObjects_fieldInfo_H
 
-#include "label.H"
 #include "wordRe.H"
+#include "label.H"
+#include "Switch.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
@@ -61,6 +62,9 @@ class fieldInfo
         //- Field component
         label component_;
 
+        //- Found
+        mutable Switch found_;
+
 
 public:
 
@@ -70,7 +74,8 @@ public:
         fieldInfo()
         :
             name_(word::null),
-            component_(-1)
+            component_(-1),
+            found_(false)
         {}
 
 
@@ -78,14 +83,16 @@ public:
         fieldInfo(const wordRe& name, const label component = -1)
         :
             name_(name),
-            component_(component)
+            component_(component),
+            found_(false)
         {}
 
         //- Construct from stream
         fieldInfo(Istream& is)
         :
             name_(is),
-            component_(readLabel(is))
+            component_(readLabel(is)),
+            found_(false)
         {}
 
 
@@ -105,9 +112,17 @@ public:
             return component_;
         }
 
+        Switch& found() const
+        {
+            return found_;
+        }
+
         friend bool operator==(const fieldInfo& a, const fieldInfo& b)
         {
-            return a.name_ == b.name_ && a.component_ == b.component_;
+            return
+                a.name_ == b.name_
+             && a.component_ == b.component_
+             && a.found_ == b.found_;
         }
 
         friend bool operator!=(const fieldInfo& a, const fieldInfo& b)
@@ -120,12 +135,12 @@ public:
 
         friend Istream& operator>>(Istream& is, fieldInfo& fi)
         {
-            is  >> fi.name_ >> fi.component_;
+            is  >> fi.name_ >> fi.component_ >> fi.found_;
             return is;
         }
         friend Ostream& operator<<(Ostream& os, const fieldInfo& fi)
         {
-            os  << fi.name_ << ' ' << fi.component_;
+            os  << fi.name_ << ' ' << fi.component_ << ' ' << fi.found_;
             return os;
         }
 };
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C
index 9fa43e68be..f21835a12d 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C
@@ -84,7 +84,7 @@ bool Foam::functionObjects::fieldSelection::resetFieldFilters
                 FatalErrorInFunction
                     << "Invalid field component specification for "
                     << name << nl
-                    << "Field should be expressed as <field>.component(i)"
+                    << ". Field should be expressed as <field>.component(i)"
                     << exit(FatalError);
             }
 
@@ -154,4 +154,23 @@ bool Foam::functionObjects::fieldSelection::updateSelection()
 }
 
 
+bool Foam::functionObjects::fieldSelection::checkSelection()
+{
+    bool ok = true;
+    for (const fieldInfo& fi : *this)
+    {
+        if (!fi.found())
+        {
+            WarningInFunction
+                << "Field " << fi.name() << " not found"
+                << endl;
+
+            ok = false;
+        }
+    }
+
+    return ok;
+}
+
+
 // ************************************************************************* //
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
index fec94974db..e4a510679c 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
@@ -131,8 +131,11 @@ public:
         //- Clear the current selection
         virtual void clearSelection();
 
-        //- Update the selection using current contents of obr_
+        //- Update the selection
         virtual bool updateSelection();
+
+        //- Check that all requested fielda have been found
+        virtual bool checkSelection();
 };
 
 
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C b/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C
index 560f8adf4d..4e80fc2602 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C
@@ -35,11 +35,15 @@ void Foam::functionObjects::fieldSelection::addRegistered
 {
     for (const fieldInfo& fi : *this)
     {
-        set.insert(obr_.names<Type>(name));
         wordList names(obr_.names<Type>(fi.name()));
-        for (const word& name : names)
+        if (names.size())
         {
-            set.append(fieldInfo(wordRe(name), fi.component()));
+            for (const word& name : names)
+            {
+                set.append(fieldInfo(wordRe(name), fi.component()));
+            }
+
+            fi.found() = true;
         }
     }
 }
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C
index 6616562c6d..5387d0b7e3 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C
@@ -100,6 +100,8 @@ bool Foam::functionObjects::fileFieldSelection::updateSelection()
 
     selection_.transfer(newSelection);
 
+    (void)fieldSelection::checkSelection();
+
     return selection_ != oldSet;
 }
 
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C
index 3b360ff026..6dda18bb90 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C
@@ -33,15 +33,20 @@ template<class Type>
 void Foam::functionObjects::fileFieldSelection::addFromFile
 (
     const IOobjectList& allFileObjects,
-     DynamicList<fieldInfo>& set
+    DynamicList<fieldInfo>& set
 ) const
 {
     for (const fieldInfo& fi : *this)
     {
         const wordList names(allFileObjects.names(Type::typeName, fi.name()));
-        for (const word& name : names)
+        if (names.size())
         {
-            set.append(fieldInfo(wordRe(name)));
+            for (const word& name : names)
+            {
+                set.append(fieldInfo(wordRe(name)));
+            }
+
+            fi.found() = true;
         }
     }
 }
diff --git a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C
index 247051da98..14e955b66f 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C
@@ -36,7 +36,7 @@ Foam::functionObjects::solverFieldSelection::solverFieldSelection
     const bool includeComponents
 )
 :
-    volFieldSelection(obr, includeComponents)
+    fieldSelection(obr, includeComponents)
 {
     if (!isA<fvMesh>(obr))
     {
@@ -53,27 +53,37 @@ bool Foam::functionObjects::solverFieldSelection::updateSelection()
 {
     List<fieldInfo> oldSet(std::move(selection_));
 
-    DynamicList<fieldInfo> volFields;
-    addRegisteredGeoFields<fvPatchField, volMesh>(volFields);
-
     DynamicList<fieldInfo> newSelection(oldSet.size());
 
     const fvMesh& mesh = static_cast<const fvMesh&>(obr_);
 
     const dictionary& solverDict = mesh.solverPerformanceDict();
 
-    for (const fieldInfo& fi : volFields)
-    {
-        const wordRe& name = fi.name();
+    const wordList solvedFieldNames(solverDict.sortedToc());
 
-        if (solverDict.found(name))
+    for (const fieldInfo& fi : *this)
+    {
+        for (const word& solvedField : solvedFieldNames)
         {
-            newSelection.append(fi);
+            if (fi.name().match(solvedField))
+            {
+                newSelection.append
+                (
+                    fieldInfo(wordRe(solvedField), fi.component())
+                );
+                fi.found() = true;
+            }
         }
     }
 
     selection_.transfer(newSelection);
 
+    if (!fieldSelection::checkSelection())
+    {
+        WarningInFunction
+            << "Valid solver fields are: " << solvedFieldNames;
+    }
+
     return selection_ != oldSet;
 }
 
diff --git a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H b/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H
index 4ae1e670ac..d1a239b853 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H
+++ b/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H
@@ -28,14 +28,14 @@ Description
     Helper class to manage solver field selections
 
 SourceFiles
-    volFieldSelection.C
+    solverFieldSelection.C
 
 \*---------------------------------------------------------------------------*/
 
 #ifndef functionObjects_solverFieldSelection_H
 #define functionObjects_solverFieldSelection_H
 
-#include "volFieldSelection.H"
+#include "fieldSelection.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
@@ -50,7 +50,7 @@ namespace functionObjects
 
 class solverFieldSelection
 :
-    public volFieldSelection
+    public fieldSelection
 {
 private:
 
diff --git a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C
index 606ff341eb..bd367b8301 100644
--- a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C
+++ b/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C
@@ -51,6 +51,8 @@ bool Foam::functionObjects::volFieldSelection::updateSelection()
 
     selection_.transfer(newSet);
 
+    (void)fieldSelection::checkSelection();
+
     return selection_ != oldSet;
 }
 
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
index 0d96061784..0f5b6794ab 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
@@ -70,8 +70,8 @@ operatingModeNames
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
-Foam::functionObjects::runTimeControls::equationInitialResidualCondition::
-equationInitialResidualCondition
+Foam::functionObjects::runTimeControls::
+equationInitialResidualCondition::equationInitialResidualCondition
 (
     const word& name,
     const objectRegistry& obr,
@@ -130,7 +130,6 @@ equationInitialResidualCondition::apply()
     forAll(selection, fieldi)
     {
         const auto& fieldInfo = selection[fieldi];
-
         const word& fieldName = fieldInfo.name();
 
         if (solverDict.found(fieldName))

From 27e3b1f9e6ba88c2cd8c783298186e964a18e808 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 22 Jan 2019 12:52:27 +0000
Subject: [PATCH 18/19] STYLE: relocating files

---
 src/finiteVolume/Make/files                   |   8 +-
 .../fieldSelection/fieldSelection.H           | 161 ------------------
 .../fieldSelection/fieldInfo.H                |   0
 .../fieldSelection/fieldSelection.C           |   0
 .../fieldSelection/fieldSelectionI.H          |   0
 .../fieldSelection/fieldSelectionTemplates.C  |   0
 .../fileFieldSelection}/fileFieldSelection.C  |   0
 .../fileFieldSelection}/fileFieldSelection.H  |   0
 .../fileFieldSelectionTemplates.C             |   0
 .../solverFieldSelection.C                    |   0
 .../solverFieldSelection.H                    |   0
 .../volFieldSelection}/volFieldSelection.C    |   0
 .../volFieldSelection}/volFieldSelection.H    |   0
 .../volFieldSelectionTemplates.C              |   0
 14 files changed, 4 insertions(+), 165 deletions(-)
 delete mode 100644 src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
 rename src/finiteVolume/functionObjects/{ => fieldSelections}/fieldSelection/fieldInfo.H (100%)
 rename src/finiteVolume/functionObjects/{ => fieldSelections}/fieldSelection/fieldSelection.C (100%)
 rename src/finiteVolume/functionObjects/{ => fieldSelections}/fieldSelection/fieldSelectionI.H (100%)
 rename src/finiteVolume/functionObjects/{ => fieldSelections}/fieldSelection/fieldSelectionTemplates.C (100%)
 rename src/finiteVolume/functionObjects/{fieldSelection => fieldSelections/fileFieldSelection}/fileFieldSelection.C (100%)
 rename src/finiteVolume/functionObjects/{fieldSelection => fieldSelections/fileFieldSelection}/fileFieldSelection.H (100%)
 rename src/finiteVolume/functionObjects/{fieldSelection => fieldSelections/fileFieldSelection}/fileFieldSelectionTemplates.C (100%)
 rename src/finiteVolume/functionObjects/{fieldSelection => fieldSelections/solverFieldSelection}/solverFieldSelection.C (100%)
 rename src/finiteVolume/functionObjects/{fieldSelection => fieldSelections/solverFieldSelection}/solverFieldSelection.H (100%)
 rename src/finiteVolume/functionObjects/{fieldSelection => fieldSelections/volFieldSelection}/volFieldSelection.C (100%)
 rename src/finiteVolume/functionObjects/{fieldSelection => fieldSelections/volFieldSelection}/volFieldSelection.H (100%)
 rename src/finiteVolume/functionObjects/{fieldSelection => fieldSelections/volFieldSelection}/volFieldSelectionTemplates.C (100%)

diff --git a/src/finiteVolume/Make/files b/src/finiteVolume/Make/files
index ebaf55b8c0..1041f6e9c1 100644
--- a/src/finiteVolume/Make/files
+++ b/src/finiteVolume/Make/files
@@ -97,10 +97,10 @@ $(faceToCell)/MeshObjects/centredCFCFaceToCellStencilObject.C
 
 functionObjects/fvMeshFunctionObject/fvMeshFunctionObject.C
 functionObjects/volRegion/volRegion.C
-functionObjects/fieldSelection/fieldSelection.C
-functionObjects/fieldSelection/fileFieldSelection.C
-functionObjects/fieldSelection/volFieldSelection.C
-functionObjects/fieldSelection/solverFieldSelection.C
+functionObjects/fieldSelections/fieldSelection/fieldSelection.C
+functionObjects/fieldSelections/fileFieldSelection/fileFieldSelection.C
+functionObjects/fieldSelections/volFieldSelection/volFieldSelection.C
+functionObjects/fieldSelections/solverFieldSelection/solverFieldSelection.C
 
 fvPatchFields = fields/fvPatchFields
 $(fvPatchFields)/fvPatchField/fvPatchFields.C
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H b/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
deleted file mode 100644
index e4a510679c..0000000000
--- a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.H
+++ /dev/null
@@ -1,161 +0,0 @@
-/*---------------------------------------------------------------------------*\
-  =========                 |
-  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
-   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
-     \\/     M anipulation  |
--------------------------------------------------------------------------------
-License
-    This file is part of OpenFOAM.
-
-    OpenFOAM is free software: you can redistribute it and/or modify it
-    under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
-    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-    for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
-
-Class
-    Foam::functionObjects::fieldSelection
-
-Description
-    Helper class to manage field selections
-
-    The class holds a list of field name filters which are then applied to a
-    set of field objects (in derived classes) from which the resulting set is
-    available via the selection() function.  This returns a list of
-    (fieldName, component) objects, e.g. for U.component(0) this is (U, 0).
-
-SourceFiles
-    fieldSelection.C
-
-\*---------------------------------------------------------------------------*/
-
-#ifndef functionObjects_fieldSelection_H
-#define functionObjects_fieldSelection_H
-
-#include "fieldInfo.H"
-#include "DynamicList.H"
-#include "HashSet.H"
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-namespace Foam
-{
-
-class dictionary;
-class objectRegistry;
-
-namespace functionObjects
-{
-
-/*---------------------------------------------------------------------------*\
-                       Class fieldSelection Declaration
-\*---------------------------------------------------------------------------*/
-
-class fieldSelection
-:
-    public List<fieldInfo>
-{
-private:
-
-    // Private Member Functions
-
-        //- No copy construct
-        fieldSelection(const fieldSelection&) = delete;
-
-
-protected:
-
-    // Protected member data
-
-        //- Reference to the database
-        const objectRegistry& obr_;
-
-        //- Flag to indicate whether components are allowed
-        const bool includeComponents_;
-
-        //- Current field selection
-        List<fieldInfo> selection_;
-
-
-    // Protected Member Functions
-
-        //- Add registered objects of a given type
-        template<class Type>
-        void addRegistered(DynamicList<fieldInfo>& set) const;
-
-
-public:
-
-    //- Construct from object registry
-    fieldSelection
-    (
-        const objectRegistry& obr,
-        const bool includeComponents = false
-    );
-
-
-    //- Destructor
-    virtual ~fieldSelection() = default;
-
-
-    // Member Functions
-
-        //- Return the cuurent filters
-        inline HashSet<wordRe> filters() const;
-
-        inline const List<fieldInfo>& selection() const;
-
-        //- Return the current field selection
-        inline wordHashSet selectionNames() const;
-
-        //- Reset the field filters to the given field names
-        virtual bool resetFieldFilters(const HashSet<wordRe>& names);
-
-        //- Reset the field filters to the given field name
-        virtual bool resetFieldFilters(const wordRe& name);
- 
-        //- Read the fieldSelection data from dictionary
-        virtual bool read(const dictionary& dict);
-
-        //- Return whether the field names contain a pattern
-        virtual bool containsPattern() const;
-
-        //- Clear the current selection
-        virtual void clearSelection();
-
-        //- Update the selection
-        virtual bool updateSelection();
-
-        //- Check that all requested fielda have been found
-        virtual bool checkSelection();
-};
-
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace functionObjects
-} // End namespace Foam
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-#include "fieldSelectionI.H"
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-#ifdef NoRepository
-    #include "fieldSelectionTemplates.C"
-#endif
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-#endif
-
-// ************************************************************************* //
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H b/src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldInfo.H
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/fieldInfo.H
rename to src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldInfo.H
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C b/src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelection.C
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/fieldSelection.C
rename to src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelection.C
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionI.H b/src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelectionI.H
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/fieldSelectionI.H
rename to src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelectionI.H
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C b/src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelectionTemplates.C
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/fieldSelectionTemplates.C
rename to src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelectionTemplates.C
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelections/fileFieldSelection/fileFieldSelection.C
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.C
rename to src/finiteVolume/functionObjects/fieldSelections/fileFieldSelection/fileFieldSelection.C
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.H b/src/finiteVolume/functionObjects/fieldSelections/fileFieldSelection/fileFieldSelection.H
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/fileFieldSelection.H
rename to src/finiteVolume/functionObjects/fieldSelections/fileFieldSelection/fileFieldSelection.H
diff --git a/src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C b/src/finiteVolume/functionObjects/fieldSelections/fileFieldSelection/fileFieldSelectionTemplates.C
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/fileFieldSelectionTemplates.C
rename to src/finiteVolume/functionObjects/fieldSelections/fileFieldSelection/fileFieldSelectionTemplates.C
diff --git a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelections/solverFieldSelection/solverFieldSelection.C
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.C
rename to src/finiteVolume/functionObjects/fieldSelections/solverFieldSelection/solverFieldSelection.C
diff --git a/src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H b/src/finiteVolume/functionObjects/fieldSelections/solverFieldSelection/solverFieldSelection.H
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/solverFieldSelection.H
rename to src/finiteVolume/functionObjects/fieldSelections/solverFieldSelection/solverFieldSelection.H
diff --git a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C b/src/finiteVolume/functionObjects/fieldSelections/volFieldSelection/volFieldSelection.C
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.C
rename to src/finiteVolume/functionObjects/fieldSelections/volFieldSelection/volFieldSelection.C
diff --git a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.H b/src/finiteVolume/functionObjects/fieldSelections/volFieldSelection/volFieldSelection.H
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/volFieldSelection.H
rename to src/finiteVolume/functionObjects/fieldSelections/volFieldSelection/volFieldSelection.H
diff --git a/src/finiteVolume/functionObjects/fieldSelection/volFieldSelectionTemplates.C b/src/finiteVolume/functionObjects/fieldSelections/volFieldSelection/volFieldSelectionTemplates.C
similarity index 100%
rename from src/finiteVolume/functionObjects/fieldSelection/volFieldSelectionTemplates.C
rename to src/finiteVolume/functionObjects/fieldSelections/volFieldSelection/volFieldSelectionTemplates.C

From c604adc0d113486aae2f0dc7e9350f87ab25cf5c Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 21 Jan 2019 13:52:34 +0000
Subject: [PATCH 19/19] ENH: runTimeControl - deactivate for -postProcess
 operation

---
 .../utilities/runTimeControl/runTimeControl.C | 127 ++++++++++--------
 1 file changed, 70 insertions(+), 57 deletions(-)

diff --git a/src/functionObjects/utilities/runTimeControl/runTimeControl.C b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
index 245ad9137c..d3dda8e29c 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeControl.C
+++ b/src/functionObjects/utilities/runTimeControl/runTimeControl.C
@@ -83,78 +83,91 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::read
     const dictionary& dict
 )
 {
-    fvMeshFunctionObject::read(dict);
-
-    const dictionary& conditionsDict = dict.subDict("conditions");
-    const wordList conditionNames(conditionsDict.toc());
-    conditions_.setSize(conditionNames.size());
-
-    label uniqueGroupi = 0;
-    forAll(conditionNames, conditioni)
+    if (functionObject::postProcess)
     {
-        const word& conditionName = conditionNames[conditioni];
-        const dictionary& dict = conditionsDict.subDict(conditionName);
-
-        conditions_.set
-        (
-            conditioni,
-            runTimeCondition::New(conditionName, obr_, dict, *this)
-        );
-
-        label groupi = conditions_[conditioni].groupID();
-
-        if (groupMap_.insert(groupi, uniqueGroupi))
-        {
-            ++uniqueGroupi;
-        }
-    }
-
-    dict.readIfPresent("nWriteStep", nWriteStep_);
-
-    // Check that some conditions are set
-    if (conditions_.empty())
-    {
-        Info<< type() << " " << name() << " output:" << nl
-            << "    No conditions present" << nl
+        Info<< "Deactivated " << name()
+            << " function object for post-processing"
             << endl;
+
+        return false;
     }
-    else
+
+
+    if (fvMeshFunctionObject::read(dict))
     {
-        // Check that at least one condition is active
-        bool check = false;
-        for (const auto& condition : conditions_)
+        const dictionary& conditionsDict = dict.subDict("conditions");
+        const wordList conditionNames(conditionsDict.toc());
+        conditions_.setSize(conditionNames.size());
+
+        label uniqueGroupi = 0;
+        forAll(conditionNames, conditioni)
         {
-            if (condition.active())
+            const word& conditionName = conditionNames[conditioni];
+            const dictionary& dict = conditionsDict.subDict(conditionName);
+
+            conditions_.set
+            (
+                conditioni,
+                runTimeCondition::New(conditionName, obr_, dict, *this)
+            );
+
+            label groupi = conditions_[conditioni].groupID();
+
+            if (groupMap_.insert(groupi, uniqueGroupi))
             {
-                check = true;
-                break;
+                ++uniqueGroupi;
             }
         }
 
-        if (!check)
+        dict.readIfPresent("nWriteStep", nWriteStep_);
+
+        // Check that some conditions are set
+        if (conditions_.empty())
         {
             Info<< type() << " " << name() << " output:" << nl
-                << "    All conditions are inactive" << nl
+                << "    No conditions present" << nl
                 << endl;
         }
+        else
+        {
+            // Check that at least one condition is active
+            bool check = false;
+            for (const auto& condition : conditions_)
+            {
+                if (condition.active())
+                {
+                    check = true;
+                    break;
+                }
+            }
+
+            if (!check)
+            {
+                Info<< type() << " " << name() << " output:" << nl
+                    << "    All conditions are inactive" << nl
+                    << endl;
+            }
+        }
+
+        // Set the action to perform when all conditions are satisfied
+        // - set to end fro backwards compatibility with v1806
+        satisfiedAction_ =
+            satisfiedActionNames.lookupOrDefault
+            (
+                "satisfiedAction",
+                dict,
+                satisfiedAction::END
+            );
+
+        if (satisfiedAction_ == satisfiedAction::SET_TRIGGER)
+        {
+            triggerIndex_ = readLabel(dict.lookup("trigger"));
+        }
+
+        return true;
     }
 
-    // Set the action to perform when all conditions are satisfied
-    // - set to end fro backwards compatibility with v1806
-    satisfiedAction_ =
-        satisfiedActionNames.lookupOrDefault
-        (
-            "satisfiedAction",
-            dict,
-            satisfiedAction::END
-        );
-
-    if (satisfiedAction_ == satisfiedAction::SET_TRIGGER)
-    {
-        triggerIndex_ = readLabel(dict.lookup("trigger"));
-    }
-
-    return true;
+    return false;
 }