src/OpenFOAM/db/Time/TimeIO.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "Time.H"
  27 #include "Pstream.H"
  28
  29 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  30
  31 void Foam::Time::readDict()
  32 {
  33     if (!deltaTchanged_)
  34     {
  35         deltaT_ = readScalar(controlDict_.lookup("deltaT"));
  36     }
  37
  38     if (controlDict_.found("writeControl"))
  39     {
  40         writeControl_ = writeControlNames_.read
  41         (
  42             controlDict_.lookup("writeControl")
  43         );
  44     }
  45
  46     scalar oldWriteInterval = writeInterval_;
  47     if (controlDict_.readIfPresent("writeInterval", writeInterval_))
  48     {
  49         if (writeControl_ == wcTimeStep && label(writeInterval_) < 1)
  50         {
  51             FatalIOErrorIn("Time::readDict()", controlDict_)
  52                 << "writeInterval < 1 for writeControl timeStep"
  53                 << exit(FatalIOError);
  54         }
  55     }
  56     else
  57     {
  58         controlDict_.lookup("writeFrequency") >> writeInterval_;
  59     }
  60
  61     if (oldWriteInterval != writeInterval_)
  62     {
  63         switch (writeControl_)
  64         {
  65             case wcRunTime:
  66             case wcAdjustableRunTime:
  67                 // Recalculate outputTimeIndex_ to be in units of current
  68                 // writeInterval.
  69                 outputTimeIndex_ = label
  70                 (
  71                     outputTimeIndex_
  72                   * oldWriteInterval
  73                   / writeInterval_
  74                 );
  75             break;
  76
  77             default:
  78             break;
  79         }
  80     }
  81
  82     if (controlDict_.readIfPresent("purgeWrite", purgeWrite_))
  83     {
  84         if (purgeWrite_ < 0)
  85         {
  86             WarningIn("Time::readDict()")
  87                 << "invalid value for purgeWrite " << purgeWrite_
  88                 << ", should be >= 0, setting to 0"
  89                 << endl;
  90
  91             purgeWrite_ = 0;
  92         }
  93     }
  94
  95     if (controlDict_.found("timeFormat"))
  96     {
  97         const word formatName(controlDict_.lookup("timeFormat"));
  98
  99         if (formatName == "general")
 100         {
 101             format_ = general;
 102         }
 103         else if (formatName == "fixed")
 104         {
 105             format_ = fixed;
 106         }
 107         else if (formatName == "scientific")
 108         {
 109             format_ = scientific;
 110         }
 111         else
 112         {
 113             WarningIn("Time::readDict()")
 114                 << "unsupported time format " << formatName
 115                 << endl;
 116         }
 117     }
 118
 119     controlDict_.readIfPresent("timePrecision", precision_);
 120
 121     // stopAt at 'endTime' or a specified value
 122     // if nothing is specified, the endTime is zero
 123     if (controlDict_.found("stopAt"))
 124     {
 125         stopAt_ = stopAtControlNames_.read(controlDict_.lookup("stopAt"));
 126
 127         if (stopAt_ == saEndTime)
 128         {
 129             controlDict_.lookup("endTime") >> endTime_;
 130         }
 131         else
 132         {
 133             endTime_ = GREAT;
 134         }
 135     }
 136     else if (!controlDict_.readIfPresent("endTime", endTime_))
 137     {
 138         endTime_ = 0;
 139     }
 140
 141     dimensionedScalar::name() = timeName(value());
 142
 143     if (controlDict_.found("writeVersion"))
 144     {
 145         writeVersion_ = IOstream::versionNumber
 146         (
 147             controlDict_.lookup("writeVersion")
 148         );
 149     }
 150
 151     if (controlDict_.found("writeFormat"))
 152     {
 153         writeFormat_ = IOstream::formatEnum
 154         (
 155             controlDict_.lookup("writeFormat")
 156         );
 157     }
 158
 159     if (controlDict_.found("writePrecision"))
 160     {
 161         IOstream::defaultPrecision
 162         (
 163             readUint(controlDict_.lookup("writePrecision"))
 164         );
 165
 166         Sout.precision(IOstream::defaultPrecision());
 167         Serr.precision(IOstream::defaultPrecision());
 168
 169         Pout.precision(IOstream::defaultPrecision());
 170         Perr.precision(IOstream::defaultPrecision());
 171
 172         FatalError().precision(IOstream::defaultPrecision());
 173         FatalIOError.error::operator()().precision
 174         (
 175             IOstream::defaultPrecision()
 176         );
 177     }
 178
 179     if (controlDict_.found("writeCompression"))
 180     {
 181         writeCompression_ = IOstream::compressionEnum
 182         (
 183             controlDict_.lookup("writeCompression")
 184         );
 185     }
 186
 187     controlDict_.readIfPresent("graphFormat", graphFormat_);
 188     controlDict_.readIfPresent("runTimeModifiable", runTimeModifiable_);
 189
 190     if (!runTimeModifiable_ && controlDict_.watchIndex() != -1)
 191     {
 192         removeWatch(controlDict_.watchIndex());
 193         controlDict_.watchIndex() = -1;
 194     }
 195 }
 196
 197
 198 bool Foam::Time::read()
 199 {
 200     if (controlDict_.regIOobject::read())
 201     {
 202         readDict();
 203         return true;
 204     }
 205     else
 206     {
 207         return false;
 208     }
 209 }
 210
 211
 212 void Foam::Time::readModifiedObjects()
 213 {
 214     if (runTimeModifiable_)
 215     {
 216         // Get state of all monitored objects (=registered objects with a
 217         // valid filePath).
 218         // Note: requires same ordering in objectRegistries on different
 219         // processors!
 220         monitorPtr_().updateStates
 221         (
 222             (
 223                 regIOobject::fileModificationChecking == inotifyMaster
 224              || regIOobject::fileModificationChecking == timeStampMaster
 225             ),
 226             Pstream::parRun()
 227         );
 228
 229         // Time handling is special since controlDict_ is the one dictionary
 230         // that is not registered to any database.
 231
 232         if (controlDict_.readIfModified())
 233         {
 234            readDict();
 235            functionObjects_.read();
 236         }
 237
 238         bool registryModified = objectRegistry::modified();
 239
 240         if (registryModified)
 241         {
 242             objectRegistry::readModifiedObjects();
 243         }
 244     }
 245 }
 246
 247
 248 bool Foam::Time::writeObject
 249 (
 250     IOstream::streamFormat fmt,
 251     IOstream::versionNumber ver,
 252     IOstream::compressionType cmp
 253 ) const
 254 {
 255     if (outputTime())
 256     {
 257         IOdictionary timeDict
 258         (
 259             IOobject
 260             (
 261                 "time",
 262                 timeName(),
 263                 "uniform",
 264                 *this,
 265                 IOobject::NO_READ,
 266                 IOobject::NO_WRITE,
 267                 false
 268             )
 269         );
 270
 271         timeDict.add("index", timeIndex_);
 272         timeDict.add("deltaT", deltaT_);
 273         timeDict.add("deltaT0", deltaT0_);
 274
 275         timeDict.regIOobject::writeObject(fmt, ver, cmp);
 276         bool writeOK = objectRegistry::writeObject(fmt, ver, cmp);
 277
 278         if (writeOK && purgeWrite_)
 279         {
 280             previousOutputTimes_.push(timeName());
 281
 282             while (previousOutputTimes_.size() > purgeWrite_)
 283             {
 284                 rmDir(objectRegistry::path(previousOutputTimes_.pop()));
 285             }
 286         }
 287
 288         return writeOK;
 289     }
 290     else
 291     {
 292         return false;
 293     }
 294 }
 295
 296
 297 bool Foam::Time::writeNow()
 298 {
 299     outputTime_ = true;
 300     return write();
 301 }
 302
 303
 304 bool Foam::Time::writeAndEnd()
 305 {
 306     stopAt_  = saWriteNow;
 307     endTime_ = value();
 308
 309     return writeNow();
 310 }
 311
 312
 313 // ************************************************************************* //