Skip to content
Snippets Groups Projects
writeFile.H 5.7 KiB
Newer Older
  • Learn to ignore specific revisions
  • /*---------------------------------------------------------------------------*\
      =========                 |
      \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
       \\    /   O peration     |
    
        \\  /    A nd           | Copyright (C) 2012-2016 OpenFOAM Foundation
    
         \\/     M anipulation  | Copyright (C) 2015-2018 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/>.
    
    Class
    
        Foam::functionObjects::writeFile
    
        functionObject base class for writing single files
    
    
    \*---------------------------------------------------------------------------*/
    
    
    #ifndef functionObjects_writeFile_H
    #define functionObjects_writeFile_H
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    namespace Foam
    {
    
    
    /*---------------------------------------------------------------------------*\
    
                              Class writeFile Declaration
    
    \*---------------------------------------------------------------------------*/
    
    
            //- Reference to the region objectRegistry
            const objectRegistry& fileObr_;
    
    andy's avatar
    andy committed
            const word prefix_;
    
            //- Name of file
            word fileName_;
    
            autoPtr<OFstream> filePtr_;
    
            //- Write precision
            label writePrecision_;
    
            //- Flag to enable/disable writing to file
            bool writeToFile_;
    
    
            //- Flag to identify whether the header has been written
            bool writtenHeader_;
    
    
        // Protected Member Functions
    
    
            //- Initialise the output stream for writing
    
            void initStream(Ostream& os) const;
    
            fileName baseFileDir() const;
    
            //- Return the base directory for the current time value
    
            fileName baseTimeDir() const;
    
            //- Return an autoPtr to a new file for a given time
            virtual autoPtr<OFstream> createFile
            (
                const word& name,
                const scalar time
            ) const;
    
    
            //- Return an autoPtr to a new file
    
            virtual autoPtr<OFstream> createFile
            (
                const word& name
            ) const;
    
            //- Reset internal file pointer to new file with new name
            virtual void resetFile(const word& name);
    
            //- Return the value width when writing to stream with optional offset
    
            Omanip<int> valueWidth(const label offset = 0) const;
    
    
            //- No copy construct
            writeFile(const writeFile&) = delete;
    
            //- No copy assignment
            void operator=(const writeFile&) = delete;
    
        //- Additional characters for writing
        static label addChars;
    
    
            writeFile
            (
                const objectRegistry& obr,
                const word& prefix
            );
    
            //- Construct from objectRegistry and prefix, and read options
            //  from dictionary
    
            (
                const objectRegistry& obr,
                const word& prefix,
    
                const word& fileName,
                const dictionary& dict
    
            virtual bool read(const dictionary& dict);
    
            //- Return access to the file (if only 1)
    
            virtual OFstream& file();
    
            virtual bool writeToFile() const;
    
    
            //- Return width of character stream output
    
            virtual label charWidth() const;
    
            //- Write a commented string to stream
    
            virtual void writeCommented(Ostream& os, const string& str) const;
    
    
            //- Write a tabbed string to stream
    
            virtual void writeTabbed(Ostream& os, const string& str) const;
    
    
            //- Write a commented header to stream
    
            virtual void writeHeader(Ostream& os, const string& str) const;
    
            //- Write the current time to stream
    
            virtual void writeTime(Ostream& os) const;
    
            //- Write a break marker to the stream
            virtual void writeBreak(Ostream& os) const;
    
    
            //- Write a (commented) header property and value pair
    
            void writeHeaderValue
    
                Ostream& os,
                const string& property,
                const Type& value
    
    };
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    } // End namespace functionObjects
    
    } // End namespace Foam
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
        #include "writeFileTemplates.C"
    
    #endif
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    #endif
    
    // ************************************************************************* //