Class to control time during OpenFOAM simulations that is also the top-level objectRegistry. More...

Inheritance diagram for Time:

[legend]

Collaboration diagram for Time:

[legend]

Public Types
enum	writeControl { timeStep, runTime, adjustableRunTime, clockTime, cpuTime }
	Write control options. More...

enum	stopAtControl { endTime, noWriteNow, writeNow, nextWrite }
	Stop-run control options. More...

enum	format { general = 0, fixed = ios_base::fixed, scientific = ios_base::scientific }
	Supported time directory name formats. More...

Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from HashTable< regIOobject *>
typedef regIOobject *	value_type
	Type of values the HashTable contains. More...

typedef regIOobject * &	reference
	Type that can be used for storing into HashTable::value_type. More...

typedef const regIOobject * &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

Public Types inherited from dimensioned< scalar >
typedef pTraits< scalar >::cmptType	cmptType
	Component type. More...

Public Member Functions
	TypeName ("time")

	Time (const word &name, const argList &args, const word &systemName="system", const word &constantName="constant")
	Construct given name of dictionary to read and argument list. More...

	Time (const word &name, const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant", const bool enableFunctionObjects=true)
	Construct given name of dictionary to read, rootPath and casePath. More...

	Time (const dictionary &dict, const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant", const bool enableFunctionObjects=true)
	Construct given dictionary, rootPath and casePath. More...

	Time (const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant", const bool enableFunctionObjects=true)
	Construct given endTime, rootPath and casePath. More...

virtual	~Time ()
	Destructor. More...

const dictionary &	controlDict () const
	Return the control dict. More...

virtual const fileName &	dbDir () const
	Local directory path of this objectRegistry relative to time. More...

fileName	timePath () const
	Return current time path. More...

IOstream::streamFormat	writeFormat () const
	Default write format. More...

IOstream::versionNumber	writeVersion () const
	Default write version number. More...

IOstream::compressionType	writeCompression () const
	Default write compression. More...

const word &	graphFormat () const
	Default graph format. More...

const Switch &	runTimeModifiable () const
	Supports re-reading. 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, const IOobject::readOption rOpt=IOobject::MUST_READ, const word &stopInstance=word::null) const
	Return the location of "dir" containing the file "name". More...

instantList	times () const
	Search the case for valid time directories. More...

word	findInstancePath (const fileName &path, const instant &) const
	Search the case for the time directory path. More...

word	findInstancePath (const instant &) const
	Search the case for the time directory path. More...

instant	findClosestTime (const scalar) const
	Search the case for the time closest to the given time. More...

virtual bool	writeTimeDict () const
	Write time dictionary to the <time>/uniform directory. More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

bool	writeNow ()
	Write the objects now (not at end of iteration) and continue. 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...

virtual word	timeName () const
	Return current time name. More...

virtual label	startTimeIndex () const
	Return start time index. More...

virtual dimensionedScalar	beginTime () const
	Return begin time (initial start time) More...

virtual dimensionedScalar	startTime () const
	Return start time. More...

virtual dimensionedScalar	endTime () const
	Return end time. More...

const userTimes::userTime &	userTime () const
	Return the userTime. More...

scalar	userTimeValue () const
	Return current user time value. More...

scalar	userTimeToTime (const scalar tau) const
	Convert the user-time (e.g. CA deg) to real-time (s). More...

scalar	timeToUserTime (const scalar t) const
	Convert the real-time (s) into user-time (e.g. CA deg) More...

word	userTimeName () const
	Return current user time name with units. More...

const functionObjectList &	functionObjects () const
	Return the list of function objects. More...

bool	restart () const
	Return true if the run is a restart, i.e. startTime != beginTime. More...

bool	subCycling () const
	Return true if time currently being sub-cycled, otherwise false. More...

const TimeState &	prevTimeState () const
	Return previous TimeState if time is being sub-cycled. More...

virtual bool	running () const
	Return true if run should continue without any side effects. 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 stopAtControl) const
	Adjust the current stopAtControl. Note that this value. More...

virtual void	setTime (const Time &)
	Reset the time and time-index to those of the given time. More...

virtual void	setTime (const instant &, const label newIndex)
	Reset the time and time-index. More...

virtual void	setTime (const dimensionedScalar &, const label newIndex)
	Reset the time and time-index. More...

virtual void	setTime (const scalar, const label newIndex)
	Reset the time and time-index. More...

virtual void	setEndTime (const dimensionedScalar &)
	Reset end time. More...

virtual void	setEndTime (const scalar)
	Reset end time. More...

virtual void	setDeltaT (const dimensionedScalar &)
	Reset time step. More...

virtual void	setDeltaT (const scalar)
	Reset time step. More...

virtual void	setDeltaTNoAdjust (const scalar)
	Reset time step without additional adjustment or modification. More...

virtual void	setWriteInterval (const scalar writeInterval)
	Reset the write interval. More...

virtual TimeState	subCycle (const label nSubCycles)
	Set time to sub-cycle for the given number of steps. More...

virtual void	endSubCycle ()
	Reset time after sub-cycling back to previous TimeState. More...

functionObjectList &	functionObjects ()
	Return non-const access to the list of function objects. More...

virtual Time &	operator+= (const dimensionedScalar &)
	Set deltaT to that specified and increment time via operator++() More...

virtual Time &	operator+= (const scalar)
	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...

Public Member Functions inherited from clock
	clock ()
	Null constructor which stores the start time. More...

time_t	elapsedClockTime () const
	Returns wall-clock time from clock instantiation. More...

time_t	clockTimeIncrement () const
	Returns wall-clock time from last call of clockTimeIncrement() More...

Public Member Functions inherited from cpuTime
	cpuTime ()
	Construct with the current clock 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 fileName &rootPath, const fileName &caseName, const word &systemName, const word &constantName)
	Construct given database name, rootPath and casePath. More...

	TimePaths (const bool processorCase, const fileName &rootPath, const fileName &globalCaseName, const fileName &caseName, const word &systemName, const word &constantName)
	Construct given database name, rootPath and casePath. More...

bool	processorCase () const
	Return true if this is a processor case. More...

const fileName &	rootPath () const
	Return root path. More...

const fileName &	globalCaseName () const
	Return global case name. More...

const fileName &	caseName () const
	Return case name. More...

const word &	system () const
	Return system name. More...

fileName	caseSystem () const
	Return system name for the case. More...

const word &	constant () const
	Return constant name. More...

