Add the OpenFOAM source tree

src/OpenFOAM/db/functionObjects/functionObjectFile/functionObjectFile.C

@@ -0,0 +1,347 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012-2014 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 "functionObjectFile.H"
+#include "Time.H"
+#include "polyMesh.H"
+#include "IFstream.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+const Foam::word Foam::functionObjectFile::outputPrefix = "postProcessing";
+Foam::label Foam::functionObjectFile::addChars = 7;
+
+// * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
+
+void Foam::functionObjectFile::initStream(Ostream& os) const
+{
+    os.setf(ios_base::scientific, ios_base::floatfield);
+//    os.precision(IOstream::defaultPrecision());
+    os.width(charWidth());
+}
+
+
+Foam::fileName Foam::functionObjectFile::baseFileDir() const
+{
+    fileName baseDir = obr_.time().path();
+
+    if (Pstream::parRun())
+    {
+        // Put in undecomposed case (Note: gives problems for
+        // distributed data running)
+        baseDir = baseDir/".."/outputPrefix;
+    }
+    else
+    {
+        baseDir = baseDir/outputPrefix;
+    }
+
+    // append mesh name if not default region
+    if (isA<polyMesh>(obr_))
+    {
+        const polyMesh& mesh = refCast<const polyMesh>(obr_);
+        if (mesh.name() != polyMesh::defaultRegion)
+        {
+            baseDir = baseDir/mesh.name();
+        }
+    }
+
+    return baseDir;
+}
+
+
+Foam::fileName Foam::functionObjectFile::baseTimeDir() const
+{
+    return baseFileDir()/prefix_/obr_.time().timeName();
+}
+
+
+void Foam::functionObjectFile::createFiles()
+{
+    if (Pstream::master())
+    {
+        const word startTimeName =
+            obr_.time().timeName(obr_.time().startTime().value());
+
+        label i = 0;
+        forAllConstIter(wordHashSet, names_, iter)
+        {
+            if (!filePtrs_.set(i))
+            {
+                fileName outputDir(baseFileDir()/prefix_/startTimeName);
+
+                mkDir(outputDir);
+
+                word fName(iter.key());
+
+                // check if file already exists
+                IFstream is(outputDir/(fName + ".dat"));
+                if (is.good())
+                {
+                    fName = fName + "_" + obr_.time().timeName();
+                }
+
+                filePtrs_.set(i, new OFstream(outputDir/(fName + ".dat")));
+
+                initStream(filePtrs_[i]);
+
+                writeFileHeader(i);
+
+                i++;
+            }
+        }
+    }
+}
+
+
+void Foam::functionObjectFile::writeFileHeader(const label i)
+{
+    // do nothing
+}
+
+
+void Foam::functionObjectFile::write()
+{
+    createFiles();
+}
+
+
+void Foam::functionObjectFile::resetNames(const wordList& names)
+{
+    names_.clear();
+    names_.insert(names);
+
+    if (Pstream::master())
+    {
+        filePtrs_.clear();
+        filePtrs_.setSize(names_.toc().size());
+
+        createFiles();
+    }
+}
+
+
+void Foam::functionObjectFile::resetName(const word& name)
+{
+    names_.clear();
+    names_.insert(name);
+
+    if (Pstream::master())
+    {
+        filePtrs_.clear();
+        filePtrs_.setSize(1);
+
+        createFiles();
+    }
+}
+
+
+Foam::Omanip<int> Foam::functionObjectFile::valueWidth(const label offset) const
+{
+    return setw(IOstream::defaultPrecision() + addChars + offset);
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjectFile::functionObjectFile
+(
+    const objectRegistry& obr,
+    const word& prefix
+)
+:
+    obr_(obr),
+    prefix_(prefix),
+    names_(),
+    filePtrs_()
+{}
+
+
+Foam::functionObjectFile::functionObjectFile
+(
+    const objectRegistry& obr,
+    const word& prefix,
+    const word& name
+)
+:
+    obr_(obr),
+    prefix_(prefix),
+    names_(),
+    filePtrs_()
+{
+    names_.clear();
+    names_.insert(name);
+
+    if (Pstream::master())
+    {
+        filePtrs_.clear();
+        filePtrs_.setSize(1);
+
+        // cannot create files - need to access virtual function
+    }
+}
+
+
+Foam::functionObjectFile::functionObjectFile
+(
+    const objectRegistry& obr,
+    const word& prefix,
+    const wordList& names
+)
+:
+    obr_(obr),
+    prefix_(prefix),
+    names_(names),
+    filePtrs_()
+{
+    names_.clear();
+    names_.insert(names);
+
+    if (Pstream::master())
+    {
+        filePtrs_.clear();
+        filePtrs_.setSize(names_.size());
+
+        // cannot create files - need to access virtual function
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::functionObjectFile::~functionObjectFile()
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+const Foam::wordHashSet& Foam::functionObjectFile::names() const
+{
+    return names_;
+}
+
+
+Foam::OFstream& Foam::functionObjectFile::file()
+{
+    if (!Pstream::master())
+    {
+        FatalErrorIn("Foam::OFstream& Foam::functionObjectFile::file()")
+            << "Request for file() can only be done by the master process"
+            << abort(FatalError);
+    }
+
+    if (filePtrs_.size() != 1)
+    {
+        WarningIn("Foam::Ostream& Foam::functionObjectFile::file()")
+            << "Requested single file, but multiple files are present"
+            << endl;
+    }
+
+    if (!filePtrs_.set(0))
+    {
+        FatalErrorIn("Foam::OFstream& Foam::functionObjectFile::file()")
+            << "File pointer at index " << 0 << " not allocated"
+            << abort(FatalError);
+    }
+
+    return filePtrs_[0];
+}
+
+
+Foam::PtrList<Foam::OFstream>& Foam::functionObjectFile::files()
+{
+    if (!Pstream::master())
+    {
+        FatalErrorIn("Foam::OFstream& Foam::functionObjectFile::files()")
+            << "Request for files() can only be done by the master process"
+            << abort(FatalError);
+    }
+
+    return filePtrs_;
+}
+
+
+Foam::OFstream& Foam::functionObjectFile::file(const label i)
+{
+    if (!Pstream::master())
+    {
+        FatalErrorIn
+        (
+            "Foam::OFstream& Foam::functionObjectFile::file(const label)"
+        )
+            << "Request for file(i) can only be done by the master process"
+            << abort(FatalError);
+    }
+
+    if (!filePtrs_.set(i))
+    {
+        FatalErrorIn("Foam::OFstream& Foam::functionObjectFile::file()")
+            << "File pointer at index " << i << " not allocated"
+            << abort(FatalError);
+    }
+
+    return filePtrs_[i];
+}
+
+
+Foam::label Foam::functionObjectFile::charWidth() const
+{
+    return IOstream::defaultPrecision() + addChars;
+}
+
+
+void Foam::functionObjectFile::writeCommented
+(
+    Ostream& os,
+    const string& str
+) const
+{
+    os  << setw(1) << "#" << setw(1) << ' '
+        << setw(charWidth() - 2) << str.c_str();
+}
+
+
+void Foam::functionObjectFile::writeTabbed
+(
+    Ostream& os,
+    const string& str
+) const
+{
+    os  << tab << setw(charWidth()) << str.c_str();
+}
+
+
+void Foam::functionObjectFile::writeHeader
+(
+    Ostream& os,
+    const string& str
+) const
+{
+    os  << setw(1) << "#" << setw(1) << ' '
+        << setf(ios_base::left) << setw(charWidth() - 2) << str.c_str() << nl;
+}
+
+
+// ************************************************************************* //

src/OpenFOAM/db/functionObjects/functionObjectFile/functionObjectFile.H

@@ -0,0 +1,212 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012-2014 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::functionObjectFile
+
+Description
+    Base class for output file data handling
+
+See Also
+    Foam::functionObject
+    Foam::OutputFilterFunctionObject
+
+SourceFiles
+    functionObjectFile.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjectFile_H
+#define functionObjectFile_H
+
+#include "objectRegistry.H"
+#include "OFstream.H"
+#include "PtrList.H"
+#include "HashSet.H"
+#include "IOmanip.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+
+/*---------------------------------------------------------------------------*\
+                     Class functionObjectFile Declaration
+\*---------------------------------------------------------------------------*/
+
+class functionObjectFile
+{
+private:
+
+    // Private data
+
+        //- Reference to the database
+        const objectRegistry& obr_;
+
+        //- Prefix
+        const word prefix_;
+
+        //- File names
+        wordHashSet names_;
+
+        //- File pointer
+        PtrList<OFstream> filePtrs_;
+
+
+protected:
+
+    // Protected Member Functions
+
+        //- Initialise the output stream for writing
+        virtual void initStream(Ostream& os) const;
+
+        //- Return the base directory for output
+        virtual fileName baseFileDir() const;
+
+        //- Return the base directory for the current time value
+        virtual fileName baseTimeDir() const;
+
+        //- Create the output file
+        virtual void createFiles();
+
+        //- File header information
+        virtual void writeFileHeader(const label i = 0);
+
+        //- Write function
+        virtual void write();
+
+        //- Reset the list of names from a wordList
+        virtual void resetNames(const wordList& names);
+
+        //- Reset the list of names to a single name entry
+        virtual void resetName(const word& name);
+
+        //- Return the value width when writing to stream with optional offset
+        virtual Omanip<int> valueWidth(const label offset = 0) const;
+
+        //- Disallow default bitwise copy construct
+        functionObjectFile(const functionObjectFile&);
+
+        //- Disallow default bitwise assignment
+        void operator=(const functionObjectFile&);
+
+
+public:
+
+    //- Directory prefix
+    static const word outputPrefix;
+
+    //- Additional characters for writing
+    static label addChars;
+
+    // Constructors
+
+        //- Construct null
+        functionObjectFile(const objectRegistry& obr, const word& prefix);
+
+        //- Construct from components
+        functionObjectFile
+        (
+            const objectRegistry& obr,
+            const word& prefix,
+            const word& name
+        );
+
+        //- Construct from components
+        functionObjectFile
+        (
+            const objectRegistry& obr,
+            const word& prefix,
+            const wordList& names
+        );
+
+
+    //- Destructor
+    virtual ~functionObjectFile();
+
+
+    // Member Functions
+
+        //- Return const access to the names
+        const wordHashSet& names() const;
+
+        //- Return access to the file (if only 1)
+        OFstream& file();
+
+        //- Return access to the files
+        PtrList<OFstream>& files();
+
+        //- Return file 'i'
+        OFstream& file(const label i);
+
+        //- Write a commented string to stream
+        void writeCommented
+        (
+            Ostream& os,
+            const string& str
+        ) const;
+
+        //- Write a tabbed string to stream
+        void writeTabbed
+        (
+            Ostream& os,
+            const string& str
+        ) const;
+
+        //- Write a commented header to stream
+        void writeHeader
+        (
+            Ostream& os,
+            const string& str
+        ) const;
+
+        //- Write a (commented) header property and value pair
+        template<class Type>
+        void writeHeaderValue
+        (
+            Ostream& os,
+            const string& property,
+            const Type& value
+        ) const;
+
+        //- Return width of character stream output
+        label charWidth() const;
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#ifdef NoRepository
+    #include "functionObjectFileTemplates.C"
+#endif
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

src/OpenFOAM/db/functionObjects/functionObjectFile/functionObjectFileTemplates.C

@@ -0,0 +1,44 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2013 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 "OStringStream.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+template<class Type>
+void Foam::functionObjectFile::writeHeaderValue
+(
+    Ostream& os,
+    const string& property,
+    const Type& value
+) const
+{
+    os  << setw(1) << '#' << setw(1) << ' '
+        << setw(charWidth() - 2) << setf(ios_base::left) << property.c_str()
+        << setw(1) << ':' << setw(1) << ' ' << value << nl;
+}
+
+
+// ************************************************************************* //