controlIOdictionary: controlDict specific IOdictionary to provide automatic read-update for Time

Author: Henry Weller

src/OpenFOAM/Make/files

@@ -283,6 +283,7 @@ db/functionObjects/timeControl/timeControlFunctionObject.C
 db/functionObjects/regionFunctionObject/regionFunctionObject.C
 
 Time = db/Time
+$(Time)/controlIOdictionary/controlIOdictionary.C
 $(Time)/TimePaths.C
 $(Time)/TimeState.C
 $(Time)/Time.C

src/OpenFOAM/db/Time/Time.C

@@ -361,7 +361,8 @@ Foam::Time::Time
             *this,
             IOobject::MUST_READ_IF_MODIFIED,
             IOobject::NO_WRITE
-        )
+        ),
+        *this
     ),
 
     startTimeIndex_(0),
@@ -461,7 +462,8 @@ Foam::Time::Time
             *this,
             IOobject::MUST_READ_IF_MODIFIED,
             IOobject::NO_WRITE
-        )
+        ),
+        *this
     ),
 
     startTimeIndex_(0),
@@ -528,7 +530,8 @@ Foam::Time::Time
             IOobject::MUST_READ_IF_MODIFIED,
             IOobject::NO_WRITE
         ),
-        dict
+        dict,
+        *this
     ),
 
     startTimeIndex_(0),
@@ -593,7 +596,8 @@ Foam::Time::Time
             *this,
             IOobject::NO_READ,
             IOobject::NO_WRITE
-        )
+        ),
+        *this
     ),
 
     startTimeIndex_(0),

src/OpenFOAM/db/Time/Time.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     | Website:  https://openfoam.org
-    \\  /    A nd           | Copyright (C) 2011-2023 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2024 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -40,7 +40,7 @@ SourceFiles
 
 #include "TimePaths.H"
 #include "objectRegistry.H"
-#include "IOdictionary.H"
+#include "controlIOdictionary.H"
 #include "FIFOStack.H"
 #include "clock.H"
 #include "cpuTime.H"
@@ -80,8 +80,10 @@ class Time
         //- Is runtime modification of dictionaries allowed?
         Switch runTimeModifiable_;
 
+        friend class controlIOdictionary;
+
         //- The controlDict
-        IOdictionary controlDict_;
+        controlIOdictionary controlDict_;
 
 
 public:
@@ -306,9 +308,6 @@ public:
                 return runTimeModifiable_;
             }
 
-            //- Read control dictionary, update controls and time
-            virtual bool read();
-
             //- Read the objects that have been modified
             void readModifiedObjects();
 

src/OpenFOAM/db/Time/TimeIO.C

@@ -208,21 +208,6 @@ void Foam::Time::readDict()
 }
 
 
-bool Foam::Time::read()
-{
-    if (controlDict_.regIOobject::read())
-    {
-        readDict();
-
-        return true;
-    }
-    else
-    {
-        return false;
-    }
-}
-
-
 void Foam::Time::readModifiedObjects()
 {
     if (runTimeModifiable_)

src/OpenFOAM/db/Time/controlIOdictionary/controlIOdictionary.C

@@ -0,0 +1,71 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Copyright (C) 2024 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 "controlIOdictionary.H"
+#include "Time.H"
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::controlIOdictionary::controlIOdictionary
+(
+    const IOobject& io,
+    Time& time
+)
+:
+    IOdictionary(io),
+    time_(time)
+{}
+
+
+Foam::controlIOdictionary::controlIOdictionary
+(
+    const IOobject& io,
+    const dictionary& dict,
+    Time& time
+)
+:
+    IOdictionary(io, dict),
+    time_(time)
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+bool Foam::controlIOdictionary::read()
+{
+    if (regIOobject::read())
+    {
+        time_.readDict();
+
+        return true;
+    }
+    else
+    {
+        return false;
+    }
+}
+
+
+// ************************************************************************* //

src/OpenFOAM/db/Time/controlIOdictionary/controlIOdictionary.H

@@ -0,0 +1,109 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Copyright (C) 2024 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/>.
+
+Class
+    Foam::controlIOdictionary
+
+Description
+    controlDict specific IOdictionary to provide automatic read-update for Time
+
+SourceFiles
+    controlIOdictionary.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef controlIOdictionary_H
+#define controlIOdictionary_H
+
+#include "IOdictionary.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+// Forward declaration of classes
+class Time;
+
+/*---------------------------------------------------------------------------*\
+                     Class controlIOdictionary Declaration
+\*---------------------------------------------------------------------------*/
+
+class controlIOdictionary
+:
+    public IOdictionary
+{
+    // Private Data
+
+        //- Reference to Time to allow readDict() to be called
+        //  if the controlDict file changes
+        Time& time_;
+
+
+public:
+
+    // Constructors
+
+        //- Construct for Time
+        controlIOdictionary
+        (
+            const IOobject& io,
+            Time& time
+        );
+
+        //- Construct for Time
+        controlIOdictionary
+        (
+            const IOobject& io,
+            const dictionary& dict,
+            Time& time
+        );
+
+        //- Disallow default bitwise copy construction
+        controlIOdictionary(const controlIOdictionary&) = delete;
+
+
+    // Member Functions
+
+        // Read
+
+            //- Read the controlDict and update Time
+            bool read();
+
+
+    // Member Operators
+
+        //- Disallow default bitwise assignment
+        void operator=(const controlIOdictionary&) = delete;
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //