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	writeControls { wcNone, wcTimeStep, wcRunTime, wcAdjustableRunTime, wcClockTime, wcCpuTime, wcUnknown }

enum	stopAtControls { saEndTime, saNoWriteNow, saWriteNow, saNextWrite, saUnknown }

enum	fmtflags { general = 0, fixed = ios_base::fixed, scientific = ios_base::scientific }

Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Public Types inherited from HashTable< regIOobject * >
typedef HashTable< T, Key, Hash >	this_type

typedef Key	key_type

typedef T	mapped_type

typedef T	value_type

typedef Hash	hasher

typedef T *	pointer

typedef T &	reference

typedef label	difference_type

typedef label	size_type

using	key_iterator = key_iterator_base< iterator >

using	const_key_iterator = key_iterator_base< const_iterator >

Public Types inherited from dimensioned
typedef Type	value_type

typedef pTraits< Type >::cmptType	cmptType

Public Member Functions
	TypeName ("time")

	Time (const word &ctrlDictName, const argList &args, const bool enableFunctionObjects=true, const bool enableLibs=true)

	Time (const word &ctrlDictName, const fileName &rootPath, const fileName &caseName, const bool enableFunctionObjects=true, const bool enableLibs=true)

	Time (const dictionary &dict, const fileName &rootPath, const fileName &caseName, const bool enableFunctionObjects=true, const bool enableLibs=true)

	Time (const fileName &rootPath, const fileName &caseName, const bool enableFunctionObjects=true, const bool enableLibs=true)

	Time (const word &ctrlDictName, const argList &args, const word &systemName, const word &constantName, const bool enableFunctionObjects=true, const bool enableLibs=true)

	Time (const word &ctrlDictName, const fileName &rootPath, const fileName &caseName, const word &systemName, const word &constantName, const bool enableFunctionObjects=true, const bool enableLibs=true)

	Time (const dictionary &dict, const fileName &rootPath, const fileName &caseName, const word &systemName, const word &constantName, const bool enableFunctionObjects=true, const bool enableLibs=true)

	Time (const fileName &rootPath, const fileName &caseName, const word &systemName, const word &constantName, const bool enableFunctionObjects=true, const bool enableLibs=true)

virtual	~Time ()

fileName	path () const

const dictionary &	controlDict () const

virtual const fileName &	dbDir () const

fileName	timePath () const

IOstreamOption	writeStreamOption () const

IOstream::streamFormat	writeFormat () const

IOstream::compressionType	writeCompression () const

IOstream::versionNumber	writeVersion () const

const word &	graphFormat () const

const Switch &	runTimeModifiable () const

virtual bool	read ()

void	readModifiedObjects ()

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

word	findInstancePath (const fileName &directory, const instant &t) const

word	findInstancePath (const instant &t) const

virtual bool	writeTimeDict () const

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const

bool	writeNow ()

bool	writeAndEnd ()

void	writeOnce ()

Ostream &	printExecutionTime (OSstream &os) const

virtual word	timeName () const

virtual label	startTimeIndex () const

virtual dimensionedScalar	startTime () const

virtual dimensionedScalar	endTime () const

virtual stopAtControls	stopAt () const

virtual bool	isAdjustTimeStep () const

const functionObjectList &	functionObjects () const

dlLibraryTable &	libs () const

label	subCycling () const

const TimeState &	prevTimeState () const

virtual bool	run () const

virtual bool	loop ()

virtual bool	end () const

virtual bool	stopAt (const stopAtControls stopCtrl) const

virtual void	setTime (const Time &t)

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

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

virtual void	setTime (const scalar newTime, const label newIndex)

virtual void	setEndTime (const dimensionedScalar &endTime)

virtual void	setEndTime (const scalar endTime)

virtual void	setDeltaT (const dimensionedScalar &deltaT, const bool adjust=true)

virtual void	setDeltaT (const scalar deltaT, const bool adjust=true)

virtual TimeState	subCycle (const label nSubCycles)

virtual void	subCycleIndex (const label index)

virtual void	endSubCycle ()

functionObjectList &	functionObjects ()

virtual Time &	operator+= (const dimensionedScalar &deltaT)

virtual Time &	operator+= (const scalar deltaT)

virtual Time &	operator++ ()

virtual Time &	operator++ (int)

const fileName &	rootPath () const

const fileName &	caseName () const

fileName &	caseName ()

Public Member Functions inherited from clock
	clock ()

double	elapsedClockTime () const

double	clockTimeIncrement () const

Public Member Functions inherited from cpuTimePosix
	cpuTimePosix ()

void	resetCpuTime ()

double	elapsedCpuTime () const

double	cpuTimeIncrement () const

