GIT: Initial state after latest Foundation merge

src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.C

@@ -0,0 +1,149 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
+     \\/     M anipulation  | Copyright (C) 2015 OpenCFD Ltd.
+-------------------------------------------------------------------------------
+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 "timeActivatedFileUpdate.H"
+#include "Time.H"
+#include "polyMesh.H"
+#include "addToRunTimeSelectionTable.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+    defineTypeNameAndDebug(timeActivatedFileUpdate, 0);
+
+    addToRunTimeSelectionTable
+    (
+        functionObject,
+        timeActivatedFileUpdate,
+        dictionary
+    );
+}
+}
+
+
+// * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
+
+void Foam::functionObjects::timeActivatedFileUpdate::updateFile()
+{
+    label i = lastIndex_;
+    while
+    (
+        i < timeVsFile_.size()-1
+     && timeVsFile_[i+1].first() < time_.value()
+    )
+    {
+        i++;
+    }
+
+    if (i > lastIndex_)
+    {
+        Log << nl << type() << ": copying file" << nl << timeVsFile_[i].second()
+            << nl << "to:" << nl << fileToUpdate_ << nl << endl;
+
+        cp(timeVsFile_[i].second(), fileToUpdate_);
+        lastIndex_ = i;
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::timeActivatedFileUpdate::timeActivatedFileUpdate
+(
+    const word& name,
+    const Time& runTime,
+    const dictionary& dict
+)
+:
+    functionObject(name),
+    time_(runTime),
+    fileToUpdate_("unknown-fileToUpdate"),
+    timeVsFile_(),
+    lastIndex_(-1)
+{
+    read(dict);
+}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::functionObjects::timeActivatedFileUpdate::~timeActivatedFileUpdate()
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+bool Foam::functionObjects::timeActivatedFileUpdate::read
+(
+    const dictionary& dict
+)
+{
+    dict.lookup("fileToUpdate") >> fileToUpdate_;
+    dict.lookup("timeVsFile") >> timeVsFile_;
+
+    lastIndex_ = -1;
+    fileToUpdate_.expand();
+
+    Log << type() << " " << name_ << " output:" << nl
+        << "    time vs file list:" << endl;
+
+    forAll(timeVsFile_, i)
+    {
+        timeVsFile_[i].second() = timeVsFile_[i].second().expand();
+        if (!isFile(timeVsFile_[i].second()))
+        {
+            FatalErrorInFunction
+                << "File: " << timeVsFile_[i].second() << " not found"
+                << nl << exit(FatalError);
+        }
+
+        Log << "    " << timeVsFile_[i].first() << tab
+            << timeVsFile_[i].second() << endl;
+    }
+
+    updateFile();
+
+    return true;
+}
+
+
+bool Foam::functionObjects::timeActivatedFileUpdate::execute()
+{
+    updateFile();
+
+    return true;
+}
+
+
+bool Foam::functionObjects::timeActivatedFileUpdate::write()
+{
+    return true;
+}
+
+
+// ************************************************************************* //

src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H

@@ -0,0 +1,164 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2011-2016 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::functionObjects::timeActivatedFileUpdate
+
+Group
+    grpUtilitiesFunctionObjects
+
+Description
+    Performs a file copy/replacement once a specified time has been reached.
+
+    Example usage to update the fvSolution dictionary at various times
+    throughout the calculation:
+    \verbatim
+    fileUpdate1
+    {
+        type              timeActivatedFileUpdate;
+        libs              ("libutilityFunctionObjects.so");
+        writeControl      timeStep;
+        writeInterval     1;
+        fileToUpdate      "$FOAM_CASE/system/fvSolution";
+        timeVsFile
+        (
+            (-1 "$FOAM_CASE/system/fvSolution.0")
+            (0.10 "$FOAM_CASE/system/fvSolution.10")
+            (0.20 "$FOAM_CASE/system/fvSolution.20")
+            (0.35 "$FOAM_CASE/system/fvSolution.35")
+        );
+        ...
+    }
+    \endverbatim
+
+    \heading Function object usage
+    \table
+        Property     | Description             | Required    | Default value
+        type         | Type name: timeActivatedFileUpdate | yes |
+        fileToUpdate | Name of file to update  | yes         |
+        timeVsFile   | List of time vs file    | yes         |
+    \endtable
+
+
+SourceFiles
+    timeActivatedFileUpdate.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_timeActivatedFileUpdate_H
+#define functionObjects_timeActivatedFileUpdate_H
+
+#include "functionObject.H"
+#include "Tuple2.H"
+#include "Switch.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+// Forward declaration of classes
+class Time;
+
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                  Class timeActivatedFileUpdate Declaration
+\*---------------------------------------------------------------------------*/
+
+class timeActivatedFileUpdate
+:
+    public functionObject
+{
+    // Private data
+
+        //- Reference to Time
+        const Time& time_;
+
+        //- Name of file to update
+        fileName fileToUpdate_;
+
+        //- List of times vs filenames
+        List<Tuple2<scalar, fileName>> timeVsFile_;
+
+        //- Index of last file copied
+        label lastIndex_;
+
+
+    // Private Member Functions
+
+        //- Update file
+        void updateFile();
+
+        //- Disallow default bitwise copy construct
+        timeActivatedFileUpdate(const timeActivatedFileUpdate&);
+
+        //- Disallow default bitwise assignment
+        void operator=(const timeActivatedFileUpdate&);
+
+
+public:
+
+    //- Runtime type information
+    TypeName("timeActivatedFileUpdate");
+
+
+    // Constructors
+
+        //- Construct from Time and dictionary
+        timeActivatedFileUpdate
+        (
+            const word& name,
+            const Time& runTime,
+            const dictionary& dict
+        );
+
+
+    //- Destructor
+    virtual ~timeActivatedFileUpdate();
+
+
+    // Member Functions
+
+        //- Read the timeActivatedFileUpdate data
+        virtual bool read(const dictionary&);
+
+        //- Execute file updates
+        virtual bool execute();
+
+        //- Do nothing
+        virtual bool write();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //