OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

TimePaths Class Reference

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

Inheritance diagram for TimePaths:
Collaboration diagram for TimePaths:

List of all members.


Public Member Functions

 TimePaths (const fileName &rootPath, const fileName &caseName, const word &systemName, const word &constantName)
 Construct given database name, rootPath and casePath.
bool processorCase () const
 Return true if this is a processor case.
const fileNamerootPath () const
 Return root path.
const fileNamecaseName () const
 Return case name.
const wordsystem () const
 Return system name.
fileName caseSystem () const
 Return system name for the case.
const wordconstant () const
 Return constant name.
fileName caseConstant () const
 Return constant name for the case.
fileName path () const
 Return path.
fileName systemPath () const
 Return system path.
fileName constantPath () const
 Return constant path.

Detailed Description

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

Source files

Definition at line 45 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 23 of file TimePaths.C.


Member Function Documentation

bool processorCase (  )  const [inline]

Return true if this is a processor case.

Definition at line 73 of file TimePaths.H.

const fileName& rootPath (  )  const [inline]

Return root path.

Reimplemented in Time.

Definition at line 79 of file TimePaths.H.

Referenced by TimePaths::path().

Here is the caller graph for this function:

const fileName& caseName (  )  const [inline]

Return case name.

Reimplemented in Time.

Definition at line 85 of file TimePaths.H.

Referenced by TimePaths::path().

Here is the caller graph for this function:

const word& system (  )  const [inline]

Return system name.

Definition at line 91 of file TimePaths.H.

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

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 40 of file TimePaths.C.

Foam::fileName caseConstant (  )  const

Return constant name for the case.

which for parallel runs returns ../constant()

Definition at line 53 of file TimePaths.C.

fileName path (  )  const [inline]

Return path.

Reimplemented in Time.

Definition at line 115 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 121 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 127 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:
Copyright © 2000-2009 OpenCFD Ltd