www.cemf.ir
Time Class Reference
+ Inheritance diagram for Time:
+ Collaboration diagram for Time:

Public Member Functions

 Time (repository *owner, const dictionary &setiingsDict)
 
 Time (repository *owner, dictionary &setiingsDict, real startTime, real endTime, real saveInterval, word startTimeName)
 
fileSystem localPath () const override
 
const repositorygeometry () const
 
repositorygeometry ()
 
fileSystem integrationFolder () const
 
bool outFileBinary () const override
 Write to the file with binary format? More...
 
virtual bool write (bool verbose=false) const
 
- Public Member Functions inherited from repository
 TypeInfo ("repository")
 
 repository (const word &name, const fileSystem &localPath, repository *owner=nullptr)
 
 repository (const repository &)=delete
 
repositoryoperator= (const repository &)=delete
 
virtual ~repository ()
 
word name () const
 
virtual fileSystem path () const
 
const repositoryowner () const
 
repositoryowner ()
 
const repositorythisRepository () const
 
repositorythisRepository ()
 
bool addToRepository (repository *rep)
 add repository to this repository return false if the name already exists
More...
 
bool removeFromRepository (repository *rep)
 remove rep from the list of repositories More...
 
bool addToRepository (IOobject *io)
 add IOobject to this repository More...
 
bool removeFromRepository (IOobject *io)
 remove rep from the list of repositories More...
 
repositoryreleaseOwner (bool fromOwner=false)
 
virtual bool isIncluded (const word &objName) const
 
virtual bool isExcluded (const word &objName) const
 
bool lookupObjectName (const word &nm) const
 
word lookupObjectTypeName (const word &nm) const
 
bool globalLookupObjectName (const word &nm, bool downward=false) const
 
bool lookupRepositoryName (const word &nm) const
 
bool lookupName (const word nm) const
 
size_t numObjects () const
 
size_t numRepositories () const
 
virtual size_t outFilePrecision () const
 
template<typename T >
T & lookupObject (const word &name)
 return a ref to the underlaying data in the object More...
 
template<typename T >
const T & lookupObject (const word &name) const
 return a const ref to the underlaying data in the object More...
 
repositorylookupRepository (const word &name)
 
wordList objectNames () const
 
wordList repositoryNames () const
 
template<typename Type1 >
pFlow::word reportTypeError (IOobject &object) const
 
- Public Member Functions inherited from timeControl
 timeControl (const dictionary &dict)
 
 timeControl (dictionary &dict, real startTime, real endTime, real saveInterval, word startTimeName)
 
virtual ~timeControl ()=default
 
real dt () const
 
real setTime (real t)
 
void setStopAt (real sT)
 
real startTime () const
 
word timeName () const
 
real currentTime () const
 
word currentTimeWord (bool forSave=true) const
 
int32 currentIter () const
 
bool finalTime () const
 
bool reachedStopAt () const
 
bool outputToFile () const
 
bool timersReportTime () const
 
bool sortTime () const
 
bool setOutputToFile (real writeTime, const word &timeName)
 
bool operator++ (int)
 
void setSaveTimeFolder (bool saveToFile, const word &timeName="wrongTimeFolder")
 
int32 timePrecision () const
 
timeInfo TimeInfo () const
 

Private Member Functions

bool readDictionary (const dictionary &dict)
 

Private Attributes

bool outFormatBinary_ = false
 
repository geometry_
 

Detailed Description

Definition at line 37 of file Time.hpp.

Constructor & Destructor Documentation

◆ Time() [1/2]

Time ( repository owner,
const dictionary setiingsDict 
)

Definition at line 44 of file Time.cpp.

References fatalExit, and Time::readDictionary().

+ Here is the call graph for this function:

◆ Time() [2/2]

Time ( repository owner,
dictionary setiingsDict,
real  startTime,
real  endTime,
real  saveInterval,
word  startTimeName 
)

Definition at line 55 of file Time.cpp.

References fatalExit, and Time::readDictionary().

+ Here is the call graph for this function:

Member Function Documentation

◆ readDictionary()

bool readDictionary ( const dictionary dict)
private

Definition at line 26 of file Time.cpp.

References pFlow::endl(), fatalErrorInFunction, dictionary::getValOrSet(), iEntry::name(), Time::outFormatBinary_, and pFlow::toUpper().

Referenced by Time::Time().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ localPath()

pFlow::fileSystem localPath ( ) const
overridevirtual

Reimplemented from repository.

Definition at line 74 of file Time.cpp.

◆ geometry() [1/2]

const repository& geometry ( ) const
inline

Definition at line 68 of file Time.hpp.

References Time::geometry_.

Referenced by geometry::create(), and systemControl::geometry().

+ Here is the caller graph for this function:

◆ geometry() [2/2]

repository& geometry ( )
inline

Definition at line 73 of file Time.hpp.

References Time::geometry_.

◆ integrationFolder()

pFlow::fileSystem integrationFolder ( ) const

Definition at line 80 of file Time.cpp.

References pFlow::integrationFolder__.

◆ outFileBinary()

bool outFileBinary ( ) const
inlineoverridevirtual

Write to the file with binary format?

Reimplemented from repository.

Definition at line 81 of file Time.hpp.

References Time::outFormatBinary_.

◆ write()

bool write ( bool  verbose = false) const
virtual

Reimplemented from repository.

Definition at line 86 of file Time.cpp.

References Cyan_Text, END_REPORT, REPORT, and repository::write().

+ Here is the call graph for this function:

Member Data Documentation

◆ outFormatBinary_

bool outFormatBinary_ = false
private

Definition at line 43 of file Time.hpp.

Referenced by Time::outFileBinary(), and Time::readDictionary().

◆ geometry_

repository geometry_
private

Definition at line 46 of file Time.hpp.

Referenced by Time::geometry().


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