File size: 3,758 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2024-2026 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::logFile
Description
functionObject support for writing log files
e.g. residuals or integral field values vs time.
See also
Foam::functionObject
Foam::functionObjects::writeFile
SourceFiles
logFile.C
\*---------------------------------------------------------------------------*/
#ifndef logFile_functionObject_H
#define logFile_functionObject_H
#include "writeFile.H"
#include "OFstream.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class logFile Declaration
\*---------------------------------------------------------------------------*/
class logFile
:
public writeFile
{
// Private data
//- File name
word name_;
//- File stream
OFstream file_;
// Private Member Functions
fileName filePathName() const;
public:
// Constructors
//- Construct from objectRegistry, prefix and file name
logFile
(
const objectRegistry& obr,
const word& prefix,
const word& name
);
//- Disallow default bitwise copy construction
logFile(const logFile&) = delete;
//- Destructor
~logFile();
// Member Functions
//- Return the log file name
const word& name() const;
//- Write the time and column headers
void writeTimeColumnHeaders(const wordList& titles);
//- Write a single column value
template<class T>
void write(const T& t)
{
file_ << tab << setw(charWidth()) << t << endl;
}
//- Write the column values
template<class T, class... Args>
void write(const T& t, const Args& ... args)
{
file_ << tab << setw(charWidth()) << t;
write(args...);
}
//- Write the time and column values
template<class... Args>
void writeTime(const Args& ... args)
{
writeFile::writeTime(file_);
write(args...);
}
// Member Operators
//- Disallow default bitwise assignment
void operator=(const logFile&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|