File size: 11,178 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 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-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::objectRegistry
Description
Registry of regIOobjects
SourceFiles
objectRegistry.C
\*---------------------------------------------------------------------------*/
#ifndef objectRegistry_H
#define objectRegistry_H
#include "HashTable.H"
#include "regIOobject.H"
#include "wordReList.H"
#include "HashSet.H"
#include "Pair.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class objectRegistry Declaration
\*---------------------------------------------------------------------------*/
class objectRegistry
:
public regIOobject,
public HashTable<regIOobject*>
{
// Private Data
//- Master time objectRegistry
const Time& time_;
//- Parent objectRegistry
const objectRegistry& parent_;
//- Local directory path of this objectRegistry relative to time
fileName dbDir_;
//- Current event
mutable uint64_t event_;
//- Table of temporary object names with current state
mutable HashTable<Pair<bool>> cacheTemporaryObjects_;
//- State of cacheTemporaryObjects_. 0 means as yet uninitialised. 1
// means initialised. -1 means deactivated (during destruction).
mutable label cacheTemporaryObjectsState_;
//- Accumulated list of temporary objects available to cache
// Used to provide diagnostics in case the requested object is not
// available
mutable HashSet<word> temporaryObjects_;
mutable List<regIOobject*> dependents_;
// Private Member Functions
//- Is the objectRegistry parent_ different from time_
// Used to terminate searching within the ancestors
bool parentNotTime() const;
//- Read the cacheTemporaryObjects list from controlDict
void readCacheTemporaryObjects() const;
//- Delete the current cached object before caching a new object
void deleteCachedObject(regIOobject& cachedOb) const;
public:
//- Declare type name for this IOobject
TypeName("objectRegistry");
// Constructors
//- Construct the time objectRegistry given an initial estimate
// for the number of entries
objectRegistry
(
const Time& db,
const label nIoObjects = 128
);
//- Construct a sub-registry given an IObject to describe the registry
// and an initial estimate for the number of entries
objectRegistry
(
const IOobject& io,
const fileName& dbDir,
const label nIoObjects = 128
);
//- Construct a sub-registry given an IObject to describe the registry
// and an initial estimate for the number of entries
objectRegistry
(
const IOobject& io,
const label nIoObjects = 128
);
//- Move constructor
objectRegistry(objectRegistry&&) = default;
//- Disallow default bitwise copy construction
objectRegistry(const objectRegistry&) = delete;
//- Destructor
virtual ~objectRegistry();
// Member Functions
// Access
//- Return time
const Time& time() const
{
return time_;
}
//- Return the parent objectRegistry
const objectRegistry& parent() const
{
return parent_;
}
//- Local directory path of this objectRegistry relative to the time
const fileName& dbDir() const
{
return dbDir_;
}
using regIOobject::path;
//- Return complete path with alternative instance and local
fileName path
(
const word& instance,
const fileName& local = ""
) const;
using HashTable<regIOobject*>::toc;
using HashTable<regIOobject*>::sortedToc;
//- Return the list of names of IOobjects of given class name
wordList toc(const word& className) const;
//- Return the sorted list of names of IOobjects of given class name
wordList sortedToc(const word& className) const;
//- Return the list of names and types of IOobjects
List<Pair<word>> tocTypes() const;
//- Return the list of names of the IOobjects of given type
template<class Type>
wordList toc() const;
//- Return the list of objects whose name matches the input regExp
template<class Type>
wordList toc(const wordRe& name) const;
//- Return the list of objects whose name matches the input regExp
template<class Type>
wordList toc(const wordReList& name) const;
//- Lookup and return a const sub-objectRegistry. Optionally create
// it if it does not exist.
const objectRegistry& subRegistry
(
const word& name,
const bool forceCreate = false
) const;
//- Lookup and return all objects of the given Type
template<class Type>
HashTable<const Type*> lookupClass(const bool strict = false) const;
//- Lookup and return all objects of the given Type
template<class Type>
HashTable<Type*> lookupClass(const bool strict = false);
//- Is the named Type in registry
template<class Type>
bool foundObject(const word& name) const;
//- Lookup and return the object of the given Type and name
template<class Type>
const Type& lookupObject(const word& name) const;
//- Lookup and return the object reference of the given Type and
// name
template<class Type>
Type& lookupObjectRef(const word& name) const;
//- Is the Type in registry
// the name is derived from the type name and given group
template<class Type>
bool foundType(const word& group = word::null) const;
//- Lookup and return the object of the given Type
// the name is derived from the type name and given group
template<class Type>
const Type& lookupType(const word& group = word::null) const;
//- Lookup and return the object reference of the given Type
// the name is derived from the type name and given group
template<class Type>
Type& lookupTypeRef(const word& group = word::null) const;
//- Return new event number.
uint64_t getEvent() const;
//- Return the objectRegistry
// Required for consistent interface for DemandDrivenMeshObject
// instantiated on objectRegistry
const objectRegistry& db() const
{
return *this;
}
// Edit
//- Rename
virtual void rename(const word& newName);
//- Add an regIOobject to registry
bool checkIn(regIOobject&) const;
//- Remove an regIOobject from registry
bool checkOut(regIOobject&) const;
//- Remove all regIOobject owned by the registry
void clear();
//- Add the given name to the cacheTemporaryObjects set
void cacheTemporary(const word& name) const;
//- Cache the given object
template<class Object>
bool cacheTemporaryObject(Object& ob) const;
//- Return true if given name is in the cacheTemporaryObjects set
bool temporaryObjectCached(const word& name) const;
//- Reset the cache state of the given object
// in the cacheTemporaryObjects set
void resetCacheTemporaryObject(const regIOobject& ob) const;
//- Check that all objects in the cacheTemporaryObjects set
// were cached
bool checkCacheTemporaryObjects() const;
// Reading
//- Return true if any of the object's files have been modified
virtual bool modified() const;
//- Cache pointers to objects who's dependencies have been modified
virtual bool dependenciesModified() const;
//- Read object if modified
virtual bool readIfModified();
//- Read dependent objects
virtual bool read();
//- Read the objects that have been modified
void readModifiedObjects();
// Writing
//- Print the list of object names and their type
// to the given stream
void printToc(Ostream& os) const;
//- writeData function required by regIOobject but not used
// for this class, writeObject is used instead
virtual bool writeData(Ostream&) const
{
NotImplemented;
return false;
}
//- Write the objects
virtual bool writeObject
(
IOstream::streamFormat fmt,
IOstream::versionNumber ver,
IOstream::compressionType cmp,
const bool write
) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const objectRegistry&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "objectRegistryTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|