fileName	caseConstant () const
	Return constant name for the case. More...

fileName	globalPath () const
	Return the global path. More...

fileName	path () const
	Return path. More...

Public Member Functions inherited from objectRegistry
	TypeName ("objectRegistry")
	Declare type name for this IOobject. More...

	objectRegistry (const Time &db, const label nIoObjects=128)
	Construct the time objectRegistry given an initial estimate. More...

	objectRegistry (const IOobject &io, const label nIoObjects=128)
	Construct a sub-registry given an IObject to describe the registry. More...

	objectRegistry (const objectRegistry &)
	Disallow default bitwise copy construction. More...

virtual	~objectRegistry ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	parent () const
	Return the parent objectRegistry. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

wordList	names () const
	Return the list of names of the IOobjects. More...

wordList	sortedNames () const
	Return the sorted list of names of the IOobjects. More...

wordList	names (const word &className) const
	Return the list of names of IOobjects of given class name. More...

wordList	sortedNames (const word &className) const
	Return the sorted list of names of IOobjects of given class name. More...

template<class Type >
wordList	names () const
	Return the list of names of the IOobjects of given type. More...

template<class Type >
wordList	names (const wordRe &name) const
	Return the list of objects whose name matches the input regExp. More...

template<class Type >
wordList	names (const wordReList &name) const
	Return the list of objects whose name matches the input regExp. More...

const objectRegistry &	subRegistry (const word &name, const bool forceCreate=false) const
	Lookup and return a const sub-objectRegistry. Optionally create. More...

template<class Type >
HashTable< const Type * >	lookupClass (const bool strict=false) const
	Lookup and return all objects of the given Type. More...

template<class Type >
HashTable< Type * >	lookupClass (const bool strict=false)
	Lookup and return all objects of the given Type. More...

template<class Type >
bool	foundObject (const word &name) const
	Is the named Type found? More...

template<class Type >
const Type &	lookupObject (const word &name) const
	Lookup and return the object of the given Type. More...

template<class Type >
Type &	lookupObjectRef (const word &name) const
	Lookup and return the object reference of the given Type. More...

label	getEvent () const
	Return new event number. More...

const objectRegistry &	thisDb () const
	Return the object registry. More...

virtual void	rename (const word &newName)
	Rename. More...

bool	checkIn (regIOobject &) const
	Add an regIOobject to registry. More...

bool	checkOut (regIOobject &) const
	Remove an regIOobject from registry. More...

void	clear ()
	Remove all regIOobject owned by the registry. More...

void	addTemporaryObject (const word &name) const
	Add the given name to the set of temporary objects to cache. More...

bool	cacheTemporaryObject (const word &name) const
	Return true if given name is in the cacheTemporaryObjects set. More...

template<class Object >
bool	cacheTemporaryObject (Object &ob) const
	Cache the given object. More...

void	resetCacheTemporaryObject (const regIOobject &ob) const
	Reset the cache state of the given object. More...

bool	checkCacheTemporaryObjects () const
	Check that all objects in the cacheTemporaryObjects set. 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
	writeData function required by regIOobject but not used More...

void	operator= (const objectRegistry &)=delete
	Disallow default bitwise assignment. More...

template<class Type >
Foam::wordList	names () const

template<class Type >
Foam::wordList	names (const wordRe &name) const

template<class Type >
Foam::wordList	names (const wordReList &patterns) const

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
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	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 up to date (obviously) More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

word	modelName (const char *name) const
	Return the name of the object within this model. More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

template<class Name >
Foam::word	modelName (Name name, const word &model)

Public Member Functions inherited from HashTable< regIOobject *>
bool	set (const word &, const regIOobject * &newElmt)
	Assign a new hashedEntry, overwriting existing entries. More...

	HashTable (const label size=128)
	Construct given initial table size. More...

	HashTable (Istream &, const label size=128)
	Construct from Istream. More...

	HashTable (const HashTable< regIOobject *, word, string::hash > &)
	Copy constructor. More...

	HashTable (HashTable< regIOobject *, word, string::hash > &&)
	Move constructor. More...

	HashTable (std::initializer_list< Tuple2< word, regIOobject * >>)
	Construct from an initialiser list. More...

	~HashTable ()
	Destructor. More...

label	capacity () const
	The size of the underlying table. More...

label	size () const
	Return number of elements in table. More...

bool	empty () const
	Return true if the hash table is empty. More...

bool	found (const word &) const
	Return true if hashedEntry is found in table. More...

iterator	find (const word &)
	Find and return an iterator set at the hashedEntry. More...

const_iterator	find (const word &) const
	Find and return an const_iterator set at the hashedEntry. More...

List< word >	toc () const
	Return the table of contents. More...

List< word >	sortedToc () const
	Return the table of contents as a sorted list. More...

Ostream &	printInfo (Ostream &) const
	Print information. More...

bool	insert (const word &, const regIOobject * &newElmt)
	Insert a new hashedEntry. More...

bool	erase (const iterator &)
	Erase a hashedEntry specified by given iterator. More...

bool	erase (const word &)
	Erase a hashedEntry specified by the given key. More...

label	erase (const UList< word > &)
	Remove entries given by the listed keys from this HashTable. More...

label	erase (const HashTable< AnyType, word, AnyHash > &)
	Remove entries given by the given keys from this HashTable. More...

Foam::label	erase (const HashTable< AnyType, word, AnyHash > &rhs)

void	resize (const label newSize)
	Resize the hash table for efficiency. More...

void	clear ()
	Clear all entries from table. More...

void	clearStorage ()
	Clear the table entries and the table itself. More...

void	shrink ()
	Shrink the allocated table to approx. twice number of elements. More...

void	transfer (HashTable< regIOobject *, word, string::hash > &)
	Transfer the contents of the argument table into this table. More...

regIOobject * &	operator[] (const word &)
	Find and return a hashedEntry. More...

const regIOobject * &	operator[] (const word &) const
	Find and return a hashedEntry. More...

regIOobject * &	operator() (const word &)
	Find and return a hashedEntry, create it null if not present. More...

void	operator= (const HashTable< regIOobject *, word, string::hash > &)
	Assignment operator. More...

void	operator= (HashTable< regIOobject *, word, string::hash > &&)
	Move assignment operator. More...

void	operator= (std::initializer_list< Tuple2< word, regIOobject * >>)
	Assignment to an initialiser list. More...

bool	operator== (const HashTable< regIOobject *, word, string::hash > &) const
	Equality. Hash tables are equal if the keys and values are equal. More...