Public Member Functions inherited from TimePaths
	TimePaths (const argList &args, const word &systemName="system", const word &constantName="constant")

	TimePaths (const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant")

	TimePaths (const bool processorCase, const fileName &rootPath, const bool distributed, const fileName &globalCaseName, const fileName &caseName, const word &systemName="system", const word &constantName="constant")

bool	distributed () const noexcept

bool	processorCase () const noexcept

bool	processorCase (const bool isProcessorCase) noexcept

const fileName &	rootPath () const

const fileName &	globalCaseName () const

const fileName &	caseName () const

fileName &	caseName ()

fileName	path () const

fileName	globalPath () const

fileName	relativePath (const fileName &input, const bool caseTag=false) const

const word &	constant () const

const word &	system () const

fileName	caseConstant () const

fileName	caseSystem () const

fileName	constantPath () const

fileName	systemPath () const

instantList	times () const

instant	findClosestTime (const scalar t) const

Public Member Functions inherited from objectRegistry
	TypeName ("objectRegistry")

	objectRegistry (const Time &db, const label nObjects=128)

	objectRegistry (const IOobject &io, const label nObjects=128)

virtual	~objectRegistry ()

const objectRegistry &	thisDb () const noexcept

const objectRegistry &	parent () const noexcept

const Time &	time () const noexcept

bool	isTimeDb () const noexcept

HashTable< wordHashSet >	classes () const

template<class MatchPredicate >
HashTable< wordHashSet >	classes (const MatchPredicate &matchName) const

label	count (const char *clsName) const

template<class MatchPredicate >
label	count (const MatchPredicate &matchClass) const

template<class MatchPredicate1 , class MatchPredicate2 >
label	count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type >
label	count (const bool strict=false) const

template<class Type , class MatchPredicate >
label	count (const MatchPredicate &matchName) const

wordList	names () const

wordList	names (const char *clsName) const

template<class MatchPredicate >
wordList	names (const MatchPredicate &matchClass) const

template<class MatchPredicate1 , class MatchPredicate2 >
wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type >
wordList	names () const

template<class Type , class MatchPredicate >
wordList	names (const MatchPredicate &matchName) const

wordList	sortedNames () const

wordList	sortedNames (const char *clsName) const

template<class MatchPredicate >
wordList	sortedNames (const MatchPredicate &matchClass) const

template<class MatchPredicate1 , class MatchPredicate2 >
wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type >
wordList	sortedNames () const

template<class Type , class MatchPredicate >
wordList	sortedNames (const MatchPredicate &matchName) const

const objectRegistry &	subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const

template<class Type >
HashTable< const Type * >	lookupClass (const bool strict=false) const

template<class Type >
HashTable< Type * >	lookupClass (const bool strict=false)

const regIOobject *	cfindIOobject (const word &name, const bool recursive=false) const

bool	found (const word &name, const bool recursive=false) const

template<class Type >
bool	foundObject (const word &name, const bool recursive=false) const

template<class Type >
const Type *	cfindObject (const word &name, const bool recursive=false) const

template<class Type >
const Type *	findObject (const word &name, const bool recursive=false) const

template<class Type >
Type *	findObject (const word &name, const bool recursive=false)

template<class Type >
Type *	getObjectPtr (const word &name, const bool recursive=false) const

template<class Type >
const Type &	lookupObject (const word &name, const bool recursive=false) const

template<class Type >
Type &	lookupObjectRef (const word &name, const bool recursive=false) const

label	getEvent () const

bool	checkIn (regIOobject *io) const

bool	checkIn (regIOobject &io) const

bool	checkOut (regIOobject *io) const

bool	checkOut (regIOobject &io) const

bool	checkOut (const word &key) const

void	clear ()

void	clearStorage ()

bool	erase (const iterator &iter)

bool	erase (const word &key)

label	erase (std::initializer_list< word > keys)

label	erase (const UList< word > &keys)

virtual void	rename (const word &newName)

virtual bool	modified () const

void	readModifiedObjects ()

virtual bool	readIfModified ()

virtual bool	writeData (Ostream &) const

template<class Type >
const Type *	lookupObjectPtr (const word &name, bool recursive=false) const

template<class Type >
Type *	lookupObjectRefPtr (const word &name, bool recursive=false) const

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 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 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 >
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")

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

virtual fileName	filePath () const

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	readData (Istream &)

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	write (const bool valid=true) const

virtual bool	global () const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Public Member Functions inherited from HashTable< regIOobject * >
	HashTable ()

	HashTable (const label size)

	HashTable (Istream &is, const label size=128)

	HashTable (const this_type &ht)

	HashTable (this_type &&rhs)

	HashTable (std::initializer_list< std::pair< Key, T >> list)

	~HashTable ()

label	capacity () const noexcept

label	size () const noexcept

bool	empty () const noexcept

T &	at (const Key &key)

const T &	at (const Key &key) const

bool	found (const Key &key) const

iterator	find (const Key &key)

const_iterator	find (const Key &key) const

const_iterator	cfind (const Key &key) const

const T &	lookup (const Key &key, const T &deflt) const

List< Key >	toc () const

List< Key >	sortedToc () const

List< Key >	sortedToc (const Compare &comp) const

Foam::List< Key >	sortedToc (const Compare &comp) const

List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const

Foam::List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert) const

List< Key >	tocValues (const UnaryPredicate &pred, const bool invert=false) const

Foam::List< Key >	tocValues (const UnaryPredicate &pred, const bool invert) const

List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const

Foam::List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert) const

label	countKeys (const UnaryPredicate &pred, const bool invert=false) const

Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const

label	countValues (const UnaryPredicate &pred, const bool invert=false) const

Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const

label	countEntries (const BinaryPredicate &pred, const bool invert=false) const

Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const

bool	emplace (const Key &key, Args &&... args)

bool	emplace_set (const Key &key, Args &&... args)

bool	insert (const Key &key, const T &obj)

bool	insert (const Key &key, T &&obj)

bool	set (const Key &key, const T &obj)

bool	set (const Key &key, T &&obj)

bool	erase (const iterator &iter)

bool	erase (const Key &key)

label	erase (const HashTable< AnyType, Key, AnyHash > &other)

label	erase (std::initializer_list< Key > keys)

label	erase (InputIter first, InputIter last)

