File size: 7,927 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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 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 "regIOobject.H"
#include "IFstream.H"
#include "dictionary.H"
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
bool Foam::regIOobject::readHeaderOk
(
const IOstream::streamFormat defaultFormat,
const word& typeName
)
{
// Everyone check or just master
bool masterOnly =
global()
&& (
regIOobject::fileModificationChecking == timeStampMaster
|| regIOobject::fileModificationChecking == inotifyMaster
);
// Check if header is ok for READ_IF_PRESENT
bool isHeaderOk = false;
if (readOpt() == IOobject::READ_IF_PRESENT)
{
if (masterOnly)
{
if (Pstream::master())
{
isHeaderOk = headerOk();
}
Pstream::scatter(isHeaderOk);
}
else
{
isHeaderOk = headerOk();
}
}
if
(
(
readOpt() == IOobject::MUST_READ
|| readOpt() == IOobject::MUST_READ_IF_MODIFIED
)
|| isHeaderOk
)
{
return fileHandler().read(*this, masterOnly, defaultFormat, typeName);
}
else
{
return false;
}
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
Foam::Istream& Foam::regIOobject::readStream(const bool read)
{
if (IFstream::debug)
{
InfoInFunction
<< "Reading object " << name()
<< " from file " << objectPath()
<< endl;
}
if (readOpt() == NO_READ)
{
FatalErrorInFunction
<< "NO_READ specified for read-constructor of object " << name()
<< " of class " << headerClassName()
<< abort(FatalError);
}
// Construct object stream and read header if not already constructed
if (!isPtr_.valid())
{
fileName objPath;
if (watchIndices_.size())
{
// File is being watched. Read exact file that is being watched.
objPath = fileHandler().getFile(watchIndices_.last());
}
else
{
// Search intelligently for file
objPath = filePath();
if (IFstream::debug)
{
Pout<< "regIOobject::readStream() : "
<< "found object " << name()
<< " (global " << global() << ")"
<< " in file " << objPath
<< endl;
}
}
isPtr_ = fileHandler().readStream(*this, objPath, type(), read);
}
return isPtr_();
}
Foam::Istream& Foam::regIOobject::readStream
(
const word& expectName,
const bool read
)
{
if (IFstream::debug)
{
Pout<< "regIOobject::readStream(const word&) : "
<< "reading object " << name()
<< endl;
}
// Construct IFstream if not already constructed
if (!isPtr_.valid())
{
readStream(read);
// Check the className of the regIOobject
// dictionary is an allowable name so that any file can be processed
// as raw dictionary and the original type preserved
if
(
read
&& expectName.size()
&& headerClassName() != expectName
&& headerClassName() != dictionary::typeName
)
{
if (expectName == dictionary::typeName)
{
const_cast<word&>(type()) = headerClassName();
}
else
{
IOWarningInFunction(isPtr_())
<< "Unexpected class name " << headerClassName()
<< ", expected " << expectName << endl
<< " while reading object " << name()
<< endl;
}
}
}
return isPtr_();
}
void Foam::regIOobject::close()
{
if (IFstream::debug)
{
Pout<< "regIOobject::close() : "
<< "finished reading "
<< (isPtr_.valid() ? isPtr_().name() : "dummy")
<< endl;
}
isPtr_.clear();
}
bool Foam::regIOobject::readData(Istream&)
{
return false;
}
bool Foam::regIOobject::read()
{
// Note: cannot do anything in readStream itself since this is used by
// e.g. GeometricField.
// Save old watchIndices and clear (so the list of included files can
// change)
fileNameList oldWatchFiles;
if (watchIndices_.size())
{
oldWatchFiles.setSize(watchIndices_.size());
forAll(watchIndices_, i)
{
oldWatchFiles[i] = fileHandler().getFile(watchIndices_[i]);
}
forAllReverse(watchIndices_, i)
{
fileHandler().removeWatch(watchIndices_[i]);
}
watchIndices_.clear();
}
// Read
bool masterOnly =
global()
&& (
regIOobject::fileModificationChecking == timeStampMaster
|| regIOobject::fileModificationChecking == inotifyMaster
);
// Note: IOstream::binary flag is for all the processor comms. (Only for
// dictionaries should it be ascii)
bool ok = fileHandler().read(*this, masterOnly, IOstream::BINARY, type());
if (oldWatchFiles.size())
{
// Re-watch master file
addWatch();
}
return ok;
}
bool Foam::regIOobject::modified() const
{
forAllReverse(watchIndices_, i)
{
if (fileHandler().getState(watchIndices_[i]) != fileMonitor::UNMODIFIED)
{
return true;
}
}
return false;
}
bool Foam::regIOobject::readIfModified()
{
// Get index of modified file so we can give nice message. Could instead
// just call above modified()
label modified = -1;
forAllReverse(watchIndices_, i)
{
if (fileHandler().getState(watchIndices_[i]) != fileMonitor::UNMODIFIED)
{
modified = watchIndices_[i];
break;
}
}
if (modified != -1)
{
const fileName fName = fileHandler().getFile(watchIndices_.last());
if (modified == watchIndices_.last())
{
Info<< "regIOobject::readIfModified() : " << nl
<< " Re-reading object " << name()
<< " from file " << fName << endl;
}
else
{
Info<< "regIOobject::readIfModified() : " << nl
<< " Re-reading object " << name()
<< " from file " << fName
<< " because of modified file "
<< fileHandler().getFile(modified)
<< endl;
}
return read();
}
else
{
return false;
}
}
// ************************************************************************* //
|