File size: 3,507 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 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/>.
Description
Writes the header description of the File to the stream
associated with the File.
\*---------------------------------------------------------------------------*/
#include "IOobject.H"
#include "objectRegistry.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
bool Foam::IOobject::writeHeader
(
Ostream& os,
const IOstream::versionNumber version,
const IOstream::streamFormat format,
const word& type,
const string& note,
const fileName& location,
const word& name
)
{
if (!os.good())
{
InfoInFunction
<< "No stream open for write" << nl
<< os.info() << endl;
return false;
}
writeBanner(os) << foamFile << "\n{\n";
if (version != IOstream::currentVersion)
{
os << " version " << version << ";\n";
}
os << " format " << format << ";\n"
<< " class " << type << ";\n";
if (note.size())
{
os << " note " << note << ";\n";
}
if (location.size())
{
os << " location " << location << ";\n";
}
os << " object " << name << ";\n"
<< "}" << nl;
writeDivider(os) << nl;
return true;
}
bool Foam::IOobject::writeHeader
(
Ostream& os,
const dictionary& foamFileDict
)
{
return writeHeader
(
os,
foamFileDict.lookupOrDefault<IOstream::versionNumber>
(
"version",
IOstream::currentVersion
),
foamFileDict.found("format")
? IOstream::formatEnum(foamFileDict.lookup<word>("format"))
: IOstream::ASCII,
foamFileDict.lookupOrDefault<word>("class", dictionary::typeName),
foamFileDict.lookupOrDefault<string>("note", string::null),
foamFileDict.lookupOrDefault<fileName>("location", fileName::null),
foamFileDict.lookupOrDefault<word>("name", os.name().name())
);
}
bool Foam::IOobject::writeHeader(Ostream& os, const word& type) const
{
return writeHeader
(
os,
os.version(),
os.format(),
type,
note(),
instance()/db().dbDir()/local(),
name()
);
}
bool Foam::IOobject::writeHeader(Ostream& os) const
{
return writeHeader(os, type());
}
// ************************************************************************* //
|