label	erase (const FixedList< Key, N > &keys)

label	erase (const UList< Key > &keys)

Foam::label	erase (InputIter first, InputIter last)

Foam::label	erase (const FixedList< Key, N > &keys)

Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &other)

label	retain (const HashTable< AnyType, Key, AnyHash > &other)

Foam::label	retain (const HashTable< AnyType, Key, AnyHash > &other)

label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)

Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)

label	filterValues (const UnaryPredicate &pred, const bool pruning=false)

Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)

label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)

Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)

void	resize (const label sz)

void	clear ()

void	clearStorage ()

void	swap (HashTable< T, Key, Hash > &rhs)

void	transfer (HashTable< T, Key, Hash > &rhs)

T &	operator[] (const Key &key)

const T &	operator[] (const Key &key) const

T &	operator() (const Key &key)

T &	operator() (const Key &key, const T &deflt)

void	operator= (const this_type &rhs)

void	operator= (std::initializer_list< std::pair< Key, T >> rhs)

void	operator= (this_type &&rhs)

bool	operator== (const this_type &rhs) const

bool	operator!= (const this_type &rhs) const

this_type &	operator+= (const this_type &rhs)

const_iterator_pair< const_key_iterator, this_type >	keys () const

iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

iterator	end () noexcept

const_iterator	end () const noexcept

constexpr const_iterator	cend () const noexcept

Ostream &	printInfo (Ostream &os) const

Ostream &	writeKeys (Ostream &os, const label shortLen=0) const

Public Member Functions inherited from TimeState
	TimeState ()

virtual	~TimeState ()=default

virtual scalar	userTimeToTime (const scalar theta) const

virtual scalar	timeToUserTime (const scalar t) const

scalar	timeOutputValue () const

label	timeIndex () const noexcept

scalar	deltaTValue () const noexcept

scalar	deltaT0Value () const noexcept

dimensionedScalar	deltaT () const

dimensionedScalar	deltaT0 () const

bool	writeTime () const noexcept

bool	outputTime () const noexcept

Public Member Functions inherited from dimensioned
	dimensioned ()

	dimensioned (const dimensionSet &dims)

	dimensioned (const dimensionSet &dims, const Foam::zero)

	dimensioned (const dimensionSet &dims, const Foam::one)

	dimensioned (const Type &val)

	dimensioned (const dimensionSet &dims, const Type &val)

	dimensioned (const word &name, const dimensionSet &dims, const Type &val)

	dimensioned (const word &name, const dimensioned< Type > &dt)

	dimensioned (const primitiveEntry &e)

	dimensioned (const primitiveEntry &e, const dimensionSet &dims)

	dimensioned (const word &name, const dictionary &dict)

	dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict)

	dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict, const word &entryName)

	dimensioned (const word &name, const dimensionSet &dims, const Type &val, const dictionary &dict)

const word &	name () const

word &	name ()

const dimensionSet &	dimensions () const

dimensionSet &	dimensions ()

const Type &	value () const

Type &	value ()

dimensioned< cmptType >	component (const direction d) const

void	replace (const direction d, const dimensioned< cmptType > &dc)

dimensioned< Type >	T () const

bool	read (const dictionary &dict)

bool	readIfPresent (const dictionary &dict)

bool	read (const word &entryName, const dictionary &dict)

bool	readIfPresent (const word &entryName, const dictionary &dict)

Istream &	read (Istream &is, const bool readName=true)

Istream &	read (Istream &is, const dictionary &readSet)

Istream &	read (Istream &is, const HashTable< dimensionedScalar > &readSet)

void	writeEntry (const word &keyword, Ostream &os) const

dimensioned< cmptType >	operator[] (const direction d) const

void	operator+= (const dimensioned< Type > &dt)

void	operator-= (const dimensioned< Type > &dt)

void	operator*= (const scalar s)

void	operator/= (const scalar s)

	dimensioned (Istream &is)

	dimensioned (const word &name, Istream &is)

	dimensioned (const word &name, const dimensionSet &dims, Istream &is)

Static Public Member Functions
static autoPtr< Time >	New ()

static autoPtr< Time >	New (const fileName &caseDir)

static autoPtr< Time >	New (const argList &args)

static word	timeName (const scalar t, const int precision=precision_)

Static Public Member Functions inherited from clock
static time_t	getTime ()

static const struct tm	rawDate ()

static std::string	dateTime ()

static std::string	date ()

static std::string	clockTime ()

Static Public Member Functions inherited from TimePaths
static instantList	findTimes (const fileName &directory, const word &constantName="constant")

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

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &ptr)

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

template<class Type >
static Type &	store (tmp< Type > &ptr)

template<class Type >
static Type &	store (tmp< Type > &&ptr)

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

template<class StringType >
static word	groupName (StringType base, const word &group)

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Static Public Member Functions inherited from dimensioned
static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))

static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))

static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))

static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))

static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))

static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))

static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))

static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))

Static Public Attributes
static const Enum< writeControls >	writeControlNames

static const Enum< stopAtControls >	stopAtControlNames

static int	printExecutionFormat_

static word	controlDictName

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions
void	adjustDeltaT ()

void	setControls ()

void	setMonitoring (const bool forceProfiling=false)

virtual void	readDict ()

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Protected Member Functions inherited from HashTable< regIOobject * >
bool	iterator_erase (node_type *&entry, label &index)

Protected Attributes
label	startTimeIndex_

scalar	startTime_

scalar	endTime_

stopAtControls	stopAt_

