src/foam/db/objectRegistry/objectRegistry.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "objectRegistry.H"
  27 #include "foamTime.H"
  28
  29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  30
  31 defineTypeNameAndDebug(Foam::objectRegistry, 0);
  32
  33
  34 // * * * * * * * * * * * * * * * * Constructors *  * * * * * * * * * * * * * //
  35
  36 Foam::objectRegistry::objectRegistry
  37 (
  38     const Time& t,
  39     const label nIoObjects
  40 )
  41 :
  42     regIOobject
  43     (
  44         IOobject
  45         (
  46             string::validate<word>(t.caseName()),
  47             t,
  48             IOobject::NO_READ,
  49             IOobject::AUTO_WRITE
  50         ),
  51         true    // to flag that this is the top-level regIOobject
  52     ),
  53     HashTable<regIOobject*>(nIoObjects),
  54     time_(t),
  55     parent_(t),
  56     dbDir_(name()),
  57     event_(1)
  58 {}
  59
  60
  61 Foam::objectRegistry::objectRegistry
  62 (
  63     const IOobject& io,
  64     const label nIoObjects
  65 )
  66 :
  67     regIOobject(io),
  68     HashTable<regIOobject*>(nIoObjects),
  69     time_(io.time()),
  70     parent_(io.db()),
  71     dbDir_(parent_.dbDir()/local()/name()),
  72     event_(1)
  73 {
  74     writeOpt() = IOobject::AUTO_WRITE;
  75 }
  76
  77
  78 Foam::objectRegistry::objectRegistry
  79 (
  80     const IOobject& io,
  81     const fileName& dbDir,
  82     const label nIoObjects
  83 )
  84 :
  85     regIOobject(io),
  86     HashTable<regIOobject*>(nIoObjects),
  87     time_(io.time()),
  88     parent_(io.db()),
  89     dbDir_(dbDir),
  90     event_(1)
  91 {
  92     writeOpt() = IOobject::AUTO_WRITE;
  93 }
  94
  95
  96 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  97
  98 Foam::objectRegistry::~objectRegistry()
  99 {
 100     List<regIOobject*> myObjects(size());
 101     label nMyObjects = 0;
 102
 103     for (iterator iter = begin(); iter != end(); ++iter)
 104     {
 105         if (iter()->ownedByRegistry())
 106         {
 107             myObjects[nMyObjects++] = iter();
 108         }
 109     }
 110
 111     for (label i=0; i<nMyObjects; i++)
 112     {
 113         checkOut(*myObjects[i]);
 114     }
 115 }
 116
 117
 118 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 119
 120 const Foam::Time& Foam::objectRegistry::time() const
 121 {
 122     return time_;
 123 }
 124
 125
 126 Foam::wordList Foam::objectRegistry::names() const
 127 {
 128     wordList objectNames(size());
 129
 130     label count=0;
 131     for (const_iterator iter = cbegin(); iter != cend(); ++iter)
 132     {
 133         objectNames[count++] = iter()->name();
 134     }
 135
 136     return objectNames;
 137 }
 138
 139
 140 Foam::wordList Foam::objectRegistry::names(const word& ClassName) const
 141 {
 142     wordList objectNames(size());
 143
 144     label count=0;
 145     for (const_iterator iter = cbegin(); iter != cend(); ++iter)
 146     {
 147         if (iter()->type() == ClassName)
 148         {
 149             objectNames[count++] = iter()->name();
 150         }
 151     }
 152
 153     objectNames.setSize(count);
 154
 155     return objectNames;
 156 }
 157
 158
 159 Foam::fileName Foam::objectRegistry::mangleFileName
 160 (
 161     const fileName& fName
 162 ) const
 163 {
 164     return fName;
 165 }
 166
 167
 168 const Foam::objectRegistry& Foam::objectRegistry::subRegistry
 169 (
 170     const word& name
 171 ) const
 172 {
 173     return lookupObject<objectRegistry>(name);
 174 }
 175
 176
 177 Foam::label Foam::objectRegistry::getEvent() const
 178 {
 179     label curEvent = event_++;
 180
 181     if (event_ == labelMax)
 182     {
 183         WarningIn("objectRegistry::getEvent() const")
 184             << "Event counter has overflowed. Resetting counter on all"
 185             << " dependent objects." << endl
 186             << "This might cause extra evaluations." << endl;
 187
 188         // Reset event counter
 189         curEvent = 1;
 190         event_ = 2;
 191
 192         for (const_iterator iter = begin(); iter != end(); ++iter)
 193         {
 194             const regIOobject& io = *iter();
 195
 196             if (objectRegistry::debug)
 197             {
 198                 Pout<< "objectRegistry::getEvent() : "
 199                     << "resetting count on " << iter.key() << endl;
 200             }
 201
 202             if (io.eventNo() != 0)
 203             {
 204                 const_cast<regIOobject&>(io).eventNo() = curEvent;
 205             }
 206         }
 207     }
 208
 209     return curEvent;
 210 }
 211
 212
 213 bool Foam::objectRegistry::checkIn(regIOobject& io) const
 214 {
 215     if (objectRegistry::debug)
 216     {
 217         Pout<< "objectRegistry::checkIn(regIOobject&) : "
 218             << name() << " : checking in " << io.name()
 219             << endl;
 220     }
 221
 222     return const_cast<objectRegistry&>(*this).insert(io.name(), &io);
 223 }
 224
 225
 226 bool Foam::objectRegistry::checkOut(regIOobject& io) const
 227 {
 228     iterator iter = const_cast<objectRegistry&>(*this).find(io.name());
 229
 230     if (iter != end())
 231     {
 232         if (objectRegistry::debug)
 233         {
 234             Pout<< "objectRegistry::checkOut(regIOobject&) : "
 235                 << name() << " : checking out " << io.name()
 236                 << endl;
 237         }
 238
 239         if (iter() != &io)
 240         {
 241             if (objectRegistry::debug)
 242             {
 243                 WarningIn("objectRegistry::checkOut(regIOobject&)")
 244                     << name() << " : attempt to checkOut copy of " << io.name()
 245                     << endl;
 246             }
 247
 248             return false;
 249         }
 250         else
 251         {
 252             regIOobject* object = iter();
 253
 254             bool hasErased = const_cast<objectRegistry&>(*this).erase(iter);
 255
 256             if (io.ownedByRegistry())
 257             {
 258                 delete object;
 259             }
 260
 261             return hasErased;
 262         }
 263     }
 264     else
 265     {
 266         if (objectRegistry::debug)
 267         {
 268             Pout<< "objectRegistry::checkOut(regIOobject&) : "
 269                 << name() << " : could not find " << io.name()
 270                 << " in registry " << name()
 271                 << endl;
 272         }
 273     }
 274
 275     return false;
 276 }
 277
 278
 279 void Foam::objectRegistry::rename(const word& newName)
 280 {
 281     regIOobject::rename(newName);
 282
 283     // adjust dbDir_ as well
 284     string::size_type i = dbDir_.rfind('/');
 285
 286     if (i == string::npos)
 287     {
 288         dbDir_ = newName;
 289     }
 290     else
 291     {
 292         dbDir_.replace(i+1, string::npos, newName);
 293     }
 294 }
 295
 296
 297 bool Foam::objectRegistry::modified() const
 298 {
 299     for (const_iterator iter = cbegin(); iter != cend(); ++iter)
 300     {
 301         if (iter()->modified())
 302         {
 303             return true;
 304         }
 305     }
 306
 307     return false;
 308 }
 309
 310
 311 void Foam::objectRegistry::readModifiedObjects()
 312 {
 313     for (iterator iter = begin(); iter != end(); ++iter)
 314     {
 315         if (objectRegistry::debug)
 316         {
 317             Pout<< "objectRegistry::readModifiedObjects() : "
 318                 << name() << " : Considering reading object "
 319                 << iter()->name()
 320                 << endl;
 321         }
 322
 323         iter()->readIfModified();
 324     }
 325 }
 326
 327
 328 bool Foam::objectRegistry::readIfModified()
 329 {
 330     readModifiedObjects();
 331     return true;
 332 }
 333
 334
 335 bool Foam::objectRegistry::writeObject
 336 (
 337     IOstream::streamFormat fmt,
 338     IOstream::versionNumber ver,
 339     IOstream::compressionType cmp
 340 ) const
 341 {
 342     bool ok = true;
 343
 344     for (const_iterator iter = cbegin(); iter != cend(); ++iter)
 345     {
 346         if (objectRegistry::debug)
 347         {
 348             Pout<< "objectRegistry::write() : "
 349                 << name() << " : Considering writing object "
 350                 << iter()->name()
 351                 << " with writeOpt " << iter()->writeOpt()
 352                 << " to file " << iter()->objectPath()
 353                 << endl;
 354         }
 355
 356         if (iter()->writeOpt() != NO_WRITE)
 357         {
 358             ok = iter()->writeObject(fmt, ver, cmp) && ok;
 359         }
 360     }
 361
 362     return ok;
 363 }
 364
 365
 366 // ************************************************************************* //