bool	operator!= (const HashTable< regIOobject *, word, string::hash > &) const
	The opposite of the equality operation. Takes linear time. 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...

Public Member Functions inherited from HashTableCore
	HashTableCore ()
	Construct null. More...

	ClassName ("HashTable")
	Define template name and debug. More...

Public Member Functions inherited from TimeState
	TimeState ()

label	timeIndex () const
	Return current time index. More...

scalar	deltaTValue () const
	Return time step value. More...

scalar	deltaT0Value () const
	Return old time step value. More...

dimensionedScalar	deltaT () const
	Return time step. More...

dimensionedScalar	deltaT0 () const
	Return old time step. More...

bool	writeTime () const
	Return true if this is a write time. More...

bool	outputTime () const
	Return true if this is a write time. More...

Public Member Functions inherited from dimensioned< scalar >
	dimensioned (const word &, const dimensionSet &, const scalar &)
	Construct given name, dimensions and value. More...

	dimensioned (const dimensionSet &, const scalar &)
	Construct given dimensions and value. More...

	dimensioned (const scalar &)
	Construct dimensionless given value only. More...

	dimensioned (const word &, const dimensioned< scalar > &)
	Construct from a dimensioned<Type> changing the name. More...

	dimensioned (Istream &)
	Construct from Istream. More...

	dimensioned (const word &, Istream &)
	Construct from an Istream with a given name. More...

	dimensioned (const word &, const dimensionSet &, Istream &)
	Construct from an Istream with a given name and dimensions. More...

	dimensioned (const word &, const dimensionSet &, const dictionary &)
	Construct from dictionary lookup with a given name and dimensions. More...

	dimensioned ()
	Null constructor. More...

const word &	name () const
	Return const reference to name. More...

word &	name ()
	Return non-const reference to name. More...

const dimensionSet &	dimensions () const
	Return const reference to dimensions. More...

dimensionSet &	dimensions ()
	Return non-const reference to dimensions. More...

const scalar &	value () const
	Return const reference to value. More...

scalar &	value ()
	Return non-const reference to value. More...

dimensioned< cmptType >	component (const direction) const
	Return a component as a dimensioned<cmptType> More...

void	replace (const direction, const dimensioned< cmptType > &)
	Return a component with a dimensioned<cmptType> More...

dimensioned< scalar >	T () const
	Return transpose. More...

void	read (const dictionary &)
	Update the value of dimensioned<Type> More...

Istream &	read (Istream &is, const dictionary &)
	Read value from stream and units from dictionary. More...

Istream &	read (Istream &is, const HashTable< dimensionedScalar > &)
	Read value from stream and units from table. More...

Istream &	read (Istream &is)
	Read value from stream and units from system table. More...

bool	readIfPresent (const dictionary &)
	Update the value of dimensioned<Type> if found in the dictionary. More...

dimensioned< cmptType >	operator[] (const direction) const
	Return a component as a dimensioned<cmptType> More...

void	operator+= (const dimensioned< scalar > &)

void	operator-= (const dimensioned< scalar > &)

void	operator*= (const scalar)

void	operator/= (const scalar)

Static Public Member Functions
static label	findClosestTimeIndex (const instantList &, const scalar, const word &constantName="constant")
	Search instantList for the time index closest to the given time. More...

static word	timeName (const scalar, const int precision=curPrecision_)
	Return time name of given scalar time. More...

static instantList	findTimes (const fileName &, const word &constantName="constant")
	Search a given directory for valid time directories. 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 ()
	Return the current wall-clock date as a raw struct. More...

static string	dateTime ()
	Return the current wall-clock date/time as a string. More...

static string	date ()
	Return the current wall-clock date as a string. More...

static string	clockTime ()
	Return the current wall-clock time as a string. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

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...

template<class Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label)
	Return a canonical (power-of-two) size. More...

static iteratorEnd	cend ()
	iteratorEnd set to beyond the end of any HashTable More...

static iteratorEnd	end ()
	iteratorEnd set to beyond the end of any HashTable More...

Static Public Member Functions inherited from dimensioned< scalar >
static dimensioned< scalar >	lookupOrDefault (const word &, const dictionary &, const dimensionSet &dims=dimless, const scalar &defaultValue=pTraits< scalar >::zero)
	Construct from dictionary, with default dimensions and value. More...

static dimensioned< scalar >	lookupOrDefault (const word &, const dictionary &, const scalar &defaultValue=pTraits< scalar >::zero)
	Construct from dictionary dimensionless with value. More...

static dimensioned< scalar >	lookupOrAddToDict (const word &, dictionary &, const dimensionSet &dims=dimless, const scalar &defaultValue=pTraits< scalar >::zero)
	Construct from dictionary, with default value. More...

static dimensioned< scalar >	lookupOrAddToDict (const word &, dictionary &, const scalar &defaultValue=pTraits< scalar >::zero)
	Construct from dictionary, dimensionless with default value. More...

Static Public Attributes
static word	controlDictName
	The default control dictionary name (normally "controlDict") More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable table size. 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...

virtual void	readDict ()
	Read the control dictionary and set the write controls etc. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Protected Attributes
label	startTimeIndex_

scalar	startTime_

scalar	endTime_

scalar	beginTime_

autoPtr< userTimes::userTime >	userTime_
	Optional user-time, defaults to realTime in s. More...

stopAtControl	stopAt_

writeControl	writeControl_

scalar	writeInterval_

label	purgeWrite_

FIFOStack< word >	previousWriteTimes_

bool	writeOnce_

bool	subCycling_
	Is the time currently being sub-cycled? More...

autoPtr< TimeState >	prevTimeState_
	If time is being sub-cycled this is the previous TimeState. More...

sigWriteNow	sigWriteNow_
	Enable one-shot writing upon signal. More...

sigStopAtWriteNow	sigStopAtWriteNow_
	Enable write and clean exit upon signal. More...

Static Protected Attributes
static const NamedEnum< stopAtControl, 4 >	stopAtControlNames_

static const NamedEnum< writeControl, 5 >	writeControlNames_

static format	format_
	Time directory name format. More...

static int	precision_
	Time directory name precision. More...

static int	curPrecision_
	Current time directory name precision adjusted as necessary. More...

static const int	maxPrecision_
	Maximum time directory name precision. More...

Detailed Description

Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.

Source files

Definition at line 69 of file Time.H.

Member Enumeration Documentation

◆ writeControl

enum writeControl

strong

Write control options.

