# PhasicFlow: systemControl Class Reference

systemControl Class Reference
Inheritance diagram for systemControl:
[legend]
Collaboration diagram for systemControl:
[legend]

## Public Member Functions

| systemControl (const fileSystem path=CWD())
| systemControl (const real startTime, const real endTime, const real saveInterval, const word startTimeName, const fileSystem path=CWD())
const repository & | settings () const
repository & | settings ()
const repository & | caseSetup () const
repository & | caseSetup ()
const Time & | time () const
Time & | time ()
const repository & | geometry () const
repository & | geometry ()
const Timers & | timers () const
Timers & | timers ()
bool | timersReport () const
const dictionary & | settingsDict () const
dictionary & | settingsDict ()
virtual word | runName () const
const realx3 & | g () const
const box & | domain () const
bool | operator++ (int)
void | setSaveTimeFolder (bool saveToFile, const word &timeName="wrongTimeFolder")
size_t | outFilePrecision () const override
Public Member Functions inherited from repository
| TypeInfo ("repository")
| repository (const word &name, const fileSystem &localPath, repository *owner=nullptr)
| repository (const repository &)=delete
repository & | operator= (const repository &)=delete
virtual | ~repository ()
word | name () const
virtual fileSystem | localPath () const
virtual fileSystem | path () const
const repository * | owner () const
repository * | owner ()
const repository & | thisRepository () const
repository & | thisRepository ()
bool | addToRepository (repository *rep)
bool | removeRepository (repository *rep)
template<typename T , typename... Args>
T & | emplaceObject (const objectFile &objf, Args &&... args)
template<typename T , typename... Args>
T & | emplaceObjectOrGet (const objectFile &objf, Args &&... args)
template<typename T , typename... Args>
T & | emplaceReplaceObject (const objectFile &objf, Args &&... args)
template<typename T >
T & | insertReplaceObject (uniquePtr< IOobject > &&ptr)
template<typename T >
T & | insertReplaceObject (const objectFile &objf, uniquePtr< IOobject > &&ptr)
bool | eraseObject (const word &name)
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
template<typename T >
T & | lookupObject (const word &name)
repository & | lookupRepository (const word &name)
wordList | objectNames () const
wordList | repositoryNames () const
virtual bool | write (bool verbose=false) const
template<typename Type1 >
pFlow::word | reportTypeError (IOobject &object)

## Static Protected Member Functions

static word | getRunName (const fileSystem &path)
static word | getTopFolder (const fileSystem &path)

## Protected Attributes

const word | runName_
const fileSystem | topLevelFolder_
repository | settings_
repository | caseSetup_
dictionary & | settingsDict_
dynamicLinkLibs | libs_
size_t | outFilePrecision_ = 6
Time | Time_
bool | externalTimeControl_ = false
realx3 | g_
box | domain_
Timers | timers_
Logical | timersReport_
Timer | writeToFileTimer_
Protected Attributes inherited from repository
word | name_
fileSystem | localPath_
repository * | owner_
wordMap< IOobject > | objects_
wordMap< repository * > | repositories_

## Additional Inherited Members

Protected Member Functions inherited from repository
template<typename Type1 >
word | reportTypeError (IOobject &object)
template<typename Type >
bool | checkForObjectType (IOobject &object)

## Detailed Description

Definition at line 41 of file systemControl.hpp.

## Constructor & Destructor Documentation

## systemControl() [1/2]

systemControl | ( | const fileSystem | path = `CWD()` | ) |

Definition at line 93 of file systemControl.cpp.

## systemControl() [2/2]

systemControl | ( | const real | startTime,
|  | const real | endTime,
|  | const real | saveInterval,
|  | const word | startTimeName,
|  | const fileSystem | path = `CWD()`
| ) |  |

Definition at line 161 of file systemControl.cpp.

## Member Function Documentation

## getRunName()

pFlow::word getRunName | ( | const fileSystem & | path | ) |

staticprotected

Definition at line 30 of file systemControl.cpp.

References fileSystem::canonical(), fatalErrorInFunction, fatalExit, and fileSystem::wordPath().

Here is the call graph for this function:

## getTopFolder()

pFlow::word getTopFolder | ( | const fileSystem & | path | ) |

staticprotected

Definition at line 61 of file systemControl.cpp.

References fileSystem::canonical(), fatalErrorInFunction, fatalExit, and fileSystem::wordPath().

Here is the call graph for this function:

## settings() [1/2]

const repository& settings | ( |  | ) | const

inline

Definition at line 106 of file systemControl.hpp.

References systemControl::settings_.

## settings() [2/2]

repository& settings | ( |  | ) |

inline

Definition at line 110 of file systemControl.hpp.

References systemControl::settings_.

## caseSetup() [1/2]

const repository& caseSetup | ( |  | ) | const

inline

Definition at line 114 of file systemControl.hpp.

References systemControl::caseSetup_.

Referenced by interaction::create().

Here is the caller graph for this function:

## caseSetup() [2/2]

