166 lines
4.4 KiB
C++
166 lines
4.4 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2012-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::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 "IOmanip.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class functionObjectFile Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class functionObjectFile
|
|
{
|
|
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Reference to the objectRegistry
|
|
const objectRegistry& obr_;
|
|
|
|
//- Prefix
|
|
const word prefix_;
|
|
|
|
|
|
// 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;
|
|
|
|
//- File header information
|
|
virtual void writeFileHeader(const label i = 0);
|
|
|
|
//- 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 from objectRegistry
|
|
functionObjectFile(const objectRegistry& obr, const word& prefix);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~functionObjectFile();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- 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 the current time to stream
|
|
void writeTime(Ostream& os) 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
|
|
|
|
// ************************************************************************* //
|