writeControls	writeControl_

scalar	writeInterval_

label	purgeWrite_

FIFOStack< word >	previousWriteTimes_

label	subCycling_

bool	writeOnce_

autoPtr< TimeState >	prevTimeState_

sigWriteNow	sigWriteNow_

sigStopAtWriteNow	sigStopAtWriteNow_

Protected Attributes inherited from TimeState
label	timeIndex_

label	writeTimeIndex_

scalar	deltaT_

scalar	deltaT0_

scalar	deltaTSave_

bool	deltaTchanged_

bool	writeTime_

Static Protected Attributes
static fmtflags	format_

static int	precision_

static const int	maxPrecision_

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Additional Inherited Members
Public Attributes inherited from HashTable< regIOobject * >
const typedef T *	const_pointer

const typedef T &	const_reference

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

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

◆ writeControls

enum writeControls

Enumerator
wcNone	"none"
wcTimeStep	"timeStep"
wcRunTime	"runTime"
wcAdjustableRunTime	"adjustable" / "adjustableRunTime"
wcClockTime	"clockTime"
wcCpuTime	"cpuTime"
wcUnknown	Dummy no-op.

Definition at line 80 of file Time.H.

◆ stopAtControls

enum stopAtControls

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.

Definition at line 93 of file Time.H.

◆ fmtflags

enum fmtflags

Enumerator
general	default float notation
fixed	fixed-point notation
scientific	scientific notation

Definition at line 103 of file Time.H.

Constructor & Destructor Documentation

◆ Time() [1/8]

Time	(	const word &	ctrlDictName,
		const argList &	args,
		const bool	enableFunctionObjects = `true`,
		const bool	enableLibs = `true`
	)

inline

Definition at line 24 of file TimeI.H.

◆ Time() [2/8]

Time	(	const word &	ctrlDictName,
		const fileName &	rootPath,
		const fileName &	caseName,
		const bool	enableFunctionObjects = `true`,
		const bool	enableLibs = `true`
	)

inline

Definition at line 44 of file TimeI.H.

◆ Time() [3/8]

Time	(	const dictionary &	dict,
		const fileName &	rootPath,
		const fileName &	caseName,
		const bool	enableFunctionObjects = `true`,
		const bool	enableLibs = `true`
	)

inline

Definition at line 66 of file TimeI.H.

◆ Time() [4/8]

Time	(	const fileName &	rootPath,
		const fileName &	caseName,
		const bool	enableFunctionObjects = `true`,
		const bool	enableLibs = `true`
	)

inline

Definition at line 88 of file TimeI.H.

◆ Time() [5/8]

Time	(	const word &	ctrlDictName,
		const argList &	args,
		const word &	systemName,
		const word &	constantName,
		const bool	enableFunctionObjects = `true`,
		const bool	enableLibs = `true`
	)

Parameters

systemName	"system" directory name
constantName	"constant" directory name

Definition at line 480 of file Time.C.

References args, found, argList::found(), IOobject::MUST_READ_IF_MODIFIED, and argList::validOptions.

Here is the call graph for this function:

◆ Time() [6/8]

Time	(	const word &	ctrlDictName,
		const fileName &	rootPath,
		const fileName &	caseName,
		const word &	systemName,
		const word &	constantName,
		const bool	enableFunctionObjects = `true`,
		const bool	enableLibs = `true`
	)

Parameters

systemName	"system" directory name
constantName	"constant" directory name

Definition at line 407 of file Time.C.

References IOobject::MUST_READ_IF_MODIFIED.

◆ Time() [7/8]

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

Parameters

systemName	"system" directory name
constantName	"constant" directory name

Definition at line 566 of file Time.C.

References IOobject::MUST_READ_IF_MODIFIED.

◆ Time() [8/8]

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

Parameters

systemName	"system" directory name
constantName	"constant" directory name

Definition at line 644 of file Time.C.

◆ ~Time()

~Time ( )

virtual

Definition at line 751 of file Time.C.

References objectRegistry::clear(), Foam::fileHandler(), forAllReverse, fileOperation::removeWatch(), and profiling::stop().

Here is the call graph for this function:

Member Function Documentation

◆ adjustDeltaT()

void adjustDeltaT ( )

protected

Definition at line 92 of file Time.C.

References functionObjectList::adjustTimeStep(), TimeState::deltaT_, Foam::labelMax, Foam::max(), Foam::min(), Time::startTime_, dimensioned::value(), Time::wcAdjustableRunTime, Time::writeControl_, Time::writeInterval_, and TimeState::writeTimeIndex_.

Here is the call graph for this function:

◆ setControls()

void setControls ( )

protected

Definition at line 136 of file Time.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler(), found, IOWarningInFunction, Foam::mag(), UPstream::myProcNo(), Foam::nl, IOobject::NO_WRITE, UPstream::nProcs(), oldTime, UPstream::parRun(), path(), IOobject::READ_IF_PRESENT, dictionary::readIfPresent(), Foam::reduce(), setTime(), timeName, and WarningInFunction.

Here is the call graph for this function:

◆ setMonitoring()

void setMonitoring ( const bool forceProfiling = false )

protected

Definition at line 342 of file Time.C.

References fileOperation::addWatches(), IOobject::AUTO_WRITE, Foam::debug::controlDict(), Foam::fileHandler(), dictionary::findDict(), dictionary::getOrDefault(), profiling::initialize(), IOobject::NO_READ, and timeName.

Here is the call graph for this function:

◆ readDict()