repository& caseSetup | ( |  | ) |

inline

Definition at line 118 of file systemControl.hpp.

References systemControl::caseSetup_.

## time() [1/2]

const Time& time | ( |  | ) | const

inline

Definition at line 123 of file systemControl.hpp.

References systemControl::Time_.

Referenced by pFlow::applySelector(), demComponent::currentTime(), and demComponent::dt().

Here is the caller graph for this function:

## time() [2/2]

Time& time | ( |  | ) |

inline

Definition at line 128 of file systemControl.hpp.

References systemControl::Time_.

## geometry() [1/2]

const repository& geometry | ( |  | ) | const

inline

Definition at line 133 of file systemControl.hpp.

References Time::geometry(), and systemControl::Time_.

Referenced by geometry::create().

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

## geometry() [2/2]

repository& geometry | ( |  | ) |

inline

Definition at line 138 of file systemControl.hpp.

References Time::geometry(), and systemControl::Time_.

Here is the call graph for this function:

## timers() [1/2]

const Timers& timers | ( |  | ) | const

inline

Definition at line 143 of file systemControl.hpp.

References systemControl::timers_.

## timers() [2/2]

Timers& timers | ( |  | ) |

inline

Definition at line 148 of file systemControl.hpp.

References systemControl::timers_.

## timersReport()

bool timersReport | ( |  | ) | const

inline

Definition at line 153 of file systemControl.hpp.

References systemControl::timersReport_.

## settingsDict() [1/2]

const dictionary& settingsDict | ( |  | ) | const

inline

Definition at line 158 of file systemControl.hpp.

References systemControl::settingsDict_.

## settingsDict() [2/2]

dictionary& settingsDict | ( |  | ) |

inline

Definition at line 162 of file systemControl.hpp.

References systemControl::settingsDict_.

## runName()

virtual word runName | ( |  | ) | const

inlinevirtual

Definition at line 166 of file systemControl.hpp.

References systemControl::runName_.

## g()

const realx3& g | ( |  | ) | const

inline

Definition at line 171 of file systemControl.hpp.

References systemControl::g_.

## domain()

const box& domain | ( |  | ) | const

inline

Definition at line 176 of file systemControl.hpp.

References systemControl::domain_.

## operator++()

bool operator++ | ( | int |  | ) |

Definition at line 235 of file systemControl.cpp.

References fatalErrorInFunction, and pFlow::output.

## setSaveTimeFolder()

void setSaveTimeFolder | ( | bool | saveToFile,
|  | const word & | timeName = `"wrongTimeFolder"`
| ) |  |

inline

Definition at line 183 of file systemControl.hpp.

References timeControl::setSaveTimeFolder(), and systemControl::Time_.

Here is the call graph for this function:

## outFilePrecision()

size_t outFilePrecision | ( |  | ) | const

inlineoverridevirtual

Reimplemented from repository.

Definition at line 190 of file systemControl.hpp.

References systemControl::outFilePrecision_.

## Member Data Documentation

## runName_

const word runName_

protected

Definition at line 48 of file systemControl.hpp.

Referenced by systemControl::runName().

## topLevelFolder_

const fileSystem topLevelFolder_

protected

Definition at line 51 of file systemControl.hpp.

## settings_

repository settings_

protected

Definition at line 56 of file systemControl.hpp.

Referenced by systemControl::settings().

## caseSetup_

repository caseSetup_

protected

Definition at line 59 of file systemControl.hpp.

Referenced by systemControl::caseSetup().

## settingsDict_

dictionary& settingsDict_

protected

Definition at line 62 of file systemControl.hpp.

Referenced by systemControl::settingsDict().

## libs_

dynamicLinkLibs libs_

protected

Definition at line 65 of file systemControl.hpp.

## outFilePrecision_

size_t outFilePrecision_ = 6

protected

Definition at line 68 of file systemControl.hpp.

Referenced by systemControl::outFilePrecision().

## Time_

Time Time_

protected

Definition at line 71 of file systemControl.hpp.

Referenced by systemControl::geometry(), systemControl::setSaveTimeFolder(), and systemControl::time().

## externalTimeControl_

bool externalTimeControl_ = false

protected

Definition at line 75 of file systemControl.hpp.

## g_

realx3 g_

protected

Definition at line 78 of file systemControl.hpp.

Referenced by systemControl::g().

## domain_

box domain_

protected

Definition at line 81 of file systemControl.hpp.

Referenced by systemControl::domain().

## timers_

Timers timers_

protected

Definition at line 84 of file systemControl.hpp.

Referenced by systemControl::timers().

## timersReport_

Logical timersReport_

protected

Definition at line 86 of file systemControl.hpp.

Referenced by systemControl::timersReport().

## writeToFileTimer_

Timer writeToFileTimer_

protected

Definition at line 88 of file systemControl.hpp.

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

- src/phasicFlow/repository/systemControl/systemControl.hpp
- src/phasicFlow/repository/systemControl/systemControl.cpp