Enumerator
timeStep
runTime
adjustableRunTime
clockTime
cpuTime

Definition at line 89 of file Time.H.

◆ stopAtControl

enum stopAtControl

strong

Stop-run control options.

Enumerator
endTime	stop when Time reaches the prescribed endTime
noWriteNow	set endTime to stop immediately w/o writing
writeNow	set endTime to stop immediately w/ writing
nextWrite	stop the next time data are written

Definition at line 99 of file Time.H.

◆ format

enum format

strong

Supported time directory name formats.

Enumerator
general
fixed
scientific

Definition at line 108 of file Time.H.

Constructor & Destructor Documentation

◆ Time() [1/4]

Time	(	const word &	name,
		const argList &	args,
		const word &	systemName = `"system"`,
		const word &	constantName = `"constant"`
	)

Construct given name of dictionary to read and argument list.

Definition at line 417 of file Time.C.

References Foam::endl(), argList::executable(), forAll, IOWarningInFunction, Foam::libs, IOobject::MUST_READ_IF_MODIFIED, dlLibraryTable::open(), argList::options(), and argList::path().

Referenced by Time::setControls(), and Time::Time().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Time() [2/4]

Time	(	const word &	name,
		const fileName &	rootPath,
		const fileName &	caseName,
		const word &	systemName = `"system"`,
		const word &	constantName = `"constant"`,
		const bool	enableFunctionObjects = `true`
	)

Construct given name of dictionary to read, rootPath and casePath.

Definition at line 344 of file Time.C.

References Foam::libs, IOobject::MUST_READ_IF_MODIFIED, dlLibraryTable::open(), and Time::Time().

Here is the call graph for this function:

◆ Time() [3/4]

Time	(	const dictionary &	dict,
		const fileName &	rootPath,
		const fileName &	caseName,
		const word &	systemName = `"system"`,
		const word &	constantName = `"constant"`,
		const bool	enableFunctionObjects = `true`
	)

Construct given dictionary, rootPath and casePath.

Definition at line 522 of file Time.C.

References Foam::libs, IOobject::MUST_READ_IF_MODIFIED, dlLibraryTable::open(), and Time::Time().

Here is the call graph for this function:

◆ Time() [4/4]

Time	(	const fileName &	rootPath,
		const fileName &	caseName,
		const word &	systemName = `"system"`,
		const word &	constantName = `"constant"`,
		const bool	enableFunctionObjects = `true`
	)

Construct given endTime, rootPath and casePath.

Definition at line 596 of file Time.C.

References Foam::libs, and dlLibraryTable::open().

Here is the call graph for this function:

◆ ~Time()

~Time ( )

virtual

Destructor.

Definition at line 657 of file Time.C.

Member Function Documentation

◆ adjustDeltaT()

void adjustDeltaT ( )

protected

Adjust the time step so that writing occurs at the specified time.

Definition at line 83 of file Time.C.

References Foam::labelMax, Foam::max(), and Foam::min().

Here is the call graph for this function:

◆ setControls()

void setControls ( )

protected

Set the controls from the current controlDict.

Definition at line 109 of file Time.C.

References Foam::endl(), Foam::exists(), fileOperation::exists(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler(), found, dictionary::found(), IOWarningInFunction, UList< T >::last(), dictionary::lookup(), Foam::mag(), UPstream::myProcNo(), Foam::name(), Foam::nl, IOobject::NO_WRITE, UPstream::nProcs(), oldTime(), UPstream::parRun(), IOobject::READ_IF_PRESENT, dictionary::readIfPresent(), Foam::reduce(), setTime(), List< T >::size(), Time::Time(), timeDirs, timeName, and WarningInFunction.

Here is the call graph for this function:

◆ readDict()

void readDict ( )

protectedvirtual

Read the control dictionary and set the write controls etc.

Definition at line 32 of file TimeIO.C.

References Time::adjustableRunTime, IOstream::BINARY, IOstream::COMPRESSED, IOstream::compressionEnum(), Time::curPrecision_, IOstream::defaultPrecision(), Foam::endl(), Time::endTime, Time::endTime_, Foam::exit(), Foam::FatalError, Foam::FatalIOError, FatalIOErrorInFunction, Time::fixed, Time::format_, IOstream::formatEnum(), dictionary::found(), Time::general, IOWarningInFunction, dictionary::lookup(), dimensioned< Type >::name(), Foam::Perr, Foam::Pout, OSstream::precision(), Time::precision_, Time::purgeWrite_, NamedEnum< Enum, nEnum >::read(), dictionary::readIfPresent(), Time::runTime, Time::scientific, Foam::Serr, Foam::setEnv(), Time::setWriteInterval(), Foam::Sout, Time::stopAt_, Time::stopAtControlNames_, Time::timeName(), Time::timeStep, Time::timeToUserTime(), IOstream::UNCOMPRESSED, Time::userTime_, Time::userTimeToTime(), dimensioned< scalar >::value(), WarningInFunction, Time::writeControl_, Time::writeControlNames_, and Time::writeInterval_.

Referenced by Time::read(), and Time::readModifiedObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "time" )

◆ controlDict()

const dictionary& controlDict ( ) const

inline

Return the control dict.

Definition at line 275 of file Time.H.

◆ dbDir()

virtual const fileName& dbDir ( ) const

inlinevirtual

Local directory path of this objectRegistry relative to time.

Reimplemented from objectRegistry.

Definition at line 281 of file Time.H.

References fileName::null.

◆ timePath()

fileName timePath ( ) const

inline

Return current time path.

Definition at line 287 of file Time.H.

References TimePaths::path(), and Time::timeName().

Referenced by meanVelocityForce::meanVelocityForce(), MeshedSurfaceProxy< Face >::write(), and molecule::writeFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFormat()

IOstream::streamFormat writeFormat ( ) const

inline

Default write format.

Definition at line 293 of file Time.H.

◆ writeVersion()

IOstream::versionNumber writeVersion ( ) const

inline

Default write version number.

Definition at line 299 of file Time.H.

◆ writeCompression()

IOstream::compressionType writeCompression ( ) const

inline

Default write compression.

Definition at line 305 of file Time.H.

Referenced by PatchPostProcessing< CloudType >::write().

Here is the caller graph for this function:

◆ graphFormat()

const word& graphFormat ( ) const

inline

Default graph format.

Definition at line 311 of file Time.H.

◆ runTimeModifiable()

const Switch& runTimeModifiable ( ) const

inline

Supports re-reading.