void readDict ( )

protectedvirtual

Reimplemented in crankConRod, and engineTime.

Definition at line 83 of file TimeIO.C.

References fileOperation::addWatches(), IOstreamOption::BINARY, List::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, Foam::fileHandler(), DictionaryBase::find(), dictionary::findDict(), Time::fixed, forAllConstIters(), forAllReverse, IOstreamOption::format(), Time::format_, dictionary::found(), Time::general, dictionary::get(), fileOperation::getFile(), Foam::Info, Foam::infoDetailLevel, Foam::debug::infoObjects(), IOWarningInFunction, dictionary::merge(), baseIOdictionary::name(), dimensioned::name(), fileOperation::New(), Foam::nl, Foam::debug::optimisationObjects(), os(), Foam::Perr, Foam::Pout, OSstream::precision(), Time::precision_, Time::purgeWrite_, dictionary::readEntry(), Enum::readIfPresent(), dictionary::readIfPresent(), fileOperation::removeWatch(), Time::saEndTime, Time::scientific, Foam::Serr, Foam::setEnv(), simpleObjectRegistry::setValues(), Foam::Sout, Time::stopAt_, Time::stopAtControlNames, error::stream(), ofstreamPointer::supports_gz(), Time::timeName(), Foam::type(), IOstreamOption::UNCOMPRESSED, dimensioned::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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "time" )

◆ New() [1/3]

Foam::autoPtr< Foam::Time > New ( )

static

Definition at line 710 of file Time.C.

References autoPtr::New().

Referenced by boundaryDataWriter::write(), and boundaryDataWriter::writeTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/3]

Foam::autoPtr< Foam::Time > New ( const fileName & caseDir )

static

Definition at line 723 of file Time.C.

References fileName::name(), autoPtr::New(), and fileName::path().

Here is the call graph for this function:

◆ New() [3/3]

Foam::autoPtr< Foam::Time > New ( const argList & args )

static

Definition at line 736 of file Time.C.

References args, Time::controlDictName, and autoPtr::New().

Here is the call graph for this function:

◆ path()

fileName path ( ) const

inline

Definition at line 354 of file Time.H.

References TimePaths::caseName(), and TimePaths::rootPath().

