Public Member Functions | List of all members
TimePaths Class Reference

A class for addressing time paths without using the Time class. More...

Inheritance diagram for TimePaths:
Inheritance graph
[legend]

Public Member Functions

 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 fileNamerootPath () const
 Return root path. More...
 
const fileNameglobalCaseName () const
 Return global case name. More...
 
const fileNamecaseName () const
 Return case name. More...
 
const wordsystem () const
 Return system name. More...
 
fileName caseSystem () const
 Return system name for the case. More...
 
const wordconstant () const
 Return constant name. More...
 
fileName caseConstant () const
 Return constant name for the case. More...
 
fileName path () const
 Return path. More...
 
fileName systemPath () const
 Return system path. More...
 
fileName constantPath () const
 Return constant path. More...
 

Detailed Description

A class for addressing time paths without using the Time class.

Source files

Definition at line 49 of file TimePaths.H.

Constructor & Destructor Documentation

TimePaths ( const fileName rootPath,
const fileName caseName,
const word systemName,
const word constantName 
)

Construct given database name, rootPath and casePath.

Definition at line 32 of file TimePaths.C.

References Foam::pos().

Here is the call graph for this function:

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.

Definition at line 68 of file TimePaths.C.

References Foam::pos().

Here is the call graph for this function:

Member Function Documentation

bool processorCase ( ) const
inline

Return true if this is a processor case.

Definition at line 90 of file TimePaths.H.

const fileName& rootPath ( ) const
inline

Return root path.

Definition at line 96 of file TimePaths.H.

Referenced by TimePaths::path(), and Time::rootPath().

Here is the caller graph for this function:

const fileName& globalCaseName ( ) const
inline

Return global case name.

Definition at line 102 of file TimePaths.H.

const fileName& caseName ( ) const
inline

Return case name.

Definition at line 108 of file TimePaths.H.

Referenced by Time::caseName(), and TimePaths::path().

Here is the caller graph for this function:

const word& system ( ) const
inline

Return system name.

Definition at line 114 of file TimePaths.H.

References TimePaths::caseSystem().

Referenced by TimePaths::caseSystem(), TimePaths::systemPath(), and meshRefinement::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::fileName caseSystem ( ) const

Return system name for the case.

which for parallel runs returns ../system()

Definition at line 110 of file TimePaths.C.

References TimePaths::system().

Referenced by TimePaths::system(), and meshRefinement::write().

Here is the call graph for this function:

Here is the caller graph for this function:

const word& constant ( ) const
inline
Foam::fileName caseConstant ( ) const

Return constant name for the case.

which for parallel runs returns ../constant()

Definition at line 123 of file TimePaths.C.

References TimePaths::constant().

Referenced by TimePaths::constant(), and meshRefinement::write().

Here is the call graph for this function:

Here is the caller graph for this function:

fileName path ( ) const
inline

Return path.

Definition at line 134 of file TimePaths.H.

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

Referenced by TimePaths::constantPath(), and TimePaths::systemPath().

Here is the call graph for this function:

Here is the caller graph for this function:

fileName systemPath ( ) const
inline

Return system path.

Definition at line 140 of file TimePaths.H.

References TimePaths::path(), and TimePaths::system().

Here is the call graph for this function:

fileName constantPath ( ) const
inline

Return constant path.

Definition at line 146 of file TimePaths.H.

References TimePaths::constant(), and TimePaths::path().

Here is the call graph for this function:


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