Definition at line 317 of file Time.H.

References Time::beginTime(), Time::endTime(), Time::findClosestTime(), Time::findClosestTimeIndex(), Time::findInstance(), Time::findInstancePath(), Time::findTimes(), IOobject::MUST_READ, dimensioned< scalar >::name(), word::null, TimePaths::path(), Time::read(), Time::readModifiedObjects(), Time::startTime(), Time::startTimeIndex(), Time::timeName(), Time::times(), Time::timeToUserTime(), Time::userTime(), Time::userTimeName(), Time::userTimeToTime(), Time::userTimeValue(), regIOobject::write(), Time::writeAndEnd(), Time::writeNow(), Time::writeObject(), Time::writeOnce(), and Time::writeTimeDict().

Here is the call graph for this function:

◆ read()

bool read ( )

virtual

Read control dictionary, update controls and time.

Reimplemented from regIOobject.

Definition at line 212 of file TimeIO.C.

References Time::readDict().

Referenced by Time::runTimeModifiable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readModifiedObjects()

void readModifiedObjects ( )

Read the objects that have been modified.

Definition at line 227 of file TimeIO.C.

References Foam::fileHandler(), IOobject::fileModificationChecking, IOobject::inotifyMaster, objectRegistry::modified(), UPstream::parRun(), functionObjectList::read(), Time::readDict(), regIOobject::readIfModified(), objectRegistry::readModifiedObjects(), IOobject::timeStampMaster, and fileOperation::updateStates().

Referenced by Time::run(), and Time::runTimeModifiable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findInstance()

Foam::word findInstance	(	const fileName &	dir,
		const word &	name = `word::null`,
		const IOobject::readOption	rOpt = `IOobject::MUST_READ`,
		const word &	stopInstance = `word::null`
	)		const

Return the location of "dir" containing the file "name".

(eg, used in reading mesh data) If name is null, search for the directory "dir" only. Does not search beyond stopInstance (if set) or constant.

Definition at line 689 of file Time.C.

References Foam::fileHandler(), Time::findInstancePath(), IOobject::instance(), and timeName.

Referenced by points0MotionSolver::readPoints0(), Time::runTimeModifiable(), and Time::times().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ times()

Foam::instantList times ( ) const

Search the case for valid time directories.

Definition at line 682 of file Time.C.

References Time::findInstance().

Referenced by fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), edgeMeshFormatsCore::getLineNoComment(), surfaceFormatsCore::getLineNoComment(), Time::runTimeModifiable(), timeSelector::select0(), and triSurface::triSurfInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findInstancePath() [1/2]

Foam::word findInstancePath	(	const fileName &	path,
		const instant &	t
	)		const

Search the case for the time directory path.

corresponding to the given instance

Definition at line 719 of file Time.C.

References instant::equal(), forAllReverse, word::null, and timeDirs.

Referenced by Time::findInstance(), uncollatedFileOperation::readObjects(), and Time::runTimeModifiable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findInstancePath() [2/2]

Foam::word findInstancePath ( const instant & t ) const

Search the case for the time directory path.

corresponding to the given instance

Definition at line 747 of file Time.C.

◆ findClosestTime()

Foam::instant findClosestTime ( const scalar t ) const

Search the case for the time closest to the given time.

Definition at line 753 of file Time.C.

References Foam::diff(), Time::findClosestTimeIndex(), UList< T >::last(), Foam::mag(), List< T >::size(), and timeDirs.

Referenced by Time::runTimeModifiable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findClosestTimeIndex()

Foam::label findClosestTimeIndex	(	const instantList &	timeDirs,
		const scalar	t,
		const word &	constantName = `"constant"`
	)

static

Search instantList for the time index closest to the given time.

Definition at line 790 of file Time.C.

References Foam::diff(), forAll, Foam::mag(), and Foam::name().

Referenced by Time::findClosestTime(), if(), and Time::runTimeModifiable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeTimeDict()

bool writeTimeDict ( ) const

virtual

Write time dictionary to the <time>/uniform directory.

Definition at line 263 of file TimeIO.C.

References dictionary::add(), IOstream::ASCII, Time::beginTime_, IOstream::currentVersion, Time::maxPrecision_, IOobject::NO_READ, IOobject::NO_WRITE, Time::timeName(), Time::timeToUserTime(), IOstream::UNCOMPRESSED, dimensioned< scalar >::value(), and Time::writeObject().

Referenced by Time::runTimeModifiable(), writeObjectsBase::write(), and Time::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeObject()

bool writeObject	(	IOstream::streamFormat	fmt,
		IOstream::versionNumber	ver,
		IOstream::compressionType	cmp,
		const bool	write
	)		const

virtual

Write using given format, version and compression.

Reimplemented from objectRegistry.

Definition at line 299 of file TimeIO.C.

References Foam::fileHandler(), regIOobject::filePath(), regIOobject::path(), Time::previousWriteTimes_, Time::purgeWrite_, fileOperation::rmDir(), Time::timeName(), objectRegistry::writeObject(), TimeState::writeTime(), and Time::writeTimeDict().

Referenced by Time::runTimeModifiable(), and Time::writeTimeDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeNow()

bool writeNow ( )

Write the objects now (not at end of iteration) and continue.

the run

Definition at line 351 of file TimeIO.C.

References regIOobject::write().

Referenced by Time::runTimeModifiable(), and Time::writeAndEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAndEnd()

bool writeAndEnd ( )

Write the objects now (not at end of iteration) and end the run.

Definition at line 358 of file TimeIO.C.

References Time::endTime_, Time::stopAt_, dimensioned< scalar >::value(), and Time::writeNow.

Referenced by convergenceControl::endIfConverged(), and Time::runTimeModifiable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeOnce()

void writeOnce ( )

Write the objects once (one shot) and continue the run.

Definition at line 367 of file TimeIO.C.

References Time::writeOnce_.

Referenced by Time::runTimeModifiable().

Here is the caller graph for this function:

◆ timeName() [1/2]

Foam::word timeName	(	const scalar	t,
		const int	precision = `curPrecision_`
	)

static

Return time name of given scalar time.

formatted with given precision

Definition at line 666 of file Time.C.