Referenced by snappyLayerDriver::addLayers(), meshRefinement::baffleAndSplitMesh(), nearWallFields::calcAddressing(), snappySnapDriver::detectNearSurfaces(), snappySnapDriver::doSnap(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePathInfo(), Foam::getGraphPathBase(), fvMeshTools::newMesh(), snappySnapDriver::preSmoothPatch(), masterUncollatedFileOperation::readObjects(), cyclicAMIPolyPatch::resetAMI(), masterUncollatedFileOperation::setTime(), snappySnapDriver::smoothDisplacement(), Time::timePath(), triSurface::triSurface(), triSurface::triSurfInstance(), and triSurface::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ controlDict()

const dictionary& controlDict ( ) const

inline

Definition at line 360 of file Time.H.

Referenced by thermo::readControls().

Here is the caller graph for this function:

◆ dbDir()

virtual const fileName& dbDir ( ) const

inlinevirtual

Reimplemented from objectRegistry.

Definition at line 365 of file Time.H.

References fileName::null.

◆ timePath()

fileName timePath ( ) const

inline

Definition at line 371 of file Time.H.

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

Referenced by faMesh::faMesh(), averageNeighbourFvGeometryScheme::movePoints(), and molecule::writeFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeStreamOption()

IOstreamOption writeStreamOption ( ) const

inline

Definition at line 377 of file Time.H.

◆ writeFormat()

IOstream::streamFormat writeFormat ( ) const

inline

Definition at line 383 of file Time.H.

References IOstreamOption::format().

Here is the call graph for this function:

◆ writeCompression()

IOstream::compressionType writeCompression ( ) const

inline

Definition at line 389 of file Time.H.

References IOstreamOption::compression().

Here is the call graph for this function:

◆ writeVersion()

IOstream::versionNumber writeVersion ( ) const

inline

Definition at line 395 of file Time.H.

References IOstreamOption::version().

Here is the call graph for this function:

◆ graphFormat()

const word& graphFormat ( ) const

inline

Definition at line 401 of file Time.H.

◆ runTimeModifiable()

const Switch& runTimeModifiable ( ) const

inline

Definition at line 407 of file Time.H.

◆ read()

bool read ( )

virtual

Reimplemented from regIOobject.

Reimplemented in crankConRod, and engineTime.

Definition at line 435 of file TimeIO.C.

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

Referenced by engineTime::read(), and crankConRod::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readModifiedObjects()

void readModifiedObjects ( )

Definition at line 460 of file TimeIO.C.

References fileOperation::addWatches(), Foam::fileHandler(), IOobject::fileModificationChecking, IOobject::inotifyMaster, objectRegistry::modified(), UPstream::parRun(), objectRegistry::readModifiedObjects(), IOobject::timeStampMaster, and fileOperation::updateStates().

Referenced by SIMPLEControlOpt::loop(), and Time::run().

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

Definition at line 790 of file Time.C.

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

Referenced by topoSet::findIOobject(), fvMeshTools::newMesh(), points0MotionSolver::points0IO(), sensitivitySurface::smoothSensitivities(), and cellCellStencil::zoneID().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findInstancePath() [1/2]

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

Definition at line 820 of file Time.C.

References Instant< T >::equal(), forAllReverse, word::null, and path().

Referenced by uncollatedFileOperation::filePathInfo(), and uncollatedFileOperation::readObjects().

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

Definition at line 848 of file Time.C.

References path().

Here is the call graph for this function:

◆ writeTimeDict()

bool writeTimeDict ( ) const

virtual

Definition at line 506 of file TimeIO.C.

References dictionary::add(), addProfiling, IOstreamOption::ASCII, IOobject::NO_READ, IOobject::NO_WRITE, and timeName.

Here is the call graph for this function:

◆ writeObject()

bool writeObject	(	IOstreamOption	streamOpt,
		const bool	valid
	)		const

virtual

Reimplemented from objectRegistry.

Definition at line 541 of file TimeIO.C.

References Foam::fileHandler(), IOobject::path(), fileOperation::rmDir(), timeName, and objectRegistry::writeObject().

Here is the call graph for this function:

◆ writeNow()

bool writeNow ( )

Definition at line 589 of file TimeIO.C.

References Foam::vtk::write().

Referenced by runTimeControl::execute(), and SIMPLEControlSingleRun::writeNow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAndEnd()

bool writeAndEnd ( )

Definition at line 596 of file TimeIO.C.

Referenced by runTimeControl::execute(), and simpleControl::loop().

Here is the caller graph for this function:

◆ writeOnce()

void writeOnce ( )

Definition at line 605 of file TimeIO.C.

◆ printExecutionTime()

Foam::Ostream & printExecutionTime ( OSstream & os ) const

Definition at line 611 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ timeName() [1/2]

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

static

Definition at line 773 of file Time.C.

Referenced by constantAbsorptionEmission::aCont(), adjointLaminar::adjointMeanFlowSource(), adjointSensitivity::adjointMeshMovementSource(), adjointSpalartAllmaras::allocateMask(), RASModelVariables::allocateMeanFields(), fieldToCell::applyToSet(), sensitivityVolBSplinesFI::assembleSensitivities(), variablesSet::autoCreateMeshMovementField(), surfaceWriter::beginTime(), Bezier::Bezier(), cellCoBlended< Type >::blendingFactor(), Foam::calc_pTotal(), Foam::calc_rhoU(), nearWallFields::calcAddressing(), ObukhovLength::calcOL(), DarcyForchheimer::calcTransformModelData(), RASModelVariables::cloneRefPtr(), adjointSensitivity::computeGradDxDbMultiplier(), adjointEikonalSolver::computeYPhi(), contactAngleForce::correct(), cubic< Type >::correction(), waxSolventEvaporation::correctModel(), epsilonWallFunctionFvPatchScalarField::createAveragingWeights(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), logFiles::createFiles(), distanceSurface::createGeometry(), cloud::createIOField(), ATCModel::createLimiter(), Foam::createZeroFieldPtr(), filmTurbulenceModel::Cw(), faMeshDecomposition::decomposeMesh(), adjointLaminar::distanceSensitivities(), multiphaseMangrovesSource::dragCoeff(), masterUncollatedFileOperation::findInstance(), adjointLaminar::FISensitivityTerm(), fvMeshDistribute::generateTestField(), adjointRASModel::getAdjointTMVariable1Inst(), adjointRASModel::getAdjointTMVariable2Inst(), ATCUaGradU::getFISensitivityTerm(), ATCstandard::getFISensitivityTerm(), cancelATC::getFISensitivityTerm(), adjointEikonalSolver::getFISensitivityTerm(), constantHeatTransfer::h(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), isoSurfacePoint::isoSurfacePoint(), 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(), adjointRASModel::nutJacobianTMVar1(), adjointRASModel::nutJacobianTMVar2(), objectiveManager::objectiveManager(), kinematicSingleLayer::pp(), kinematicSingleLayer::pu(), variablesSet::renameTurbulenceField(), filmTurbulenceModel::rho(), timeSelector::selectIfPresent(), variablesSet::setFluxField(), incompressibleAdjointMeanFlowVars::setMeanFields(), incompressibleVars::setMeanFields(), adjointRASModel::setMeanFields(), refinementIterator::setRefinement(), masterUncollatedFileOperation::setTime(), noFilm::Sh(), noScatter::sigmaEff(), constantScatter::sigmaEff(), skewCorrected< Type >::skewCorrection(), sensitivitySurface::smoothSensitivities(), twoPhaseSystem::solve(), multiphaseSystem::solve(), RASTurbulenceModel::solveIter(), noFilm::Srho(), temperatureDependentContactAngleForce::theta(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), MPPICParcel::trackingData::updateAverages(), KinematicParcel::trackingData::updateAverages(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), laminar::Us(), coalCloudList::UTrans(), velocityDisplacementMotionSolver::velocityDisplacementMotionSolver(), reverseLinear< Type >::weights(), clippedLinear< Type >::weights(), FIREMeshWriter::write(), FacePostProcessing< CloudType >::write(), RemoveParcels< CloudType >::write(), sensitivityBezier::write(), sensitivityVolBSplines::write(), sensitivityVolBSplinesFI::write(), sensitivityBezierFI::write(), ParticleCollector< CloudType >::write(), areaWrite::write(), faMeshDecomposition::writeDecomposition(), Foam::writeMeshObject(), and triSurfaceMesh::writeObject().

◆ timeName() [2/2]

Foam::word timeName ( ) const

virtual

Definition at line 783 of file Time.C.

References dimensioned::name().

Referenced by writeFile::createFile(), Time::readDict(), faceSetOption::setArea(), cellSetOption::setVol(), Time::timePath(), and writeFile::writeCurrentTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startTimeIndex()

Foam::label startTimeIndex ( ) const

virtual

Definition at line 854 of file Time.C.

◆ startTime()

Foam::dimensionedScalar startTime ( ) const

virtual

Definition at line 860 of file Time.C.

References Foam::dimTime.

Referenced by logFiles::createFiles(), and pointHistory::pointHistory().

Here is the caller graph for this function:

◆ endTime()

Foam::dimensionedScalar endTime ( ) const

virtual

Definition at line 866 of file Time.C.

References Foam::dimTime.

Referenced by SIMPLEControlSingleRun::checkEndTime(), and SIMPLEControlSingleRun::readIters().

Here is the caller graph for this function:

◆ stopAt() [1/2]

Foam::Time::stopAtControls stopAt ( ) const

virtual

Definition at line 872 of file Time.C.

Referenced by dynamicFvMesh::New().

Here is the caller graph for this function:

◆ isAdjustTimeStep()

bool isAdjustTimeStep ( ) const

virtual

Definition at line 990 of file Time.C.

◆ functionObjects() [1/2]

const functionObjectList& functionObjects ( ) const

inline

Definition at line 495 of file Time.H.

Referenced by stateFunctionObject::stateDict().

Here is the caller graph for this function:

◆ libs()

dlLibraryTable& libs ( ) const

inline

Definition at line 501 of file Time.H.

Referenced by codedPoints0MotionSolver::libs(), codedFunctionObject::libs(), dynamicFvMesh::New(), GAMGAgglomeration::New(), and functionObject::New().

Here is the caller graph for this function:

◆ subCycling()

label subCycling ( ) const

inline

Definition at line 511 of file Time.H.

References Time::subCycling_.

Referenced by masterUncollatedFileOperation::setTime().

Here is the caller graph for this function:

◆ prevTimeState()

const TimeState& prevTimeState ( ) const

inline

Definition at line 517 of file Time.H.

References Time::prevTimeState_.

◆ run()

bool run ( ) const

virtual

Definition at line 878 of file Time.C.

References profiling::active(), addProfiling, IOobject::name(), and Time::readModifiedObjects().

Referenced by runTimeControl::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loop()

bool loop ( )

virtual

Definition at line 950 of file Time.C.

Referenced by simpleControl::loop(), and SIMPLEControlSingleRun::loop().

Here is the caller graph for this function:

◆ end()

bool end ( ) const

virtual

Definition at line 963 of file Time.C.

◆ stopAt() [2/2]

bool stopAt ( const stopAtControls stopCtrl ) const

virtual

Definition at line 969 of file Time.C.

◆ setTime() [1/4]

void setTime ( const Time & t )

virtual

Definition at line 996 of file Time.C.

References Foam::fileHandler(), dimensioned::name(), fileOperation::setTime(), TimeState::timeIndex_, and dimensioned::value().

Referenced by timeSelector::select0().

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

Definition at line 1005 of file Time.C.

References Foam::fileHandler(), Instant< T >::name(), dimensioned::name(), IOobject::NO_WRITE, IOobject::READ_IF_PRESENT, dictionary::readIfPresent(), fileOperation::setTime(), timeName, and Instant< T >::value().

Here is the call graph for this function:

◆ setTime() [3/4]

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

virtual

Definition at line 1032 of file Time.C.

References setTime(), and dimensioned::value().

Here is the call graph for this function:

◆ setTime() [4/4]

void setTime	(	const scalar	newTime,
		const label	newIndex
	)

virtual

Definition at line 1038 of file Time.C.

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

Here is the call graph for this function:

◆ setEndTime() [1/2]

void setEndTime ( const dimensionedScalar & endTime )

virtual

Definition at line 1047 of file Time.C.

References dimensioned::value().

Referenced by SIMPLEControlSingleRun::checkEndTime(), and SIMPLEControlSingleRun::readIters().

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

Definition at line 1053 of file Time.C.

◆ setDeltaT() [1/2]

void setDeltaT	(	const dimensionedScalar &	deltaT,
		const bool	adjust = `true`
	)

virtual

Definition at line 1060 of file Time.C.

References dimensioned::value().

Referenced by SIMPLEControlOpt::resetDeltaT().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDeltaT() [2/2]

void setDeltaT	(	const scalar	deltaT,
		const bool	adjust = `true`
	)

virtual

Definition at line 1069 of file Time.C.

◆ subCycle()

Foam::TimeState subCycle ( const label nSubCycles )

virtual

Definition at line 1081 of file Time.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, setTime(), and timeIndex.

Referenced by subCycleTime::subCycleTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subCycleIndex()

void subCycleIndex ( const label index )

virtual

Definition at line 1105 of file Time.C.

◆ endSubCycle()

void endSubCycle ( )

virtual

Definition at line 1118 of file Time.C.

◆ functionObjects() [2/2]

functionObjectList& functionObjects ( )

inline

Definition at line 625 of file Time.H.

◆ operator+=() [1/2]

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

virtual

Definition at line 1132 of file Time.C.

References dimensioned::value().

Here is the call graph for this function:

◆ operator+=() [2/2]

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

virtual

Definition at line 1138 of file Time.C.

◆ operator++() [1/2]

Foam::Time & operator++ ( )

virtual

Definition at line 1145 of file Time.C.

References stdFoam::end(), Foam::endl(), Foam::mag(), Foam::max(), Foam::min(), dimensioned::name(), Foam::nl, Foam::pow(), Foam::reduce(), Foam::returnReduce(), setTime(), Foam::sign(), timeIndex, and WarningInFunction.

Here is the call graph for this function:

◆ operator++() [2/2]

Foam::Time & operator++ ( int )

virtual

Definition at line 1360 of file Time.C.

◆ rootPath()

const Foam::fileName & rootPath

inline

Definition at line 43 of file TimePathsI.H.

◆ caseName() [1/2]

Foam::fileName & caseName

inline

Definition at line 55 of file TimePathsI.H.

Referenced by triSurface::triSurface(), triSurface::triSurfInstance(), and triSurface::write().

Here is the caller graph for this function:

◆ caseName() [2/2]

fileName& caseName

inline

Member Data Documentation

◆ writeControlNames

const Foam::Enum< Foam::Time::writeControls > writeControlNames

static

Definition at line 112 of file Time.H.

Referenced by Time::readDict().

◆ stopAtControlNames

const Foam::Enum< Foam::Time::stopAtControls > stopAtControlNames

static

Definition at line 115 of file Time.H.

Referenced by Foam::getStopAction(), abort::read(), and Time::readDict().

◆ printExecutionFormat_

int printExecutionFormat_

static

Definition at line 123 of file Time.H.

◆ startTimeIndex_

label startTimeIndex_

protected

Definition at line 145 of file Time.H.

◆ startTime_

scalar startTime_

protected

Definition at line 147 of file Time.H.

Referenced by Time::adjustDeltaT().

◆ endTime_

scalar endTime_

mutableprotected

Definition at line 149 of file Time.H.

Referenced by Time::readDict().

◆ stopAt_

stopAtControls stopAt_

mutableprotected

Definition at line 151 of file Time.H.

Referenced by Time::readDict().

◆ writeControl_

writeControls writeControl_

protected

Definition at line 153 of file Time.H.

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

◆ writeInterval_

scalar writeInterval_

protected

Definition at line 155 of file Time.H.

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

◆ purgeWrite_

label purgeWrite_

protected

Definition at line 157 of file Time.H.

Referenced by Time::readDict().

◆ previousWriteTimes_

FIFOStack<word> previousWriteTimes_

mutableprotected

Definition at line 159 of file Time.H.

◆ subCycling_

label subCycling_

protected

Definition at line 163 of file Time.H.

Referenced by Time::subCycling().

◆ writeOnce_

bool writeOnce_

protected

Definition at line 166 of file Time.H.

◆ prevTimeState_

autoPtr<TimeState> prevTimeState_

protected

Definition at line 169 of file Time.H.

Referenced by Time::prevTimeState().

◆ sigWriteNow_

sigWriteNow sigWriteNow_

protected

Definition at line 172 of file Time.H.

◆ sigStopAtWriteNow_

sigStopAtWriteNow sigStopAtWriteNow_

protected

Definition at line 175 of file Time.H.

◆ format_

Foam::Time::fmtflags format_

staticprotected

Definition at line 179 of file Time.H.

Referenced by Time::readDict().

◆ precision_

int precision_

staticprotected

Definition at line 182 of file Time.H.

Referenced by Time::readDict().

◆ maxPrecision_

const int maxPrecision_

staticprotected

Definition at line 185 of file Time.H.

◆ controlDictName

Foam::word controlDictName

static

Definition at line 222 of file Time.H.

Referenced by faMeshDecomposition::decomposeMesh(), Time::New(), and faMeshDecomposition::writeDecomposition().

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

src/OpenFOAM/db/Time/Time.H
src/OpenFOAM/db/Time/Time.C
src/OpenFOAM/db/Time/TimeI.H
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

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ writeControls

◆ stopAtControls

◆ fmtflags

Constructor & Destructor Documentation

◆ Time() [1/8]

◆ Time() [2/8]

◆ Time() [3/8]

◆ Time() [4/8]

◆ Time() [5/8]

◆ Time() [6/8]

◆ Time() [7/8]

◆ Time() [8/8]

◆ ~Time()

Member Function Documentation

◆ adjustDeltaT()

◆ setControls()

◆ setMonitoring()

◆ readDict()

◆ TypeName()

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ path()

◆ controlDict()

◆ dbDir()

◆ timePath()

◆ writeStreamOption()

◆ writeFormat()

◆ writeCompression()

◆ writeVersion()

◆ graphFormat()

◆ runTimeModifiable()

◆ read()

◆ readModifiedObjects()

◆ findInstance()

◆ findInstancePath() [1/2]

◆ findInstancePath() [2/2]

◆ writeTimeDict()

◆ writeObject()

◆ writeNow()

◆ writeAndEnd()

◆ writeOnce()

◆ printExecutionTime()

◆ timeName() [1/2]

◆ timeName() [2/2]

◆ startTimeIndex()

◆ startTime()

◆ endTime()

◆ stopAt() [1/2]

◆ isAdjustTimeStep()

◆ functionObjects() [1/2]

◆ libs()

◆ subCycling()

◆ prevTimeState()

◆ run()

◆ loop()

◆ end()

◆ stopAt() [2/2]

◆ setTime() [1/4]

◆ setTime() [2/4]

◆ setTime() [3/4]

◆ setTime() [4/4]

◆ setEndTime() [1/2]

◆ setEndTime() [2/2]

◆ setDeltaT() [1/2]

◆ setDeltaT() [2/2]

◆ subCycle()

◆ subCycleIndex()

◆ endSubCycle()

◆ functionObjects() [2/2]