Class to control time during OpenFOAM simulations that is also the top-level objectRegistry. More...
Public Types | |
| enum | writeControls { wcNone, wcTimeStep, wcRunTime, wcAdjustableRunTime, wcClockTime, wcCpuTime, wcUnknown } |
| Write control options. More... | |
| enum | stopAtControls { saEndTime, saNoWriteNow, saWriteNow, saNextWrite, saUnknown } |
| Stop-run control options, which are primarily used when altering the stopAt condition. More... | |
 Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Public Types inherited from IOobjectOption | |
| enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 } |
| Enumeration defining read preferences. More... | |
| enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
| Enumeration defining write preferences. More... | |
| enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 } |
| Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
| Public Types inherited from HashTable< regIOobject *> | |
| typedef HashTable< regIOobject *, word, Foam::Hash< word > > | this_type |
| The template instance used for this HashTable. More... | |
| typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< regIOobject * >::type >::value, Detail::HashTableSingle< word >, Detail::HashTablePair< word, regIOobject * > >::type | node_type |
| A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More... | |
| typedef word | key_type |
| The second template parameter, type of keys used. More... | |
| typedef regIOobject * | mapped_type |
| The first template parameter, type of objects contained. More... | |
| typedef regIOobject * | value_type |
| Same as mapped_type for OpenFOAM HashTables. More... | |
| typedef Foam::Hash< word > | hasher |
| The third template parameter, the hash index method. More... | |
| typedef regIOobject * * | pointer |
| Pointer type for storing into value_type objects. More... | |
| typedef regIOobject * & | reference |
| Reference to the stored value_type. More... | |
| typedef const regIOobject * * | const_pointer |
| Const pointer type for the stored value_type. More... | |
| typedef const regIOobject * & | const_reference |
| Const reference to the stored value_type. More... | |
| typedef label | difference_type |
| The type to represent the difference between two iterators. More... | |
| typedef label | size_type |
| The type that can represent the size of a HashTable. More... | |
| using | key_iterator = key_iterator_base< iterator > |
| Forward iterator returning the key. More... | |
| using | const_key_iterator = key_iterator_base< const_iterator > |
| Forward const iterator returning the key. More... | |
| Public Types inherited from dimensioned< scalar > | |
| typedef scalar | value_type |
| The underlying data type. More... | |
| typedef pTraits< scalar >::cmptType | cmptType |
| Component type. More... | |
Public Member Functions | |
| TypeName ("time") | |
| Runtime type information. More... | |
| Time (const word &ctrlDictName, const argList &args, const bool enableFunctionObjects=true, const bool enableLibs=true, IOobjectOption::readOption rOpt=IOobjectOption::READ_MODIFIED) | |
| Construct from argument list, reading from specified control dictionary name. More... | |
| Time (const word &ctrlDictName, const argList &args, const word &systemDirName, const word &constantDirName, const bool enableFunctionObjects=true, const bool enableLibs=true, IOobjectOption::readOption rOpt=IOobjectOption::READ_MODIFIED) | |
| Construct from argument list, reading from specified control dictionary name. More... | |
| Time (const word &ctrlDictName, const fileName &rootPath, const fileName &caseName, const bool enableFunctionObjects=true, const bool enableLibs=true, IOobjectOption::readOption rOpt=IOobjectOption::READ_MODIFIED) | |
| Construct given name of dictionary to read and root/case paths. More... | |
| Time (const word &ctrlDictName, const fileName &rootPath, const fileName &caseName, const word &systemDirName, const word &constantDirName, const bool enableFunctionObjects=true, const bool enableLibs=true, IOobjectOption::readOption rOpt=IOobjectOption::READ_MODIFIED) | |
| Construct given name of dictionary to read and root/case paths. More... | |
| Time (const dictionary &dict, const fileName &rootPath, const fileName &caseName, const bool enableFunctionObjects=true, const bool enableLibs=true, IOobjectOption::readOption rOpt=IOobjectOption::READ_MODIFIED) | |
| Construct from root/case paths, with initial dictionary content without reading from "controlDict". More... | |
| Time (const dictionary &dict, const fileName &rootPath, const fileName &caseName, const word &systemDirName, const word &constantDirName, const bool enableFunctionObjects=true, const bool enableLibs=true, IOobjectOption::readOption rOpt=IOobjectOption::READ_MODIFIED) | |
| Construct from root/case paths, with initial dictionary content without reading from "controlDict". More... | |
| Time (const fileName &rootPath, const fileName &caseName, const bool enableFunctionObjects=true, const bool enableLibs=true) | |
| Construct from root/case paths without reading or requiring a controlDict or other files. More... | |
| Time (const fileName &rootPath, const fileName &caseName, const word &systemDirName, const word &constantDirName, const bool enableFunctionObjects=true, const bool enableLibs=true) | |
| Construct from root/case paths without reading or requiring a controlDict or other files. More... | |
| virtual | ~Time () |
| Destructor. More... | |
| fileName | path () const |
| Return path = rootPath/caseName. Same as TimePaths::path() More... | |
| fileName | globalPath () const |
| Return global path for the case = rootPath/globalCaseName. Same as TimePaths::globalPath() More... | |
| fileName | timePath () const |
| Return current time path = path/timeName. More... | |
| fileName | globalTimePath () const |
| Return current time global path = globalPath/timeName. More... | |
| const dictionary & | controlDict () const noexcept |
| Return read access to the controlDict dictionary. More... | |
| virtual const fileName & | dbDir () const |
| Local directory path of this objectRegistry relative to the time. More... | |
| IOstreamOption | writeStreamOption () const noexcept |
| Get write stream option (format, compression, version) More... | |
| IOstreamOption::streamFormat | writeFormat () const noexcept |
| Get write stream format. More... | |
| IOstreamOption::streamFormat | writeFormat (IOstreamOption::streamFormat fmt) noexcept |
| Set the write stream format and return the previous value. More... | |
| IOstreamOption::compressionType | writeCompression () const noexcept |
| Get the write stream compression. More... | |
| IOstreamOption::versionNumber | writeVersion () const noexcept |
| Get the write stream version. More... | |
| const word & | graphFormat () const noexcept |
| Default graph format. More... | |
| Switch | runTimeModifiable () const noexcept |
| Supports re-reading. More... | |
| Switch | runTimeModifiable (Switch sw) noexcept |
| Set re-reading support on/off (use with caution). More... | |
| virtual bool | read () |
| Read control dictionary, update controls and time. More... | |
| void | readModifiedObjects () |
| Read the objects that have been modified. More... | |
| word | findInstance (const fileName &dir, const word &name=word::null, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, const word &stopInstance=word::null) const |
| Return time instance (location) of dir that contains the file name (eg, used in reading mesh data). More... | |
| word | findInstancePath (const fileName &directory, const instant &t) const |
| Search the case for the time directory path corresponding to the given instance. More... | |
| word | findInstancePath (const instant &t) const |
| Search the case for the time directory path corresponding to the given instance. More... | |
| virtual bool | writeTimeDict () const |
| Write time dictionary to the <time>/uniform directory. More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write using stream options. More... | |
| bool | writeNow () |
| Write the objects immediately (not at end of iteration) and continue the run. More... | |
| bool | writeAndEnd () |
| Write the objects now (not at end of iteration) and end the run. More... | |
| void | writeOnce () |
| Write the objects once (one shot) and continue the run. More... | |
| Ostream & | printExecutionTime (OSstream &os) const |
| Print the elapsed ExecutionTime (cpu-time), ClockTime. More... | |
| virtual label | startTimeIndex () const |
| Return start time index. More... | |
| virtual dimensionedScalar | startTime () const |
| Return start time. More... | |
| virtual dimensionedScalar | endTime () const |
| Return end time. More... | |
| virtual stopAtControls | stopAt () const |
| Return the stop control information. More... | |
| virtual bool | isAdjustTimeStep () const |
| Return true if adjustTimeStep is true. More... | |
| const functionObjectList & | functionObjects () const noexcept |
| Return the list of function objects. More... | |
| dlLibraryTable & | libs () const noexcept |
| Mutable access to the loaded dynamic libraries. More... | |
| label | subCycling () const noexcept |
| Zero (tests as false) if time is not being sub-cycled, otherwise the current sub-cycle index or the total number of sub-cycles. More... | |
| const TimeState & | prevTimeState () const |
| Return previous TimeState if time is being sub-cycled. More... | |
| virtual bool | run () const |
| Return true if run should continue,. More... | |
| virtual bool | loop () |
| Return true if run should continue and if so increment time. More... | |
| virtual bool | end () const |
| Return true if end of run,. More... | |
| virtual bool | stopAt (const stopAtControls stopCtrl) const |
| Adjust the current stopAtControl. More... | |
| virtual void | setTime (const Time &t) |
| Reset the time and time-index to those of the given time. More... | |
| virtual void | setTime (const instant &inst, const label newIndex) |
| Reset the time and time-index. More... | |
| virtual void | setTime (const dimensionedScalar &newTime, const label newIndex) |
| Reset the time and time-index. More... | |
| virtual void | setTime (const scalar newTime, const label newIndex) |
| Reset the time and time-index. More... | |
| virtual void | setEndTime (const dimensionedScalar &endTime) |
| Reset end time. More... | |
| virtual void | setEndTime (const scalar endTime) |
| Reset end time. More... | |
| virtual void | setDeltaT (const dimensionedScalar &deltaT, const bool adjust=true) |
| Reset time step, normally also calling adjustDeltaT() More... | |
| virtual void | setDeltaT (const scalar deltaT, const bool adjust=true) |
| Reset time step, normally also calling adjustDeltaT() More... | |
| virtual TimeState | subCycle (const label nSubCycles) |
| Set time to sub-cycle for the given number of steps. More... | |
| virtual void | subCycleIndex (const label index) |
| Adjust the reported sub-cycle index. More... | |
| virtual void | endSubCycle () |
| Reset time after sub-cycling back to previous TimeState. More... | |
| functionObjectList & | functionObjects () noexcept |
| Return non-const access to the list of function objects. More... | |
| virtual Time & | operator+= (const dimensionedScalar &deltaT) |
| Set deltaT to that specified and increment time via operator++() More... | |
| virtual Time & | operator+= (const scalar deltaT) |
| Set deltaT to that specified and increment time via operator++() More... | |
| virtual Time & | operator++ () |
| Prefix increment,. More... | |
| virtual Time & | operator++ (int) |
| Postfix increment, this is identical to the prefix increment. More... | |
| const word & | timeName () const noexcept |
| Return the current time name. More... | |
| const fileName & | rootPath () const noexcept |
| Return the rootPath. More... | |
| const fileName & | globalCaseName () const noexcept |
| Return global case name. More... | |
| const fileName & | caseName () const noexcept |
| Return case name. More... | |
| fileName & | caseName () noexcept |
| Return case name. More... | |
| Public Member Functions inherited from clock | |
| clock () | |
| Construct with the current clock time for the start point. More... | |
| double | elapsedClockTime () const |
| Returns wall-clock time since clock instantiation. More... | |
| double | clockTimeIncrement () const |
| Returns wall-clock time since last clockTimeIncrement() call. More... | |
| Public Member Functions inherited from cpuTimePosix | |
| cpuTimePosix () | |
| Construct with the current clock time. More... | |
| void | resetCpuTime () |
| Reset to use the current time for the start time. More... | |
| double | elapsedCpuTime () const |
| Return CPU time (in seconds) from the start. More... | |
| double | cpuTimeIncrement () const |
| Return CPU time (in seconds) since last call to cpuTimeIncrement() More... | |
| Public Member Functions inherited from TimePaths | |
| TimePaths (const bool processorCase, const fileName &rootPath, const bool distributed, const fileName &globalCaseName, const fileName &caseName, const word &systemDirName="system", const word &constantDirName="constant") | |
| Construct from all components. More... | |
| TimePaths (const argList &args, const word &systemDirName="system", const word &constantDirName="constant") | |
| Construct using characteristics given by the argList. More... | |
| TimePaths (const fileName &rootPath, const fileName &caseName, const word &systemDirName="system", const word &constantDirName="constant") | |
| Construct from rootPath and casePath. More... | |
| bool | distributed () const noexcept |
| True if case running with parallel distributed directories (ie. not NFS mounted) More... | |
| bool | processorCase () const noexcept |
| True if this is a processor case. More... | |
| bool | processorCase (bool on) noexcept |
| Set processor case status. Return old status. More... | |
| const fileName & | rootPath () const noexcept |
| Return root path. More... | |
| const fileName & | globalCaseName () const noexcept |
| Return global case name. More... | |
| const fileName & | caseName () const noexcept |
| Return case name. More... | |
| fileName & | caseName () noexcept |
| The case name for modification (use with caution) More... | |
| fileName | path () const |
| Return path for the case = rootPath/caseName. More... | |
| fileName | globalPath () const |
| Return global path for the case = rootPath/globalCaseName. More... | |
| fileName | relativePath (const fileName &input, const bool caseTag=false) const |
| Return the input relative to the globalPath by stripping off a leading value of the globalPath. More... | |
| const word & | constant () const noexcept |
| Return constant name. More... | |
| const word & | system () const noexcept |
| Return system name. More... | |
| fileName | caseConstant () const |
Return the constant name for the case, which is | |
| fileName | caseSystem () const |
Return the system name for the case, which is | |
| fileName | constantPath () const |
| Return constant path. More... | |
| fileName | systemPath () const |
| Return system path. More... | |
| instantList | times () const |
| Search the case for valid time directories. More... | |
| instant | findClosestTime (const scalar t) const |
| Search the case for the time closest to the given time. More... | |
| Public Member Functions inherited from objectRegistry | |
| 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... | |
| 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) |
| Public Member Functions inherited from regIOobject | |
| 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 all file watches and remove object from registry. 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 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... | |
| Public Member Functions inherited from IOobject | |
| 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 |
| Public Member Functions inherited from IOobjectOption | |
| 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... | |
| Public Member Functions inherited from HashTable< regIOobject *> | |
| 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) | |
| Construct from an initializer list. 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... | |
| Public Member Functions inherited from HashTableCore | |
| ClassName ("HashTable") | |
| Declare type-name (with debug switch) More... | |
| HashTableCore () noexcept=default | |
| Default construct. More... | |
| Public Member Functions inherited from TimeState | |
| TimeState () | |
| Construct a zero time state, using the current time formatting. More... | |
| virtual | ~TimeState ()=default |
| Destructor. More... | |
| virtual scalar | userTimeToTime (const scalar theta) const |
| Convert the user-time (e.g. CA deg) to real-time (s). More... | |
| virtual scalar | timeToUserTime (const scalar t) const |
| Convert the real-time (s) into user-time (e.g. CA deg) More... | |
| scalar | timeOutputValue () const |
| Return the current user-time value. (ie, after applying any timeToUserTime() conversion) More... | |
| const word & | timeName () const noexcept |
| Return the current time name. More... | |
| label | timeIndex () const noexcept |
| Return the current time index. More... | |
| scalar | deltaTValue () const noexcept |
| Return time step value. More... | |
| scalar | deltaT0Value () const noexcept |
| Return old time step value. More... | |
| dimensionedScalar | deltaT () const |
| Return time step. More... | |
| dimensionedScalar | deltaT0 () const |
| Return old time step. More... | |
| bool | writeTime () const noexcept |
| True if this is a write interval. More... | |
| bool | outputTime () const noexcept |
| Deprecated(2016-05) return true if this is a write time. More... | |
| Public Member Functions inherited from dimensioned< scalar > | |
| dimensioned () | |
| A dimensionless Zero, named "0". More... | |
| dimensioned (const dimensionSet &dims) | |
| A dimensioned Zero, named "0". More... | |
| dimensioned (const dimensionSet &dims, const Foam::zero) | |
| A dimensioned Zero, named "0". More... | |
| dimensioned (const dimensionSet &dims, const Foam::one) | |
| A dimensioned pTraits::one, named "1". More... | |
| dimensioned (const scalar &val) | |
| Implicit construct dimensionless from given value. More... | |
| dimensioned (const dimensionSet &dims, const scalar &val) | |
| Construct dimensioned from given value. More... | |
| dimensioned (const word &name, const dimensionSet &dims, const scalar &val) | |
| Construct from components (name, dimensions, value). More... | |
| dimensioned (const word &name, const dimensioned< scalar > &dt) | |
| Copy construct dimensioned Type with a new name. More... | |
| dimensioned (const primitiveEntry &e) | |
| Construct from primitive entry with given name. More... | |
| dimensioned (const primitiveEntry &e, const dimensionSet &dims) | |
| Construct from primitive entry with given name and dimensions. More... | |
| dimensioned (const word &name, const dictionary &dict) | |
| Construct from dictionary lookup with a given name. More... | |
| dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict) | |
| Construct from dictionary lookup with a given name and dimensions. More... | |
| dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict, const word &entryName) | |
| Construct from dictionary lookup with a given name and dimensions. More... | |
| dimensioned (const word &name, const dimensionSet &dims, const scalar &val, const dictionary &dict) | |
| Construct from components (name, dimensions, value) with optional dictionary override. More... | |
| dimensioned (Istream &is) | |
| Deprecated(2018-11) Construct from Istream (expects name, dimensions, value) More... | |
| dimensioned (const word &name, Istream &is) | |
| Deprecated(2018-11) Construct from Istream with given name (expects dimensions, value) More... | |
| dimensioned (const word &name, const dimensionSet &dims, Istream &is) | |
| Deprecated(2018-11) Construct from Istream with given name and expected dimensions. More... | |
| const word & | name () const noexcept |
| Return const reference to name. More... | |
| word & | name () noexcept |
| Return non-const reference to name. More... | |
| const dimensionSet & | dimensions () const noexcept |
| Return const reference to dimensions. More... | |
| dimensionSet & | dimensions () noexcept |
| Return non-const reference to dimensions. More... | |
| const scalar & | value () const noexcept |
| Return const reference to value. More... | |
| scalar & | value () noexcept |
| Return non-const reference to value. More... | |
| dimensioned< cmptType > | component (const direction d) const |
| Return a component as a dimensioned<cmptType> More... | |
| void | replace (const direction d, const dimensioned< cmptType > &dc) |
| Return a component with a dimensioned<cmptType> More... | |
| dimensioned< scalar > | T () const |
| Return transpose. More... | |
| bool | read (const dictionary &dict) |
| Update the value of dimensioned<Type>, lookup in dictionary with the name(). More... | |
| bool | read (const word &entryName, const dictionary &dict) |
| Update the value of dimensioned<Type>, using an alternative entry name. More... | |
| Istream & | read (Istream &is, const bool readName=true) |
| Read (name, dimensions, value) from stream, using units from system table. More... | |
| Istream & | read (Istream &is, const dictionary &readSet) |
| Read (name, dimensions, value) from stream, using units from dictionary. More... | |
| Istream & | read (Istream &is, const HashTable< dimensionedScalar > &readSet) |
| Read (name, dimensions, value) from stream, using units from table. More... | |
| bool | readIfPresent (const dictionary &dict) |
| Update the value of dimensioned<Type> if found in the dictionary, lookup in dictionary with the name(). More... | |
| bool | readIfPresent (const word &entryName, const dictionary &dict) |
| Update the value of dimensioned<Type> if found in the dictionary, using an alternative entry name. More... | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write as a dictionary entry with keyword. More... | |
| dimensioned< cmptType > | operator[] (const direction d) const |
| Return a component as a dimensioned<cmptType> More... | |
| void | operator+= (const dimensioned< scalar > &dt) |
| void | operator-= (const dimensioned< scalar > &dt) |
| void | operator*= (const scalar s) |
| void | operator/= (const scalar s) |
Static Public Member Functions | |
| static autoPtr< Time > | New () |
| Construct (dummy) Time - no functionObjects or libraries. More... | |
| static autoPtr< Time > | New (const fileName &caseDir) |
| Construct (dummy) Time - no functionObjects or libraries. More... | |
| static autoPtr< Time > | New (const argList &args) |
| Construct (dummy) Time - no functionObjects or libraries. More... | |
| static autoPtr< Time > | NewGlobalTime () |
| Construct (dummy) global Time - no functionObjects or libraries, using the global path information stored in the FOAM_CASE environment. See argList::envGlobalPath() More... | |
| static autoPtr< Time > | NewGlobalTime (const Time &runTime) |
| Construct (dummy) global Time - no functionObjects or libraries, using the global path information from the referenced Time. More... | |
| static word | timeName (const scalar t, const int precision=precision_) |
| Return a time name for the given scalar time value formatted with the given precision. More... | |
| Static Public Member Functions inherited from clock | |
| static time_t | getTime () |
| Get the current clock time in seconds. More... | |
| static const struct tm | rawDate () |
| The current wall-clock date as a raw struct. More... | |
| static std::string | dateTime () |
| The current wall-clock date/time (in local time) as a string in ISO-8601 format (yyyy-mm-ddThh:mm:ss). More... | |
| static std::string | date () |
| The current wall-clock date as a string formatted as (MON dd yyyy), where MON is Jan, Feb, etc. More... | |
| static std::string | clockTime () |
| The current wall-clock (in local time) as a string formatted as as (hh:mm:ss). More... | |
| Static Public Member Functions inherited from TimePaths | |
| static instantList | findTimes (const fileName &directory, const word &constantDirName="constant") |
| Search a given directory for valid time directories. More... | |
| static label | findClosestTimeIndex (const instantList &timeDirs, const scalar t, const word &constantDirName="constant") |
| Search instantList for the time index closest to the specified time. More... | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. More... | |
| template<class Type > | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. More... | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. More... | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class StringType > | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More... | |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ) More... | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
| Static Public Member Functions inherited from HashTableCore | |
| static label | canonicalSize (const label requested_size) |
| Return a canonical (power-of-two) of the requested size. More... | |
| Static Public Member Functions inherited from dimensioned< scalar > | |
| static dimensioned< scalar > | getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const scalar &deflt=scalar(Zero)) |
| Construct dimensioned from dictionary, with default value. More... | |
| static dimensioned< scalar > | getOrDefault (const word &name, const dictionary &dict, const scalar &deflt=scalar(Zero)) |
| Construct dimensionless from dictionary, with default value. More... | |
| static dimensioned< scalar > | getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const scalar &deflt=scalar(Zero)) |
| Construct dimensioned from dictionary, with default value. More... | |
| static dimensioned< scalar > | getOrAddToDict (const word &name, dictionary &dict, const scalar &deflt=scalar(Zero)) |
| Construct dimensionless from dictionary, with default value. More... | |
| static dimensioned< scalar > | lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const scalar &deflt=scalar(Zero)) |
| Same as getOrDefault() More... | |
| static dimensioned< scalar > | lookupOrDefault (const word &name, const dictionary &dict, const scalar &deflt=scalar(Zero)) |
| Same as getOrDefault() More... | |
| static dimensioned< scalar > | lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const scalar &deflt=scalar(Zero)) |
| Same as getOrAddToDict() More... | |
| static dimensioned< scalar > | lookupOrAddToDict (const word &name, dictionary &dict, const scalar &deflt=scalar(Zero)) |
| Same as getOrAddToDict() More... | |
Static Public Attributes | |
| static const Enum< writeControls > | writeControlNames |
| Names for writeControls. More... | |
| static const Enum< stopAtControls > | stopAtControlNames |
| Names for stopAtControls. More... | |
| static int | printExecutionFormat_ |
| Style for "ExecutionTime = " output. More... | |
| static word | controlDictName |
| The default control dictionary name (normally "controlDict") More... | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. More... | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_') More... | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. More... | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. More... | |
| Static Public Attributes inherited from HashTableCore | |
| static const label | maxTableSize |
| Maximum allowable internal table size. Approximately labelMax/4. More... | |
Protected Member Functions | |
| void | adjustDeltaT () |
| Adjust the time step so that writing occurs at the specified time. More... | |
| void | setControls () |
| Set the controls from the current controlDict. More... | |
| void | setMonitoring (const bool forceProfiling=false) |
| Set file monitoring, profiling, etc. More... | |
| virtual void | readDict () |
| Read the control dictionary and set the write controls etc. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. More... | |
| Protected Member Functions inherited from TimeState | |
| void | resetTimeState (const word &newName, const scalar newValue, const label newIndex) |
| Reset some of TimeState (name, value, index) More... | |
Protected Attributes | |
| label | startTimeIndex_ |
| scalar | startTime_ |
| scalar | endTime_ |
| stopAtControls | stopAt_ |
| writeControls | writeControl_ |
| scalar | writeInterval_ |
| label | purgeWrite_ |
| FIFOStack< word > | previousWriteTimes_ |
| label | subCycling_ |
| The total number of sub-cycles, the current sub-cycle index, or 0 if time is not being sub-cycled. More... | |
| bool | writeOnce_ |
| autoPtr< TimeState > | prevTimeState_ |
| If time is being sub-cycled this is the previous TimeState. More... | |
| sigWriteNow | sigWriteNow_ |
| Signal handler for one-shot writing upon signal. More... | |
| sigStopAtWriteNow | sigStopAtWriteNow_ |
| Signal handler for write and clean exit upon signal. More... | |
| Protected Attributes inherited from TimeState | |
| label | timeIndex_ |
| label | writeTimeIndex_ |
| scalar | deltaT_ |
| scalar | deltaT0_ |
| scalar | deltaTSave_ |
| bool | deltaTchanged_ |
| bool | writeTime_ |
Static Protected Attributes | |
| static IOstreamOption::floatFormat | format_ |
| Format for time directory names (general | fixed | scientific) More... | |
| static int | precision_ |
| Time directory name precision. More... | |
| static const int | maxPrecision_ |
| Maximum time directory name precision. More... | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Additional Inherited Members | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| Helper: write content for FoamFile IOobject header with optional meta information. More... | |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Helper: write dictionary content for FoamFile header with optional meta information. More... | |
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
| enum writeControls |
| enum stopAtControls |
Stop-run control options, which are primarily used when altering the stopAt condition.
| Enumerator | |
|---|---|
| saEndTime | Stop when Time reaches prescribed endTime. |
| saNoWriteNow | Adjust endTime to stop immediately w/o writing. |
| saWriteNow | adjust endTime to stop immediately w/ writing |
| saNextWrite | stop at the next data write interval |
| saUnknown | Dummy no-op. Do not change current value. |
|
inline |
Construct from argument list, reading from specified control dictionary name.
Uses "system" and "constant" for its directories.
| rOpt | Read option for controlDict and objectRegistry |
| Time | ( | const word & | ctrlDictName, |
| const argList & | args, | ||
| const word & | systemDirName, | ||
| const word & | constantDirName, | ||
| const bool | enableFunctionObjects = true, |
||
| const bool | enableLibs = true, |
||
| IOobjectOption::readOption | rOpt = IOobjectOption::READ_MODIFIED |
||
| ) |
Construct from argument list, reading from specified control dictionary name.
Use specified system/constant directory names.
| systemDirName | "system" directory name |
| constantDirName | "constant" directory name |
| rOpt | Read option for controlDict and objectRegistry |
Definition at line 484 of file Time.C.
References argList::allowFunctionObjects(), argList::allowLibs(), args, argList::found(), and IOobjectOption::readOpt().
|
inline |
Construct given name of dictionary to read and root/case paths.
Uses "system" and "constant" for its directories.
| rOpt | Read option for controlDict and objectRegistry |
| Time | ( | const word & | ctrlDictName, |
| const fileName & | rootPath, | ||
| const fileName & | caseName, | ||
| const word & | systemDirName, | ||
| const word & | constantDirName, | ||
| const bool | enableFunctionObjects = true, |
||
| const bool | enableLibs = true, |
||
| IOobjectOption::readOption | rOpt = IOobjectOption::READ_MODIFIED |
||
| ) |
Construct given name of dictionary to read and root/case paths.
Use specified system/constant directory names.
| systemDirName | "system" directory name |
| constantDirName | "constant" directory name |
| rOpt | Read option for controlDict and objectRegistry |
Definition at line 417 of file Time.C.
References IOobjectOption::readOpt().
|
inline |
Construct from root/case paths, with initial dictionary content without reading from "controlDict".
Uses "system" and "constant" for its directories.
| rOpt | Read option for controlDict and objectRegistry |
| Time | ( | const dictionary & | dict, |
| const fileName & | rootPath, | ||
| const fileName & | caseName, | ||
| const word & | systemDirName, | ||
| const word & | constantDirName, | ||
| const bool | enableFunctionObjects = true, |
||
| const bool | enableLibs = true, |
||
| IOobjectOption::readOption | rOpt = IOobjectOption::READ_MODIFIED |
||
| ) |
Construct from root/case paths, with initial dictionary content without reading from "controlDict".
Use specified system/constant directory names.
| systemDirName | "system" directory name |
| constantDirName | "constant" directory name |
| rOpt | Read option for controlDict and objectRegistry |
Definition at line 560 of file Time.C.
References IOobjectOption::readOpt().
| Time | ( | const fileName & | rootPath, |
| const fileName & | caseName, | ||
| const word & | systemDirName, | ||
| const word & | constantDirName, | ||
| const bool | enableFunctionObjects = true, |
||
| const bool | enableLibs = true |
||
| ) |
Construct from root/case paths without reading or requiring a controlDict or other files.
Use specified system/constant directory names. Uses default controls values (write: timeStep, stop: endTime, format: ASCII, ...)
| systemDirName | "system" directory name |
| constantDirName | "constant" directory name |
|
virtual |
Destructor.
Definition at line 692 of file Time.C.
References objectRegistry::clear(), Foam::fileHandler, forAllReverse, and profiling::stop().
|
protected |
Adjust the time step so that writing occurs at the specified time.
Definition at line 95 of file Time.C.
References functionObjectList::adjustTimeStep(), TimeState::deltaT_, Foam::labelMax, Foam::max(), Foam::min(), Time::startTime_, dimensioned< scalar >::value(), Time::wcAdjustableRunTime, Time::writeControl_, Time::writeInterval_, and TimeState::writeTimeIndex_.
|
protected |
Set the controls from the current controlDict.
Definition at line 139 of file Time.C.
References UList< T >::back(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler, UList< T >::front(), IOWarningInFunction, IOobjectOption::LAZY_READ, Foam::mag(), UPstream::myProcNo(), Foam::nl, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, UPstream::nProcs(), oldTime, UPstream::parRun(), path(), dictionary::readIfPresent(), Foam::reduce(), Foam::returnReduceAnd(), Foam::returnReduceOr(), setTime(), UList< T >::size(), timeName, and WarningInFunction.
|
protected |
Set file monitoring, profiling, etc.
Optionally force profiling without inspecting the controlDict
Definition at line 344 of file Time.C.
References IOobjectOption::AUTO_WRITE, Pstream::broadcast(), Foam::debug::controlDict(), Foam::fileHandler, dictionary::findDict(), dictionary::getOrDefault(), profiling::initialize(), IOobjectOption::NO_READ, IOobjectOption::REGISTER, timeName, and UPstream::worldComm.
|
protectedvirtual |
Read the control dictionary and set the write controls etc.
Reimplemented in crankConRod, and engineTime.
Definition at line 83 of file TimeIO.C.
References IOstreamOption::ASCII, List< T >::clear(), IOstreamOption::COMPRESSED, IOstreamOption::compression(), Foam::debug::debugObjects(), IOstream::defaultPrecision(), TimeState::deltaT_, TimeState::deltaTchanged_, DetailInfo, dict, Foam::debug::dimensionedConstantObjects(), Foam::dimensionedConstants(), Foam::debug::dimensionSetObjects(), Foam::dimensionSystems(), TimePaths::distributed(), Foam::endl(), Time::endTime_, Foam::exit(), Foam::FatalError, Foam::FatalIOError, FatalIOErrorInFunction, fileOperation::fileHandler(), Foam::fileHandler, DictionaryBase< IDLListType, T >::find(), dictionary::findDict(), IOstreamOption::floatFormatEnum(), forAllConstIters(), forAllReverse, IOstreamOption::format(), Time::format_, dictionary::found(), dictionary::get(), Foam::Info, Foam::infoDetailLevel, Foam::debug::infoObjects(), IOWarningInFunction, dictionary::merge(), baseIOdictionary::name(), dimensioned< scalar >::name(), fileOperation::New(), Foam::nl, objectRegistry::objects(), Foam::debug::optimisationObjects(), os(), Foam::Perr, Foam::Pout, OSstream::precision(), Time::precision_, Time::purgeWrite_, dictionary::readEntry(), Enum< EnumType >::readIfPresent(), dictionary::readIfPresent(), Time::saEndTime, Foam::Serr, Foam::setEnv(), simpleObjectRegistry::setValues(), UList< T >::size(), Foam::Sout, Time::stopAt_, Time::stopAtControlNames, error::stream(), ofstreamPointer::supports_gz(), TimeState::timeName(), IOstreamOption::UNCOMPRESSED, dimensioned< scalar >::value(), IOstreamOption::version(), WarningInFunction, regIOobject::watchIndices(), Time::wcAdjustableRunTime, Time::wcRunTime, Time::wcTimeStep, Time::writeControl_, Time::writeControlNames, Time::writeInterval_, and TimeState::writeTimeIndex_.
Referenced by engineTime::readDict(), and crankConRod::readDict().
| TypeName | ( | "time" | ) |
Runtime type information.
|
static |
Construct (dummy) Time - no functionObjects or libraries.
Definition at line 26 of file TimeNew.C.
References autoPtr< T >::New().
Referenced by MapFieldConstraint< Type >::read().
|
static |
Construct (dummy) Time - no functionObjects or libraries.
Definition at line 53 of file TimeNew.C.
References fileName::name(), autoPtr< T >::New(), and fileName::path().
|
static |
Construct (dummy) Time - no functionObjects or libraries.
Definition at line 65 of file TimeNew.C.
References args, Time::controlDictName, IOobjectOption::MUST_READ, and autoPtr< T >::New().
|
static |
Construct (dummy) global Time - no functionObjects or libraries, using the global path information stored in the FOAM_CASE environment. See argList::envGlobalPath()
Definition at line 78 of file TimeNew.C.
References argList::envGlobalPath(), fileName::name(), autoPtr< T >::New(), fileName::path(), and fileName::toAbsolute().
Referenced by debugWriter::write(), boundaryDataWriter::write(), boundaryDataWriter::writeTemplate(), and debugWriter::writeTemplate().
|
static |
Construct (dummy) global Time - no functionObjects or libraries, using the global path information from the referenced Time.
Definition at line 93 of file TimeNew.C.
References Time::globalPath(), autoPtr< T >::New(), runTime, and fileName::toAbsolute().
|
static |
Return a time name for the given scalar time value formatted with the given precision.
Definition at line 714 of file Time.C.
Referenced by constantAbsorptionEmission::aCont(), adjointLaminar::adjointMeanFlowSource(), adjointkOmegaSST::adjointMeanFlowSource(), adjointSpalartAllmaras::allocateMask(), kEpsilon::allocateMeanFields(), kOmegaSST::allocateMeanFields(), RASModelVariables::allocateMeanFields(), fieldToCell::applyToSet(), variablesSet::autoCreateMeshMovementField(), coordSetWriter::beginTime(), surfaceWriter::beginTime(), Bezier::Bezier(), blended< Type >::blendingFactor(), cellCoBlended< Type >::blendingFactor(), Foam::calc_pTotal(), Foam::calc_rhoU(), nearWallFields::calcAddressing(), curvatureSeparation::calcCosAngle(), ObukhovLength::calcOL(), DarcyForchheimer::calcTransformModelData(), RASModelVariables::cloneRefPtr(), adjointEikonalSolver::computeYPhi(), contactAngleForce::correct(), curvatureSeparation::correct(), wallDistAddressing::correct(), cubic< Type >::correction(), waxSolventEvaporation::correctModel(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), epsilonWallFunctionFvPatchScalarField::createAveragingWeights(), cellCellStencil::createField(), logFiles::createFiles(), distanceSurface::createGeometry(), cloud::createIOField(), ATCModel::createLimiter(), Foam::createZeroFieldPtr(), filmTurbulenceModel::Cw(), constant::d(), faMeshDecomposition::decomposeMesh(), adjointLaminar::distanceSensitivities(), adjointkOmegaSST::distanceSensitivities(), multiphaseMangrovesSource::dragCoeff(), masterUncollatedFileOperation::findInstance(), adjointLaminar::FISensitivityTerm(), adjointSpalartAllmaras::FISensitivityTerm(), adjointkOmegaSST::FISensitivityTerm(), forces::force(), fvMeshDistribute::generateTestField(), adjointRASModel::getAdjointTMVariable1Inst(), adjointRASModel::getAdjointTMVariable2Inst(), ATCUaGradU::getFISensitivityTerm(), cancelATC::getFISensitivityTerm(), adjointEikonalSolver::getFISensitivityTerm(), sampledSets::getOrLoadField(), probes::getOrLoadField(), topOSource::getSource(), constantHeatTransfer::h(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), simpleControl::loop(), SIMPLEControlSingleRun::loop(), meshRefinement::makeDisplacementField(), Foam::MapConsistentMesh(), Foam::MapConsistentVolFields(), Foam::MapLagrangianFields(), Foam::MapMesh(), meshToMesh::mapSrcToTgt(), Foam::MapSubMesh(), meshToMesh::mapTgtToSrc(), Foam::MapVolFields(), momentumError::momentumError(), triSurfaceMesh::movePoints(), laminar::mut(), dynamicFvMesh::New(), RASModelVariables::nut(), adjointRASModel::nutJacobianTMVar1(), adjointRASModel::nutJacobianTMVar2(), objectiveManager::objectiveManager(), kinematicSingleLayer::pp(), kinematicSingleLayer::pu(), dummy::R(), levelSetDesignVariables::readField(), Foam::reconstructLagrangian(), variablesSet::renameTurbulenceField(), filmTurbulenceModel::rho(), timeSelector::selectIfPresent(), variablesSet::setFluxField(), incompressibleAdjointMeanFlowVars::setMeanFields(), incompressibleVars::setMeanFields(), adjointRASModel::setMeanFields(), refinementIterator::setRefinement(), Time::setTime(), masterUncollatedFileOperation::setTime(), noFilm::Sh(), noScatter::sigmaEff(), constantScatter::sigmaEff(), skewCorrected< Type >::skewCorrection(), sensitivitySurface::smoothSensitivities(), twoPhaseSystem::solve(), adjointEikonalSolver::solve(), multiphaseSystem::solve(), RASTurbulenceModel::solveIter(), noFilm::Srho(), temperatureDependentContactAngleForce::theta(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), MPPICParcel< ParcelType >::trackingData::updateAverages(), KinematicParcel< ParcelType >::trackingData::updateAverages(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), objective::updateNormalizationFactor(), adjointkOmegaSST::updatePrimalRelatedFields(), laminar::Us(), coalCloudList::UTrans(), resolutionIndexModel::V(), velocityDisplacementMotionSolver::velocityDisplacementMotionSolver(), reverseLinear< Type >::weights(), clippedLinear< Type >::weights(), FIREMeshWriter::write(), RemoveParcels< CloudType >::write(), FacePostProcessing< CloudType >::write(), sensitivitySurfacePoints::write(), MeshedSurfaceProxy< Face >::write(), ParticleCollector< CloudType >::write(), areaWrite::write(), Foam::writeCellGraph(), faMeshDecomposition::writeDecomposition(), levelSetDesignVariables::writeDesignVars(), Foam::writeMeshObject(), triSurfaceMesh::writeObject(), and adjointkOmegaSST::zeroFirstCell().
|
inline |
Return path = rootPath/caseName. Same as TimePaths::path()
Definition at line 503 of file Time.H.
References TimePaths::caseName(), and TimePaths::rootPath().
Referenced by snappyLayerDriver::addLayers(), meshRefinement::baffleAndSplitMesh(), nearWallFields::calcAddressing(), snappySnapDriver::detectNearSurfaces(), snappySnapDriver::doSnap(), Foam::getGraphPathBase(), faMeshTools::newMesh(), fvMeshTools::newMesh(), snappySnapDriver::preSmoothPatch(), masterUncollatedFileOperation::readObjects(), cyclicAMIPolyPatch::resetAMI(), masterUncollatedFileOperation::setTime(), snappySnapDriver::smoothDisplacement(), triSurface::triSurface(), triSurface::triSurfInstance(), triSurface::write(), and Foam::writeCellGraph().
|
inline |
Return global path for the case = rootPath/globalCaseName. Same as TimePaths::globalPath()
Definition at line 512 of file Time.H.
References TimePaths::globalCaseName(), and TimePaths::rootPath().
Referenced by averageNeighbourFvGeometryScheme::movePoints(), Time::NewGlobalTime(), objectiveManager::objectiveManager(), abort::read(), and shortestPathSet::shortestPathSet().
|
inline |
Return current time path = path/timeName.
Definition at line 520 of file Time.H.
References TimePaths::path(), and TimeState::timeName().
Referenced by averageNeighbourFvGeometryScheme::movePoints(), MeshedSurfaceProxy< Face >::write(), molecule::writeFields(), and Foam::writePatchGraph().
|
inline |
Return current time global path = globalPath/timeName.
Definition at line 528 of file Time.H.
References TimePaths::globalPath(), and TimeState::timeName().
|
inlinenoexcept |
Return read access to the controlDict dictionary.
Definition at line 539 of file Time.H.
Referenced by thermo::readControls().
|
inlinevirtual |
Local directory path of this objectRegistry relative to the time.
Reimplemented from objectRegistry.
Definition at line 541 of file Time.H.
References fileName::null.
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Set the write stream format and return the previous value.
This change will only effective until the next readModified. As a side-effect (eg, changing from ASCII to BINARY) it may also disable compression
Definition at line 130 of file TimeI.H.
References IOstreamOption::ASCII, and IOstreamOption::UNCOMPRESSED.
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
virtual |
Read control dictionary, update controls and time.
Reimplemented from regIOobject.
Reimplemented in crankConRod, and engineTime.
Definition at line 427 of file TimeIO.C.
References Foam::fileHandler.
Referenced by engineTime::read(), and crankConRod::read().
| void readModifiedObjects | ( | ) |
Read the objects that have been modified.
Definition at line 452 of file TimeIO.C.
References Foam::fileHandler, IOobject::fileModificationChecking, IOobject::inotifyMaster, objectRegistry::modified(), UPstream::parRun(), objectRegistry::readModifiedObjects(), and IOobject::timeStampMaster.
Referenced by SIMPLEControlOpt::loop(), and Time::run().
| Foam::word findInstance | ( | const fileName & | dir, |
| const word & | name = word::null, |
||
| IOobjectOption::readOption | rOpt = IOobjectOption::MUST_READ, |
||
| const word & | stopInstance = word::null |
||
| ) | const |
Return time instance (location) of dir that contains the file name (eg, used in reading mesh data).
When is empty, searches for directory dir only. Does not search beyond stopInstance (if set) or constant.
Definition at line 725 of file Time.C.
References Foam::fileHandler, IOobject::instance(), io(), Foam::name(), and timeName.
Referenced by topoSet::findIOobject(), faMeshTools::newMesh(), fvMeshTools::newMesh(), points0MotionSolver::points0IO(), sensitivitySurface::smoothSensitivities(), and cellCellStencil::zoneID().
| Foam::word findInstancePath | ( | const fileName & | directory, |
| const instant & | t | ||
| ) | const |
Search the case for the time directory path corresponding to the given instance.
Definition at line 749 of file Time.C.
References Instant< T >::equal(), forAllReverse, word::null, and path().
Referenced by uncollatedFileOperation::readObjects().
| Foam::word findInstancePath | ( | const instant & | t | ) | const |
|
virtual |
Write time dictionary to the <time>/uniform directory.
Definition at line 498 of file TimeIO.C.
References dictionary::add(), addProfiling, IOstreamOption::ASCII, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, and timeName.
|
virtual |
Write using stream options.
Reimplemented from objectRegistry.
Definition at line 533 of file TimeIO.C.
References Foam::fileHandler, IOobject::path(), timeName, and objectRegistry::writeObject().
| bool writeNow | ( | ) |
Write the objects immediately (not at end of iteration) and continue the run.
Definition at line 582 of file TimeIO.C.
References Foam::vtk::write().
Referenced by runTimeControl::execute(), and SIMPLEControlSingleRun::writeNow().
| bool writeAndEnd | ( | ) |
Write the objects now (not at end of iteration) and end the run.
Definition at line 589 of file TimeIO.C.
Referenced by runTimeControl::execute(), and simpleControl::loop().
| void writeOnce | ( | ) |
| Foam::Ostream & printExecutionTime | ( | OSstream & | os | ) | const |
Print the elapsed ExecutionTime (cpu-time), ClockTime.
Definition at line 604 of file TimeIO.C.
References Foam::endl(), Foam::nl, os(), Foam::printTimeHMS(), and OFstream::stdStream().
Referenced by sensitivitySurface::smoothSensitivities(), adjointMeshMovementSolver::solve(), adjointEikonalSolver::solve(), and RASTurbulenceModel::solveIter().
|
virtual |
Return start time index.
Definition at line 783 of file Time.C.
Referenced by DarcyForchheimer::calcTransformModelData().
|
virtual |
Return start time.
Definition at line 789 of file Time.C.
References Foam::dimTime.
Referenced by logFiles::createFiles(), and pointHistory::pointHistory().
|
virtual |
Return end time.
Definition at line 795 of file Time.C.
References Foam::dimTime.
Referenced by SIMPLEControlSingleRun::checkEndTime(), optimisationManager::lineSearchUpdate(), and SIMPLEControlSingleRun::readIters().
|
virtual |
Return the stop control information.
Definition at line 801 of file Time.C.
Referenced by dynamicFvMesh::New().
|
virtual |
|
inlinenoexcept |
Return the list of function objects.
Definition at line 722 of file Time.H.
Referenced by stateFunctionObject::stateDict().
|
inlinenoexcept |
Mutable access to the loaded dynamic libraries.
Definition at line 730 of file Time.H.
Referenced by codedPoints0MotionSolver::libs(), codedFunctionObject::libs(), GAMGAgglomeration::New(), and functionObject::New().
|
inlinenoexcept |
Zero (tests as false) if time is not being sub-cycled, otherwise the current sub-cycle index or the total number of sub-cycles.
The interpretation of non-zero values is dependent on the routine.
Definition at line 743 of file Time.H.
References Time::subCycling_.
Referenced by masterUncollatedFileOperation::setTime().
|
inline |
Return previous TimeState if time is being sub-cycled.
Definition at line 751 of file Time.H.
References Time::prevTimeState_.
|
virtual |
Return true if run should continue,.
also invokes the functionObjectList::end() method when the time goes out of range
Definition at line 807 of file Time.C.
References profiling::active(), addProfiling, IOobject::name(), and Time::readModifiedObjects().
Referenced by runTimeControl::execute().
|
virtual |
Return true if run should continue and if so increment time.
also invokes the functionObjectList::end() method when the time goes out of range
Definition at line 889 of file Time.C.
Referenced by simpleControl::loop(), and SIMPLEControlSingleRun::loop().
|
virtual |
Return true if end of run,.
does not invoke any functionObject methods
|
virtual |
|
virtual |
Reset the time and time-index to those of the given time.
Definition at line 935 of file Time.C.
References Foam::fileHandler, TimeState::timeIndex(), Time::timeName(), and dimensioned< Type >::value().
Referenced by timeSelector::select0().
|
virtual |
Reset the time and time-index.
Definition at line 942 of file Time.C.
References Foam::fileHandler, IOobjectOption::LAZY_READ, Instant< T >::name(), IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, timeName, and Instant< T >::value().
|
virtual |
Reset the time and time-index.
Definition at line 967 of file Time.C.
References setTime(), and dimensioned< Type >::value().
|
virtual |
Reset the time and time-index.
Definition at line 973 of file Time.C.
References Foam::fileHandler, and timeName.
|
virtual |
Reset end time.
Definition at line 985 of file Time.C.
References dimensioned< Type >::value().
Referenced by SIMPLEControlSingleRun::checkEndTime(), and SIMPLEControlSingleRun::readIters().
|
virtual |
|
virtual |
Reset time step, normally also calling adjustDeltaT()
Definition at line 998 of file Time.C.
References dimensioned< Type >::value().
Referenced by SIMPLEControlOpt::resetDeltaT().
|
virtual |
Reset time step, normally also calling adjustDeltaT()
|
virtual |
Set time to sub-cycle for the given number of steps.
Definition at line 1019 of file Time.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, setTime(), and timeIndex.
Referenced by subCycleTime::subCycleTime().
|
virtual |
|
virtual |
|
inlinenoexcept |
|
virtual |
Set deltaT to that specified and increment time via operator++()
Definition at line 1070 of file Time.C.
References dimensioned< Type >::value().
|
virtual |
Set deltaT to that specified and increment time via operator++()
|
virtual |
Prefix increment,.
also invokes the functionObjectList::start() or functionObjectList::execute() method, depending on the time-index
Definition at line 1083 of file Time.C.
References stdFoam::end(), Foam::endl(), Foam::mag(), Foam::max(), Foam::min(), dimensioned< scalar >::name(), Foam::nl, Foam::pow(), Foam::reduce(), Foam::returnReduce(), setTime(), Foam::sign(), timeIndex, and WarningInFunction.
|
virtual |
|
inlinenoexcept |
Return the current time name.
Definition at line 30 of file TimeStateI.H.
|
inlinenoexcept |
Return the rootPath.
Definition at line 66 of file TimePathsI.H.
|
inlinenoexcept |
Return global case name.
Definition at line 72 of file TimePathsI.H.
Referenced by fileOperation::processorsCasePath().
|
inlinenoexcept |
Return case name.
Definition at line 78 of file TimePathsI.H.
Referenced by triSurface::triSurface(), triSurface::triSurfInstance(), and triSurface::write().
|
inlinenoexcept |
Return case name.
Definition at line 84 of file TimePathsI.H.
|
static |
|
static |
Names for stopAtControls.
Definition at line 114 of file Time.H.
Referenced by Foam::getStopAction(), abort::read(), and Time::readDict().
|
static |
|
protected |
Definition at line 156 of file Time.H.
Referenced by Time::adjustDeltaT().
|
mutableprotected |
Definition at line 158 of file Time.H.
Referenced by Time::readDict().
|
mutableprotected |
Definition at line 160 of file Time.H.
Referenced by Time::readDict().
|
protected |
Definition at line 162 of file Time.H.
Referenced by Time::adjustDeltaT(), and Time::readDict().
|
protected |
Definition at line 164 of file Time.H.
Referenced by Time::adjustDeltaT(), and Time::readDict().
|
protected |
Definition at line 166 of file Time.H.
Referenced by Time::readDict().
|
protected |
The total number of sub-cycles, the current sub-cycle index, or 0 if time is not being sub-cycled.
Definition at line 174 of file Time.H.
Referenced by Time::subCycling().
If time is being sub-cycled this is the previous TimeState.
Definition at line 182 of file Time.H.
Referenced by Time::prevTimeState().
|
protected |
|
protected |
|
staticprotected |
Format for time directory names (general | fixed | scientific)
Definition at line 197 of file Time.H.
Referenced by Time::readDict().
|
staticprotected |
Time directory name precision.
Definition at line 202 of file Time.H.
Referenced by Time::readDict().
|
staticprotected |
|
static |
The default control dictionary name (normally "controlDict")
Definition at line 268 of file Time.H.
Referenced by faMeshDecomposition::decomposeMesh(), Time::New(), and faMeshDecomposition::writeDecomposition().
1.8.14 