Referenced by fieldAverage::addMeanFieldType(), fieldAverage::addPrime2MeanFieldType(), fieldToCell::applyToSet(), patchFluxToFace::applyToSet(), writeFile::baseTimeDir(), basicCombustionMixture::basicCombustionMixture(), basicSpecieMixture::basicSpecieMixture(), cellCoBlended< Type >::blendingFactor(), curvatureSeparation::calcCosAngle(), interpolationCellPointWallModified< Type >::calcPointField(), convergenceControl::converged(), waxSolventEvaporation::correctModel(), Foam::CorrectPhi(), epsilonWallFunctionFvPatchScalarField::createAveragingWeights(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), logFiles::createFiles(), dynamicMeshPointInterpolator::curPointField(), CrankNicolsonDdtScheme< Type >::ddt0_(), fvMeshDistribute::distribute(), masterUncollatedFileOperation::findInstance(), fvMeshSubset::interpolate(), Foam::MULES::limit(), Foam::MULES::limitCorr(), LimitedScheme< Type, Limiter, LimitFunc >::limiter(), basicThermo::lookupOrConstruct(), Foam::MapConsistentVolFields(), Foam::MapLagrangianFields(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), Foam::MapVolFields(), LocalInteraction< CloudType >::massEscape(), LocalInteraction< CloudType >::massStick(), MeshedSurface< Foam::face >::MeshedSurface(), Foam::MeshToMeshMapVolFields(), Foam::min(), solidParticle::move(), RaviPetersen::operator()(), surfaceFieldValue::outputDir(), Foam::polyMeshZipUpCells(), VoidFraction< CloudType >::preEvolve(), ParticleErosion< CloudType >::preEvolve(), fvMeshDistribute::printCoupleInfo(), fvDOM::Ru(), scalarTransport::scalarTransport(), timeSelector::selectIfPresent(), masterUncollatedFileOperation::setTime(), singleStepCombustion::singleStepCombustion(), MPLIC::surfaceAlpha(), thermoSingleLayer::thermoSingleLayer(), rigidBodyMeshMotion::topoChange(), polyTopoChanger::update(), FacePostProcessing< CloudType >::write(), points0MotionSolver::write(), STARCD::write(), MeshedSurfaceProxy< Face >::write(), ParticleCollector< CloudType >::write(), refiner::write(), meshRefinement::write(), Foam::writeMeshObject(), writeFile::writeTime(), CloudFunctionObject< CloudType >::writeTimeDir(), and Foam::zeroDimensionalFvMesh().

◆ timeName() [2/2]

Foam::word timeName ( ) const

virtual

Return current time name.

Definition at line 676 of file Time.C.

References dimensioned< Type >::name().

Referenced by basicSpecieMixture::basicSpecieMixture(), Time::readDict(), Time::runTimeModifiable(), Time::timePath(), Time::writeObject(), and Time::writeTimeDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findTimes()

Foam::instantList findTimes	(	const fileName &	directory,
		const word &	constantName = `"constant"`
	)

static

Search a given directory for valid time directories.

Definition at line 36 of file findTimes.C.

References Foam::fileHandler(), and fileOperation::findTimes().

Referenced by Time::runTimeModifiable(), and USERD_set_filenames().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startTimeIndex()

Foam::label startTimeIndex ( ) const

virtual

Return start time index.

Definition at line 815 of file Time.C.

Referenced by convergenceControl::converged(), CrankNicolsonDdtScheme< Type >::ddt0_(), and Time::runTimeModifiable().

Here is the caller graph for this function:

◆ beginTime()

Foam::dimensionedScalar beginTime ( ) const

virtual

Return begin time (initial start time)

Definition at line 821 of file Time.C.

References Foam::dimTime.

Referenced by Time::runTimeModifiable().

Here is the caller graph for this function:

◆ startTime()

Foam::dimensionedScalar startTime ( ) const

virtual

Return start time.

Definition at line 827 of file Time.C.

References Foam::dimTime.

Referenced by fieldAverage::addMeanFieldType(), fieldAverage::addPrime2MeanFieldType(), CrankNicolsonDdtScheme< Type >::ddt0_(), and Time::runTimeModifiable().

Here is the caller graph for this function:

◆ endTime()

Foam::dimensionedScalar endTime ( ) const

virtual

Return end time.

Definition at line 833 of file Time.C.

References Foam::dimTime.

Referenced by Time::runTimeModifiable().

Here is the caller graph for this function:

◆ userTime()

const Foam::userTimes::userTime & userTime ( ) const

Return the userTime.

Definition at line 839 of file Time.C.

Referenced by Time::runTimeModifiable().

Here is the caller graph for this function:

◆ userTimeValue()

Foam::scalar userTimeValue ( ) const

Return current user time value.

Definition at line 845 of file Time.C.

Referenced by dynamicMeshPointInterpolator::curPointField(), displacementLinearMotionMotionSolver::curPoints(), edgeMeshFormatsCore::getLineNoComment(), surfaceFormatsCore::getLineNoComment(), Time::runTimeModifiable(), timeSelector::selectIfPresent(), constantRadiation::Shs(), engine::theta(), triSurface::triSurfInstance(), waveVelocityFvPatchVectorField::updateCoeffs(), and waveAlphaFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ userTimeToTime()

Foam::scalar userTimeToTime ( const scalar tau ) const

Convert the user-time (e.g. CA deg) to real-time (s).

Definition at line 851 of file Time.C.

Referenced by Time::readDict(), and Time::runTimeModifiable().

Here is the caller graph for this function:

◆ timeToUserTime()

Foam::scalar timeToUserTime ( const scalar t ) const

Convert the real-time (s) into user-time (e.g. CA deg)

Definition at line 857 of file Time.C.

Referenced by engine::deltaTheta(), Time::readDict(), Time::runTimeModifiable(), and Time::writeTimeDict().

Here is the caller graph for this function:

◆ userTimeName()

Foam::word userTimeName ( ) const

Return current user time name with units.

Definition at line 863 of file Time.C.

References timeName.

Referenced by Time::runTimeModifiable().

Here is the caller graph for this function:

◆ functionObjects() [1/2]

const functionObjectList& functionObjects ( ) const

inline

Return the list of function objects.

Definition at line 433 of file Time.H.

◆ restart()

bool restart ( ) const

inline

Return true if the run is a restart, i.e. startTime != beginTime.

Definition at line 439 of file Time.H.

References Time::beginTime_.

Referenced by Foam::hydrostaticInitialisation().

Here is the caller graph for this function:

◆ subCycling()

bool subCycling ( ) const

inline

Return true if time currently being sub-cycled, otherwise false.

Definition at line 445 of file Time.H.

References Time::subCycling_.

