|
| TypeName ("Cloud") |
| Runtime type information. More...
|
|
| Cloud (const polyMesh &mesh, const Foam::zero, const word &cloudName) |
| Construct without particles. More...
|
|
| Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles) |
| Construct from mesh and a list of particles. More...
|
|
| Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true) |
| Read construct from file(s) with given cloud instance. More...
|
|
const polyMesh & | pMesh () const noexcept |
| Return the polyMesh reference. More...
|
|
virtual label | nParcels () const |
| Return the number of particles in the cloud. More...
|
|
DynamicList< label > & | labels () const |
| Return temporary addressing. More...
|
|
void | addParticle (ParticleType *pPtr) |
| Transfer particle to cloud. More...
|
|
void | deleteParticle (ParticleType &p) |
| Remove particle from cloud and delete. More...
|
|
void | deleteLostParticles () |
| Remove lost particles from cloud and delete. More...
|
|
void | cloudReset (const Cloud< ParticleType > &c) |
| Reset the particles. More...
|
|
template<class TrackCloudType > |
void | move (TrackCloudType &cloud, typename ParticleType::trackingData &td, const scalar trackTime) |
| Move the particles. More...
|
|
void | autoMap (const mapPolyMesh &) |
| Remap the cells of particles corresponding to the. More...
|
|
template<class DataType > |
void | checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const |
| Check lagrangian data field. More...
|
|
template<class DataType > |
void | checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType >, DataType > &data) const |
| Check lagrangian data fieldfield. More...
|
|
template<class Type > |
bool | readStoreFile (const IOobject &io, const IOobject &ioNew) const |
| Helper function to store a cloud field on its registry. More...
|
|
void | readFromFiles (objectRegistry &obr, const wordRes &selectFields, const wordRes &excludeFields=wordRes::null()) const |
| Read from files into objectRegistry. More...
|
|
virtual void | writeFields () const |
| Write the field data for the cloud of particles Dummy at. More...
|
|
virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write using stream options. More...
|
|
void | writePositions () const |
| Write positions to <cloudName>_positions.obj file. More...
|
|
void | storeGlobalPositions () const |
| Call this before a topology change. More...
|
|
IOobject | fieldIOobject (const word &fieldName, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ) const |
| Helper to construct IOobject for field and current time. More...
|
|
| TypeName ("cloud") |
| Runtime type information. More...
|
|
| cloud (const cloud &)=delete |
| No copy construct. More...
|
|
void | operator= (const cloud &)=delete |
| No copy assignment. More...
|
|
| cloud (const objectRegistry &obr) |
| Construct for given objectRegistry. Uses default cloud name. More...
|
|
| cloud (const objectRegistry &obr, const word &cloudName) |
| Construct for given objectRegistry and named cloud. More...
|
|
virtual | ~cloud ()=default |
| Destructor. More...
|
|
virtual void | readObjects (const objectRegistry &obr) |
| Read particle fields from objects in the obr registry. More...
|
|
virtual void | writeObjects (objectRegistry &obr) const |
| Write particle fields as objects into the obr registry. More...
|
|
template<class Type > |
Foam::IOField< Type > & | createIOField (const word &fieldName, const label nParticle, objectRegistry &obr) |
|
| TypeName ("objectRegistry") |
| Declare type name for this IOobject. More...
|
|
| objectRegistry (const Time &db, const label initialCapacity=128) |
| Construct the time objectRegistry, with estimated table capacity (default: 128) More...
|
|
| objectRegistry (const IOobject &io, const label initialCapacity=128) |
| Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128) More...
|
|
virtual | ~objectRegistry () |
| Destructor, with checkOut() for all objects that are ownedByRegistry. More...
|
|
const objectRegistry & | thisDb () const noexcept |
| Return the object registry. More...
|
|
const objectRegistry & | parent () const noexcept |
| Return the parent objectRegistry. More...
|
|
const Time & | time () const noexcept |
| Return time registry. More...
|
|
bool | isTimeDb () const noexcept |
| True if the registry is Time. More...
|
|
virtual const fileName & | dbDir () const |
| Local directory path of this objectRegistry relative to the time. More...
|
|
IOobject | newIOobject (const word &name, IOobjectOption ioOpt) const |
| Create an IOobject at the current time instance (timeName) with the specified options. More...
|
|
IOobject | newIOobject (const word &name, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption regOpt=IOobjectOption::NO_REGISTER) const |
| Create an IOobject at the current time instance (timeName). More...
|
|
HashTable< wordHashSet > | classes () const |
| A summary hash of classes used and their associated object names. More...
|
|
template<class MatchPredicate > |
HashTable< wordHashSet > | classes (const MatchPredicate &matchName) const |
| A summary hash of classes used and their associated object names, restricted to objects that have a matching object name. More...
|
|
template<class Type , bool Strict = false> |
UPtrList< const Type > | cobjects () const |
| Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
|
|
template<class Type , bool Strict = false> |
UPtrList< Type > | objects () |
| Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
|
|
template<class Type , class MatchPredicate > |
UPtrList< const Type > | cobjects (const MatchPredicate &matchName) const |
| Return unsorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
|
|
template<class Type , class MatchPredicate > |
UPtrList< Type > | objects (const MatchPredicate &matchName) |
| Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
|
|
template<class Type , bool Strict = false> |
UPtrList< const Type > | csorted () const |
| Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
|
|
template<class Type , bool Strict = false> |
UPtrList< Type > | sorted () |
| Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
|
|
UPtrList< const regIOobject > | csorted () const |
| Return sorted list of objects. More...
|
|
UPtrList< regIOobject > | sorted () |
| Return sorted list of objects. More...
|
|
template<class Type , class MatchPredicate > |
UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
| Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
|
|
template<class Type , class MatchPredicate > |
UPtrList< Type > | sorted (const MatchPredicate &matchName) |
| Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
|
|
label | count (const char *clsName) const |
| The number of objects of the given class name. More...
|
|
template<class MatchPredicate > |
label | count (const MatchPredicate &matchClass) const |
| The number of objects of the given class name. More...
|
|
template<class MatchPredicate1 , class MatchPredicate2 > |
label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The number of objects of the given class name. More...
|
|
template<class Type > |
label | count (const bool strict=false) const |
| The names of objects with a class satisfying isA<Type> More...
|
|
template<class Type , class MatchPredicate > |
label | count (const MatchPredicate &matchName) const |
| The names of objects with a class satisfying isA<Type> that also have a matching object name. More...
|
|
wordList | names () const |
| The unsorted names of all objects. More...
|
|
wordList | names (const char *clsName) const |
| The unsorted names of objects with the given class name. More...
|
|
template<class MatchPredicate > |
wordList | names (const MatchPredicate &matchClass) const |
| The unsorted names of objects with a matching class name. More...
|
|
template<class MatchPredicate1 , class MatchPredicate2 > |
wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The unsorted names of objects with a matching class name that also have a matching object name. More...
|
|
template<class Type > |
wordList | names () const |
| The unsorted names of objects with a class satisfying isA<Type> More...
|
|
template<class Type , class MatchPredicate > |
wordList | names (const MatchPredicate &matchName) const |
| The unsorted names of objects with a class satisfying isA<Type> that also have a matching object name. More...
|
|
wordList | sortedNames () const |
| The sorted names of all objects. More...
|
|
wordList | sortedNames (const char *clsName) const |
| The sorted names of objects with the given class name. More...
|
|
template<class MatchPredicate > |
wordList | sortedNames (const MatchPredicate &matchClass) const |
| The sorted names objects with a matching class name. More...
|
|
template<class MatchPredicate1 , class MatchPredicate2 > |
wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The sorted names of objects with a matching class name that also have a matching object name. More...
|
|
template<class Type > |
wordList | sortedNames () const |
| The sorted names of objects with a class satisfying isA<Type> More...
|
|
template<class Type , class MatchPredicate > |
wordList | sortedNames (const MatchPredicate &matchName) const |
| The sorted names of objects with a class satisfying isA<Type> that also have a matching object name. More...
|
|
const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const |
| Lookup and return a const sub-objectRegistry. More...
|
|
template<class Type , bool Strict = false> |
HashTable< const Type * > | lookupClass () const |
| Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
|
|
template<class Type , bool Strict = false> |
HashTable< Type * > | lookupClass () |
| Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
|
|
template<class Type > |
HashTable< const Type * > | lookupClass (const bool strict) const |
| Return all objects with a class satisfying isA<Type> More...
|
|
template<class Type > |
HashTable< Type * > | lookupClass (const bool strict) |
| Return all objects with a class satisfying isA<Type> More...
|
|
const regIOobject * | cfindIOobject (const word &name, const bool recursive=false) const |
| Return const pointer to the regIOobject. More...
|
|
bool | contains (const word &name, const bool recursive=false) const |
| Does the registry contain the regIOobject object (by name). More...
|
|
template<class Type > |
bool | foundObject (const word &name, const bool recursive=false) const |
| Is the named Type found? More...
|
|
template<class Type > |
const Type * | cfindObject (const word &name, const bool recursive=false) const |
| Return const pointer to the object of the given Type. More...
|
|
template<class Type > |
const Type * | findObject (const word &name, const bool recursive=false) const |
| Return const pointer to the object of the given Type. More...
|
|
template<class Type > |
Type * | findObject (const word &name, const bool recursive=false) |
| Return non-const pointer to the object of the given Type. More...
|
|
template<class Type > |
Type * | getObjectPtr (const word &name, const bool recursive=false) const |
| Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More...
|
|
template<class Type > |
const Type & | lookupObject (const word &name, const bool recursive=false) const |
| Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type. More...
|
|
template<class Type > |
Type & | lookupObjectRef (const word &name, const bool recursive=false) const |
| Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type. More...
|
|
label | getEvent () const |
| Return new event number. More...
|
|
bool | checkIn (regIOobject *io) const |
| Add a regIOobject to registry. A nullptr is ignored. More...
|
|
bool | checkIn (regIOobject &io) const |
| Add a regIOobject to registry. More...
|
|
bool | checkOut (regIOobject *io) const |
| Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored. More...
|
|
bool | checkOut (regIOobject &io) const |
| Remove a regIOobject from registry and free memory if the object is ownedByRegistry. More...
|
|
bool | checkOut (const word &key) const |
| Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry. More...
|
|
void | clear () |
| Clear all entries from the registry. More...
|
|
void | clearStorage () |
| Clear all entries from the registry and the table itself. More...
|
|
bool | erase (const iterator &iter) |
| Erase an entry specified by the given iterator. More...
|
|
bool | erase (const word &key) |
| Erase an entry specified by the given key. More...
|
|
label | erase (std::initializer_list< word > keys) |
| Remove entries given by the listed keys. More...
|
|
label | erase (const UList< word > &keys) |
| Remove entries given by the listed keys. More...
|
|
virtual void | rename (const word &newName) |
| Rename. More...
|
|
bool | is_cacheTemporaryObject (const word &name) const |
| True if given name is in the cacheTemporaryObjects set. More...
|
|
bool | is_cacheTemporaryObject (const regIOobject *io) const |
| True if name of object is in the cacheTemporaryObjects set. More...
|
|
bool | is_cacheTemporaryObject (const regIOobject &io) const |
| True if name of object is in the cacheTemporaryObjects set. More...
|
|
template<class Type > |
bool | cacheTemporaryObject (Type &obj) const |
| Cache the given object. Moves content and stores. More...
|
|
void | resetCacheTemporaryObject (const regIOobject *io) const |
| Reset the cache state of the given object (nullptr is ignored) More...
|
|
void | resetCacheTemporaryObject (const regIOobject &io) const |
| Reset the cache state of the given object in the cacheTemporaryObjects set. More...
|
|
bool | checkCacheTemporaryObjects () const |
| Check that all objects specified in the cacheTemporaryObjects were also cached. More...
|
|
virtual bool | modified () const |
| Return true if any of the object's files have been modified. More...
|
|
void | readModifiedObjects () |
| Read the objects that have been modified. More...
|
|
virtual bool | readIfModified () |
| Read object if modified. More...
|
|
virtual bool | writeData (Ostream &) const |
| The writeData function is required by regIOobject but not used. More...
|
|
bool | found (const word &name, bool recursive=false) const |
| Same as contains() More...
|
|
template<class Type > |
const Type * | lookupObjectPtr (const word &name, bool recursive=false) const |
| Deprecated(2018-10) find object. More...
|
|
template<class Type > |
Type * | lookupObjectRefPtr (const word &name, bool recursive=false) const |
| Deprecated(2018-10) get object pointer, ignoring constness. More...
|
|
template<class Type > |
UPtrList< const Type > | sorted () const |
| Deprecated(2023-07) use csorted() method. More...
|
|
UPtrList< const regIOobject > | sorted () const |
| Deprecated(2023-07) use csorted() method. More...
|
|
template<class Type , class MatchPredicate > |
UPtrList< const Type > | sorted (const MatchPredicate &matchName) const |
| Deprecated(2023-07) use csorted() method. More...
|
|
template<class MatchPredicate > |
Foam::HashTable< Foam::wordHashSet > | classesImpl (const objectRegistry &list, const MatchPredicate &matchName) |
|
template<class MatchPredicate1 , class MatchPredicate2 > |
Foam::label | countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) |
|
template<class Type , class MatchPredicate > |
Foam::label | countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName) |
|
template<class MatchPredicate1 , class MatchPredicate2 > |
Foam::wordList | namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort) |
|
template<class Type , class MatchPredicate > |
Foam::wordList | namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
|
template<class Type , class MatchPredicate > |
Foam::UPtrList< Type > | objectsTypeImpl (const bool strict, const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
|
template<class Type > |
Foam::HashTable< Type * > | lookupClassTypeImpl (const bool strict, const objectRegistry &list) |
|
template<class MatchPredicate > |
Foam::HashTable< Foam::wordHashSet > | classes (const MatchPredicate &matchName) const |
|
template<class MatchPredicate > |
Foam::label | count (const MatchPredicate &matchClass) const |
|
template<class MatchPredicate1 , class MatchPredicate2 > |
Foam::label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
|
template<class Type , class MatchPredicate > |
Foam::label | count (const MatchPredicate &matchName) const |
|
template<class Type > |
Foam::label | count (const bool strict) const |
|
template<class Type , bool Strict> |
Foam::UPtrList< const Type > | cobjects () const |
|
template<class Type , bool Strict> |
Foam::UPtrList< Type > | objects () |
|
template<class Type , bool Strict> |
Foam::UPtrList< const Type > | csorted () const |
|
template<class Type , bool Strict> |
Foam::UPtrList< Type > | sorted () |
|
template<class Type , class MatchPredicate > |
Foam::UPtrList< const Type > | cobjects (const MatchPredicate &matchName) const |
|
template<class Type , class MatchPredicate > |
Foam::UPtrList< Type > | objects (const MatchPredicate &matchName) |
|
template<class Type , class MatchPredicate > |
Foam::UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
|
template<class Type , class MatchPredicate > |
Foam::UPtrList< Type > | sorted (const MatchPredicate &matchName) |
|
template<class MatchPredicate > |
Foam::wordList | names (const MatchPredicate &matchClass) const |
|
template<class MatchPredicate1 , class MatchPredicate2 > |
Foam::wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
|
template<class Type > |
Foam::wordList | names () const |
|
template<class Type , class MatchPredicate > |
Foam::wordList | names (const MatchPredicate &matchName) const |
|
template<class MatchPredicate > |
Foam::wordList | sortedNames (const MatchPredicate &matchClass) const |
|
template<class MatchPredicate1 , class MatchPredicate2 > |
Foam::wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
|
template<class Type > |
Foam::wordList | sortedNames () const |
|
template<class Type , class MatchPredicate > |
Foam::wordList | sortedNames (const MatchPredicate &matchName) const |
|
template<class Type , bool Strict> |
Foam::HashTable< const Type * > | lookupClass () const |
|
template<class Type , bool Strict> |
Foam::HashTable< Type * > | lookupClass () |
|
template<class Type > |
Foam::HashTable< const Type * > | lookupClass (const bool strict) const |
|
template<class Type > |
Foam::HashTable< Type * > | lookupClass (const bool strict) |
|
void | operator= (const regIOobject &)=delete |
| No copy assignment. More...
|
|
| TypeName ("regIOobject") |
| Runtime type information. More...
|
|
| regIOobject (const IOobject &io, const bool isTimeObject=false) |
| Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...
|
|
| regIOobject (const regIOobject &rio) |
| Copy construct. More...
|
|
| regIOobject (const regIOobject &rio, bool registerCopy) |
| Copy construct, transferring registry registration to the copy if registerCopy is true. More...
|
|
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) |
| Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...
|
|
| regIOobject (const IOobject &io, const regIOobject &rio) |
| Copy construct with new IO parameters. More...
|
|
virtual | ~regIOobject () |
| Destructor. More...
|
|
bool | checkIn () |
| Add object to registry, if not already registered. More...
|
|
bool | checkOut () |
| Remove object from registry, and remove all file watches. More...
|
|
virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More...
|
|
bool | registered () const noexcept |
| Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...
|
|
bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? More...
|
|
bool | store () |
| Register object with its registry and transfer ownership to the registry. More...
|
|
void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. More...
|
|
label | eventNo () const noexcept |
| Event number at last update. More...
|
|
label & | eventNo () noexcept |
| Event number at last update. More...
|
|
bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
void | setUpToDate () |
| Set as up-to-date. More...
|
|
const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. More...
|
|
dictionary & | getMetaData () noexcept |
| Get or create meta-data. More...
|
|
void | removeMetaData () |
| Remove meta-data. More...
|
|
virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing) More...
|
|
virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More...
|
|
bool | headerOk () |
| Read and check header info. Does not check the headerClassName. More...
|
|
Istream & | readStream (const word &, const bool readOnProc=true) |
| Return Istream and check object type against that given. More...
|
|
void | close () |
| Close Istream. More...
|
|
virtual bool | readData (Istream &) |
| Virtual readData function. More...
|
|
virtual bool | read () |
| Read object. More...
|
|
virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More...
|
|
const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. More...
|
|
labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. More...
|
|
virtual bool | write (const bool writeOnProc=true) const |
| Write using setting from DB. More...
|
|
virtual bool | global () const |
| Is object global. More...
|
|
void | operator= (const IOobject &io) |
| Copy assignment. More...
|
|
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| Write using given format, version and compression. More...
|
|
| TypeName ("IOobject") |
| Declare type-name, virtual type (with debug switch) More...
|
|
| IOobject (const IOobject &)=default |
| Copy construct. More...
|
|
virtual | ~IOobject ()=default |
| Destructor. More...
|
|
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from name, instance, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from name, instance, local, registry, io options. More...
|
|
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from path, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from name, instance, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from name, instance, local, registry, io options. More...
|
|
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from path, registry, io options. More...
|
|
| IOobject (const IOobject &io, const objectRegistry ®istry) |
| Copy construct, resetting registry. More...
|
|
| IOobject (const IOobject &io, const word &name) |
| Copy construct, resetting name. More...
|
|
| IOobject (const IOobject &io, const word &name, const fileName &local) |
| Copy construct, resetting name and local component. More...
|
|
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) |
| Copy construct, resetting read/write options. More...
|
|
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) |
| Copy construct, resetting register option. More...
|
|
autoPtr< IOobject > | clone () const |
| Clone. More...
|
|
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More...
|
|
const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More...
|
|
const Time & | time () const noexcept |
| Return Time associated with the objectRegistry. More...
|
|
const word & | name () const noexcept |
| Return the object name. More...
|
|
const word & | headerClassName () const noexcept |
| Return name of the class name read from header. More...
|
|
word & | headerClassName () noexcept |
| Return non-constant access to the class name read from header. More...
|
|
const string & | note () const noexcept |
| Return the optional note. More...
|
|
string & | note () noexcept |
| Modifiable access to the optional note. More...
|
|
unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. More...
|
|
unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. More...
|
|
void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More...
|
|
bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading) More...
|
|
template<class Type > |
bool | isHeaderClass () const |
| Check if headerClassName() equals Type::typeName. More...
|
|
template<class Type > |
bool | isHeaderClassName () const |
| Same as isHeaderClass() More...
|
|
word | group () const |
| Return group (extension part of name) More...
|
|
word | member () const |
| Return member (name without the extension) More...
|
|
const fileName & | rootPath () const noexcept |
| Return the Time::rootPath() More...
|
|
const fileName & | caseName () const noexcept |
| Return the Time::caseName() More...
|
|
const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName() More...
|
|
const fileName & | instance () const noexcept |
| Read access to instance path component. More...
|
|
fileName & | instance () noexcept |
| Write access to instance path component. More...
|
|
const fileName & | local () const noexcept |
| Read access to local path component. More...
|
|
fileName | path () const |
| The complete path for the object (with instance, local,...). More...
|
|
fileName | globalPath () const |
| The complete global path for the object (with instance, local,...) More...
|
|
fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More...
|
|
fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. More...
|
|
fileName | objectPath () const |
| The complete path + object name. More...
|
|
fileName | globalObjectPath () const |
| The complete global path + object name. More...
|
|
fileName | objectRelPath () const |
| The object path relative to the root. More...
|
|
fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. More...
|
|
fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. More...
|
|
IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...
|
|
bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...
|
|
bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...
|
|
template<class Type > |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (respects is_globalIOobject trait) and check its info. More...
|
|
template<class Type > |
fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More...
|
|
template<class Type > |
void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More...
|
|
bool | writeHeader (Ostream &os) const |
| Write header with current type() More...
|
|
bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. More...
|
|
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. More...
|
|
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. More...
|
|
bool | good () const noexcept |
| Did last readHeader() succeed? More...
|
|
bool | bad () const noexcept |
| Did last readHeader() fail? More...
|
|
InfoProxy< IOobject > | info () const noexcept |
| Return info proxy, for printing information to a stream. More...
|
|
void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry) More...
|
|
template<> |
bool | isHeaderClass () const |
| Specialization for void always returns true (no headerClassName check). More...
|
|
template<class StringType > |
Foam::word | groupName (StringType base, const word &group) |
|
template<class Type > |
Foam::fileName | typeFilePath (const bool search) const |
|
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More...
|
|
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. More...
|
|
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. More...
|
|
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. More...
|
|
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. More...
|
|
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. More...
|
|
readOption | readOpt () const noexcept |
| Get the read option. More...
|
|
readOption | readOpt (readOption opt) noexcept |
| Set the read option. More...
|
|
writeOption | writeOpt () const noexcept |
| Get the write option. More...
|
|
writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. More...
|
|
bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? More...
|
|
bool | registerObject (bool on) noexcept |
| Change registration preference. More...
|
|
bool | globalObject () const noexcept |
| True if object is treated the same for all processors. More...
|
|
bool | globalObject (bool on) noexcept |
| Change global-object status. More...
|
|
bool | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ) More...
|
|
bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. More...
|
|
bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
|
|
readOption & | readOpt () noexcept |
| Access to the read option. More...
|
|
writeOption & | writeOpt () noexcept |
| Access to the write option. More...
|
|
bool & | registerObject () noexcept |
| Access to the register object option. More...
|
|
bool & | globalObject () noexcept |
| Access to the global object option. More...
|
|
| HashTable () noexcept |
| Default construct: empty without allocation (capacity=0) More...
|
|
| HashTable (const Foam::zero) noexcept |
| Construct empty without allocation (capacity=0) More...
|
|
| HashTable (const label initialCapacity) |
| Construct empty with initial table capacity. More...
|
|
| HashTable (Istream &is) |
| Construct from Istream. More...
|
|
| HashTable (const this_type &ht) |
| Copy construct. More...
|
|
| HashTable (this_type &&rhs) noexcept |
| Move construct. More...
|
|
| HashTable (std::initializer_list< std::pair< word, regIOobject * >> list, const bool overwrite=false) |
| Construct from key/value pairs in initializer list. More...
|
|
| HashTable (const UList< word > &keys, const UList< regIOobject * > &values, const bool overwrite=false) |
| Construct from key/value pairs. More...
|
|
| ~HashTable () |
| Destructor. More...
|
|
bool | empty () const noexcept |
| True if the hash table is empty. More...
|
|
label | size () const noexcept |
| The number of elements in table. More...
|
|
label | capacity () const noexcept |
| The size of the underlying table (the number of buckets) More...
|
|
regIOobject * & | at (const word &key) |
| Find and return a hashed entry. FatalError if it does not exist. More...
|
|
const regIOobject * & | at (const word &key) const |
| Find and return a hashed entry. FatalError if it does not exist. More...
|
|
bool | contains (const word &key) const |
| True if hashed key is contained (found) in table. More...
|
|
iterator | find (const word &key) |
| Find and return an iterator set at the hashed entry. More...
|
|
const_iterator | find (const word &key) const |
| Find and return an const_iterator set at the hashed entry. More...
|
|
const_iterator | cfind (const word &key) const |
| Find and return an const_iterator set at the hashed entry. More...
|
|
const regIOobject * & | lookup (const word &key, const regIOobject * &deflt) const |
| Return hashed entry if it exists, or return the given default. More...
|
|
List< word > | toc () const |
| The table of contents (the keys) in unsorted order. More...
|
|
List< word > | sortedToc () const |
| The table of contents (the keys) in sorted order. More...
|
|
List< word > | sortedToc (const Compare &comp) const |
| The table of contents (the keys) sorted according to the specified comparator. More...
|
|
Foam::List< word > | sortedToc (const Compare &comp) const |
|
List< word > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the unary predicate applied to the keys. More...
|
|
Foam::List< word > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
|
List< word > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the unary predicate applied to the values. More...
|
|
Foam::List< word > | tocValues (const UnaryPredicate &pred, const bool invert) const |
|
List< word > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More...
|
|
Foam::List< word > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
|
UPtrList< const node_type > | csorted () const |
| Const access to the hash-table contents in sorted order (sorted by keys). More...
|
|
UPtrList< node_type > | sorted () |
| Non-const access to the hash-table contents in sorted order (sorted by keys). More...
|
|
UPtrList< const node_type > | sorted () const |
| Deprecated(2023-07) use csorted() method. More...
|
|
label | countKeys (const UnaryPredicate &pred, const bool invert=false) const |
| Count the number of keys that satisfy the unary predicate. More...
|
|
Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
|
label | countValues (const UnaryPredicate &pred, const bool invert=false) const |
| Count the number of values that satisfy the unary predicate. More...
|
|
Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
|
label | countEntries (const BinaryPredicate &pred, const bool invert=false) const |
| Count the number of entries that satisfy the binary predicate. More...
|
|
Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
|
bool | emplace (const word &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. More...
|
|
bool | emplace_set (const word &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. More...
|
|
bool | insert (const word &key, const regIOobject * &obj) |
| Copy insert a new entry, not overwriting existing entries. More...
|
|
bool | insert (const word &key, regIOobject * &&obj) |
| Move insert a new entry, not overwriting existing entries. More...
|
|
bool | set (const word &key, const regIOobject * &obj) |
| Copy assign a new entry, overwriting existing entries. More...
|
|
bool | set (const word &key, regIOobject * &&obj) |
| Move assign a new entry, overwriting existing entries. More...
|
|
bool | erase (const iterator &iter) |
| Erase an entry specified by given iterator. More...
|
|
bool | erase (const word &key) |
| Erase an entry specified by the given key. More...
|
|
label | erase (const HashTable< AnyType, word, AnyHash > &other) |
| Remove table entries given by keys of the other hash-table. More...
|
|
label | erase (std::initializer_list< word > keys) |
| Remove table entries given by the listed keys. More...
|
|
label | erase (InputIter first, InputIter last) |
| Remove multiple entries using an iterator range of keys. More...
|
|
label | erase (const FixedList< word, N > &keys) |
| Remove table entries given by the listed keys. More...
|
|
label | erase (const UList< word > &keys) |
| Remove table entries given by the listed keys. More...
|
|
Foam::label | erase (InputIter first, InputIter last) |
|
Foam::label | erase (const FixedList< word, N > &keys) |
|
Foam::label | erase (const HashTable< AnyType, word, AnyHash > &other) |
|
label | retain (const HashTable< AnyType, word, AnyHash > &other) |
| Retain table entries given by keys of the other hash-table. More...
|
|
Foam::label | retain (const HashTable< AnyType, word, AnyHash > &other) |
|
label | filterKeys (const UnaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their keys. More...
|
|
Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
|
label | filterValues (const UnaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their values. More...
|
|
Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
|
label | filterEntries (const BinaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their key/value. More...
|
|
Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
|
void | clear () |
| Remove all entries from table. More...
|
|
void | clearStorage () |
| Remove all entries from table and the table itself. More...
|
|
void | setCapacity (label newCapacity) |
| Change the hash table capacity (number of buckets). More...
|
|
void | resize (label newCapacity) |
| Rehash the hash table with new number of buckets. Currently identical to setCapacity() More...
|
|
void | reserve (label numEntries) |
| Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More...
|
|
void | swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) noexcept |
| Swap contents into this table. More...
|
|
void | transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) |
| Transfer contents into this table. More...
|
|
void | merge (HashTable< regIOobject *, word, Foam::Hash< word > > &source) |
| Attempts to extract entries from source parameter and insert them into this , does not overwrite existing entries. The source will contains any items that could not be merged. More...
|
|
void | merge (HashTable< regIOobject *, word, Foam::Hash< word > > &&source) |
| Attempts to extract entries from source parameter and insert them into this , does not overwrite existing entries. The source will contains any items that could not be merged. More...
|
|
regIOobject * & | operator[] (const word &key) |
| Find and return a hashed entry. FatalError if it does not exist. More...
|
|
const regIOobject * & | operator[] (const word &key) const |
| Find and return a hashed entry. FatalError if it does not exist. More...
|
|
regIOobject * & | operator() (const word &key) |
| Return existing entry or create a new entry. More...
|
|
regIOobject * & | operator() (const word &key, const regIOobject * &deflt) |
| Return existing entry or insert a new entry. More...
|
|
void | operator= (const this_type &rhs) |
| Copy assign. More...
|
|
void | operator= (std::initializer_list< std::pair< word, regIOobject * >> rhs) |
| Copy assign from an initializer list. More...
|
|
void | operator= (this_type &&rhs) |
| Move assign. More...
|
|
bool | operator== (const this_type &rhs) const |
| Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More...
|
|
bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. More...
|
|
this_type & | operator+= (const this_type &rhs) |
| Add entries into this HashTable. More...
|
|
const_iterator_pair< const_key_iterator, this_type > | keys () const |
| A const iterator begin/end pair for iterating over keys. More...
|
|
iterator | begin () |
| iterator set to the beginning of the HashTable More...
|
|
const_iterator | begin () const |
| const_iterator set to the beginning of the HashTable More...
|
|
const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable More...
|
|
iterator | end () noexcept |
| iterator to signal the end (for any HashTable) More...
|
|
const_iterator | end () const noexcept |
| const_iterator to signal the end (for any HashTable) More...
|
|
constexpr const_iterator | cend () const noexcept |
| const_iterator to signal the end (for any HashTable) More...
|
|
Ostream & | printInfo (Ostream &os) const |
| Print information. More...
|
|
Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
| Write unordered keys (list), with line-breaks when length exceeds shortLen. More...
|
|
bool | found (const word &key) const |
| Same as contains() More...
|
|
| ClassName ("HashTable") |
| Declare type-name (with debug switch) More...
|
|
| HashTableCore () noexcept=default |
| Default construct. More...
|
|
| ILList ()=default |
| Default construct. More...
|
|
| ILList (T *item) |
| Construct and add initial item pointer. More...
|
|
| ILList (Istream &is) |
| Construct from Istream. More...
|
|
| ILList (const ILList< LListBase, T > &lst) |
| Copy construct using the 'clone()' method for each element. More...
|
|
| ILList (ILList< LListBase, T > &&lst) |
| Move construct. More...
|
|
template<class CloneArg > |
| ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg) |
| Copy constructor with additional argument for clone 'clone()'. More...
|
|
template<class INew > |
| ILList (Istream &is, const INew &inew) |
| Construct from Istream using given Istream constructor class. More...
|
|
| ~ILList () |
| Destructor. Calls clear() More...
|
|
void | clear () |
| Clear the contents of the list. More...
|
|
void | pop_front (label n=1) |
| Remove first element(s) from the list (deletes pointers) More...
|
|
bool | erase (T *item) |
| Remove the specified element from the list and delete it. More...
|
|
void | transfer (ILList< LListBase, T > &lst) |
| Transfer the contents of the argument into this List and annul the argument list. More...
|
|
void | operator= (const ILList< LListBase, T > &lst) |
| Copy assignment using the 'clone()' method for each element. More...
|
|
void | operator= (ILList< LListBase, T > &&lst) |
| Move assignment. More...
|
|
| UILList ()=default |
| Default construct. More...
|
|
| UILList (T *item) |
| Construct and add initial item pointer. More...
|
|
| UILList (const UILList< LListBase, T > &list) |
| Construct as copy. More...
|
|
T * | front () |
| The first entry in the list. More...
|
|
const T * | front () const |
| The first entry in the list (const access) More...
|
|
T * | back () |
| The last entry in the list. More...
|
|
const T * | back () const |
| The last entry in the list (const access) More...
|
|
T * | removeHead () |
| Remove and return head. More...
|
|
T * | remove (T *item) |
| Remove and return element. More...
|
|
T * | remove (iterator &iter) |
| Remove and return item specified by iterator. More...
|
|
void | operator= (const UILList< LListBase, T > &lst) |
| Copy assignment. More...
|
|
bool | operator== (const UILList< LListBase, T > &lst) const |
| Equality. True both lists are element-wise equal. More...
|
|
bool | operator!= (const UILList< LListBase, T > &lst) const |
| The opposite of the equality operation. Takes linear time. More...
|
|
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write UILList with line-breaks when length exceeds shortLen. More...
|
|
iterator | begin () |
| Iterator to first item in list with non-const access. More...
|
|
const_iterator | cbegin () const |
| Iterator to first item in list with const access. More...
|
|
reverse_iterator | rbegin () |
| Iterator to last item in list with non-const access. More...
|
|
const_reverse_iterator | crbegin () const |
| Iterator to last item in list with const access. More...
|
|
const_iterator | begin () const |
| Iterator to first item in list with const access. More...
|
|
const_reverse_iterator | rbegin () const |
| Iterator to last item in list with const access. More...
|
|
const iterator & | end () |
| End of list for forward iterators. More...
|
|
const const_iterator & | cend () const |
| End of list for forward iterators. More...
|
|
const reverse_iterator & | rend () |
| End of list for reverse iterators. More...
|
|
const const_reverse_iterator & | crend () const |
| End of list for reverse iterators. More...
|
|
const const_iterator & | end () const |
| End of list for forward iterators. More...
|
|
const const_reverse_iterator & | rend () const |
| End of list for reverse iterators. More...
|
|
T * | first () |
| The first entry in the list. More...
|
|
const T * | first () const |
| The first entry in the list (const access) More...
|
|
T * | last () |
| The last entry in the list. More...
|
|
const T * | last () const |
| The last entry in the list (const access) More...
|
|