Referenced by Residuals< Type >::append(), localEulerDdt::localRDeltaT(), masterUncollatedFileOperation::setTime(), and particle::stepFractionSpan().

Here is the caller graph for this function:

◆ prevTimeState()

const TimeState& prevTimeState ( ) const

inline

Return previous TimeState if time is being sub-cycled.

Definition at line 451 of file Time.H.

References Time::end(), Time::endSubCycle(), Time::loop(), Time::prevTimeState_, Time::run(), Time::running(), Time::setDeltaT(), Time::setDeltaTNoAdjust(), Time::setEndTime(), Time::setTime(), Time::setWriteInterval(), Time::stopAt(), and Time::subCycle().

Referenced by Residuals< Type >::append(), particle::stepFractionSpan(), fvMesh::Vsc(), and fvMesh::Vsc0().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ running()

bool running ( ) const

virtual

Return true if run should continue without any side effects.

Definition at line 869 of file Time.C.

Referenced by Time::prevTimeState().

Here is the caller graph for this function:

◆ run()

bool run ( ) const

virtual

Return true if run should continue,.

also invokes the functionObjectList::end() method when the time goes out of range

Note: For correct behaviour, the following style of time-loop is recommended:
while (runTime.run())
{
runTime++;
solve;
runTime.write();
}

Definition at line 875 of file Time.C.

References Time::readModifiedObjects().

Referenced by Time::prevTimeState(), simpleControl::run(), pimpleControl::run(), pisoControl::run(), and pimpleMultiRegionControl::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loop()

bool loop ( )

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

Note: For correct behaviour, the following style of time-loop is recommended:
while (runTime.loop())
{
solve;
runTime.write();
}

Definition at line 922 of file Time.C.

Referenced by simpleControl::loop(), pimpleControl::loop(), pisoControl::loop(), pimpleMultiRegionControl::loop(), and Time::prevTimeState().

Here is the caller graph for this function:

◆ end()

bool end ( ) const

virtual

Return true if end of run,.

does not invoke any functionObject methods

Note: The rounding heuristics near endTime mean that
run()
and
!end()
may not yield the same result

Definition at line 935 of file Time.C.

Referenced by Time::prevTimeState().

Here is the caller graph for this function:

◆ stopAt()

bool stopAt ( const stopAtControl sa ) const

virtual

Adjust the current stopAtControl. Note that this value.

only persists until the next time the dictionary is read. Return true if the stopAtControl changed.

Definition at line 941 of file Time.C.

Referenced by convergenceControl::endIfConverged(), and Time::prevTimeState().

Here is the caller graph for this function:

◆ setTime() [1/4]

void setTime ( const Time & t )

virtual

Reset the time and time-index to those of the given time.

Definition at line 959 of file Time.C.

References Foam::fileHandler(), dimensioned< Type >::name(), fileOperation::setTime(), and dimensioned< Type >::value().

Referenced by Time::prevTimeState(), timeSelector::select0(), processorRunTimes::selectProc(), and processorRunTimes::setTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTime() [2/4]

void setTime	(	const instant &	inst,
		const label	newIndex
	)

virtual

Reset the time and time-index.

Definition at line 968 of file Time.C.

References Foam::fileHandler(), dictionary::found(), dictionary::lookup(), instant::name(), dimensioned< Type >::name(), IOobject::NO_WRITE, IOobject::READ_IF_PRESENT, dictionary::readIfPresent(), fileOperation::setTime(), timeName, and instant::value().

Here is the call graph for this function:

◆ setTime() [3/4]

void setTime	(	const dimensionedScalar &	newTime,
		const label	newIndex
	)

virtual

Reset the time and time-index.

Definition at line 1004 of file Time.C.

References setTime(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ setTime() [4/4]

void setTime	(	const scalar	newTime,
		const label	newIndex
	)

virtual

Reset the time and time-index.

Definition at line 1010 of file Time.C.

References Foam::fileHandler(), dimensioned< Type >::name(), fileOperation::setTime(), and timeName.

Here is the call graph for this function:

◆ setEndTime() [1/2]

void setEndTime ( const dimensionedScalar & endTime )

virtual

Reset end time.

Definition at line 1019 of file Time.C.

References dimensioned< Type >::value().

Referenced by convergenceControl::endIfConverged(), and Time::prevTimeState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEndTime() [2/2]

void setEndTime ( const scalar endTime )

virtual

Reset end time.

Definition at line 1025 of file Time.C.

◆ setDeltaT() [1/2]

void setDeltaT ( const dimensionedScalar & deltaT )

virtual

Reset time step.

Definition at line 1031 of file Time.C.

References dimensioned< Type >::value().

Referenced by Time::prevTimeState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDeltaT() [2/2]

void setDeltaT ( const scalar deltaT )

virtual

Reset time step.

Definition at line 1037 of file Time.C.

◆ setDeltaTNoAdjust()

void setDeltaTNoAdjust ( const scalar deltaT )

virtual

Reset time step without additional adjustment or modification.

by function objects

Definition at line 1048 of file Time.C.

Referenced by Time::prevTimeState().

Here is the caller graph for this function:

◆ setWriteInterval()

void setWriteInterval ( const scalar writeInterval )

virtual

Reset the write interval.

Definition at line 1055 of file Time.C.

References Foam::equal().

Referenced by Time::prevTimeState(), and Time::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subCycle()

Foam::TimeState subCycle ( const label nSubCycles )

virtual

Set time to sub-cycle for the given number of steps.

Definition at line 1083 of file Time.C.

References setTime(), and timeIndex.

Referenced by Time::prevTimeState(), and subCycleTime::subCycleTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ endSubCycle()

void endSubCycle ( )

virtual

Reset time after sub-cycling back to previous TimeState.

Definition at line 1097 of file Time.C.

Referenced by subCycleTime::endSubCycle(), and Time::prevTimeState().

Here is the caller graph for this function:

◆ functionObjects() [2/2]

functionObjectList& functionObjects ( )

inline

Return non-const access to the list of function objects.

Definition at line 551 of file Time.H.

References Time::operator++(), and Time::operator+=().

Here is the call graph for this function:

◆ operator+=() [1/2]

Foam::Time & operator+= ( const dimensionedScalar & deltaT )

virtual

Set deltaT to that specified and increment time via operator++()

Definition at line 1110 of file Time.C.

References dimensioned< Type >::value().

Referenced by Time::functionObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator+=() [2/2]

Foam::Time & operator+= ( const scalar deltaT )

virtual

Set deltaT to that specified and increment time via operator++()

Definition at line 1116 of file Time.C.

◆ operator++() [1/2]

Foam::Time & operator++ ( )

virtual

Prefix increment,.

also invokes the functionObjectList::start() or functionObjectList::execute() method, depending on the time-index

Definition at line 1123 of file Time.C.

References Foam::endl(), Foam::mag(), Foam::max(), Foam::min(), dimensioned< Type >::name(), Foam::nl, Foam::pow(), Foam::readScalar(), Foam::reduce(), Foam::returnReduce(), setTime(), Foam::sign(), timeIndex, and WarningInFunction.

Referenced by Time::functionObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator++() [2/2]

Foam::Time & operator++ ( int )

virtual

Postfix increment, this is identical to the prefix increment.

Definition at line 1339 of file Time.C.

Member Data Documentation

◆ startTimeIndex_

label startTimeIndex_

protected

Definition at line 120 of file Time.H.

◆ startTime_

scalar startTime_

protected

Definition at line 121 of file Time.H.

◆ endTime_

scalar endTime_

mutableprotected

Definition at line 122 of file Time.H.

Referenced by Time::readDict(), and Time::writeAndEnd().

◆ beginTime_

scalar beginTime_

protected

Definition at line 123 of file Time.H.

Referenced by Time::restart(), and Time::writeTimeDict().

◆ userTime_

autoPtr<userTimes::userTime> userTime_

protected

Optional user-time, defaults to realTime in s.

Definition at line 126 of file Time.H.

Referenced by Time::readDict().

◆ stopAtControlNames_

const Foam::NamedEnum< Foam::Time::stopAtControl, 4 > stopAtControlNames_

staticprotected

Definition at line 128 of file Time.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), and Time::readDict().

◆ stopAt_

stopAtControl stopAt_

mutableprotected

Definition at line 129 of file Time.H.

Referenced by Time::readDict(), and Time::writeAndEnd().

◆ writeControlNames_

const Foam::NamedEnum< Foam::Time::writeControl, 5 > writeControlNames_

staticprotected

Definition at line 131 of file Time.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), and Time::readDict().

◆ writeControl_

writeControl writeControl_

protected

Definition at line 132 of file Time.H.

Referenced by Time::readDict().

◆ writeInterval_

scalar writeInterval_

protected

Definition at line 134 of file Time.H.

Referenced by Time::readDict().

◆ purgeWrite_

label purgeWrite_

protected

Definition at line 136 of file Time.H.

Referenced by Time::readDict(), and Time::writeObject().

◆ previousWriteTimes_

FIFOStack<word> previousWriteTimes_

mutableprotected

Definition at line 137 of file Time.H.

Referenced by Time::writeObject().

◆ writeOnce_

bool writeOnce_

protected

Definition at line 140 of file Time.H.

Referenced by Time::writeOnce().

◆ subCycling_

bool subCycling_

protected

Is the time currently being sub-cycled?

Definition at line 143 of file Time.H.

Referenced by Time::subCycling().

◆ prevTimeState_

autoPtr<TimeState> prevTimeState_

protected

If time is being sub-cycled this is the previous TimeState.

Definition at line 146 of file Time.H.

Referenced by Time::prevTimeState().

◆ sigWriteNow_

sigWriteNow sigWriteNow_

protected

Enable one-shot writing upon signal.

Definition at line 151 of file Time.H.

◆ sigStopAtWriteNow_

sigStopAtWriteNow sigStopAtWriteNow_

protected

Enable write and clean exit upon signal.

Definition at line 154 of file Time.H.

◆ format_

Foam::Time::format format_

staticprotected

Time directory name format.

Definition at line 158 of file Time.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), and Time::readDict().

◆ precision_

int precision_

staticprotected

Time directory name precision.

Definition at line 161 of file Time.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), and Time::readDict().

◆ curPrecision_

int curPrecision_

staticprotected

Current time directory name precision adjusted as necessary.

to ensure time directory names are unique particularly if the time-step is reduced during the run

Definition at line 166 of file Time.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), and Time::readDict().

◆ maxPrecision_

const int maxPrecision_

staticprotected

Maximum time directory name precision.

Definition at line 169 of file Time.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), and Time::writeTimeDict().

◆ controlDictName

Foam::word controlDictName

static

The default control dictionary name (normally "controlDict")

Definition at line 207 of file Time.H.

Referenced by NamedEnum< compressibleField, 8 >::names().

The documentation for this class was generated from the following files:

src/OpenFOAM/db/Time/Time.H
src/OpenFOAM/db/Time/findTimes.C
src/OpenFOAM/db/Time/Time.C
src/OpenFOAM/db/Time/TimeIO.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ writeControl

◆ stopAtControl

◆ format

Constructor & Destructor Documentation

◆ Time() [1/4]

◆ Time() [2/4]

◆ Time() [3/4]

◆ Time() [4/4]

◆ ~Time()

Member Function Documentation

◆ adjustDeltaT()

◆ setControls()

◆ readDict()

◆ TypeName()

◆ controlDict()

◆ dbDir()

◆ timePath()

◆ writeFormat()

◆ writeVersion()

◆ writeCompression()

◆ graphFormat()

◆ runTimeModifiable()

◆ read()

◆ readModifiedObjects()

◆ findInstance()

◆ times()

◆ findInstancePath() [1/2]

◆ findInstancePath() [2/2]

◆ findClosestTime()

◆ findClosestTimeIndex()

◆ writeTimeDict()

◆ writeObject()

◆ writeNow()

◆ writeAndEnd()

◆ writeOnce()

◆ timeName() [1/2]

◆ timeName() [2/2]

◆ findTimes()

◆ startTimeIndex()

◆ beginTime()

◆ startTime()

◆ endTime()

◆ userTime()

◆ userTimeValue()

◆ userTimeToTime()

◆ timeToUserTime()

◆ userTimeName()

◆ functionObjects() [1/2]

◆ restart()

◆ subCycling()

◆ prevTimeState()

◆ running()

◆ run()

◆ loop()

◆ end()

◆ stopAt()

◆ setTime() [1/4]

◆ setTime() [2/4]

◆ setTime() [3/4]

◆ setTime() [4/4]

◆ setEndTime() [1/2]

◆ setEndTime() [2/2]

◆ setDeltaT() [1/2]

◆ setDeltaT() [2/2]

◆ setDeltaTNoAdjust()

◆ setWriteInterval()

◆ subCycle()

◆ endSubCycle()

◆ functionObjects() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]