FreeFOAM The Cross-Platform CFD Toolkit
TimePaths Class Reference

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

#include <OpenFOAM/TimePaths.H>


Detailed Description

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

Source files

Definition at line 50 of file TimePaths.H.

+ Inheritance 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.

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


Member Function Documentation

bool processorCase ( ) const
inline

Return true if this is a processor case.

Definition at line 78 of file TimePaths.H.

const fileName& rootPath ( ) const
inline

Return root path.

Reimplemented in Time.

Definition at line 84 of file TimePaths.H.

Referenced by TimePaths::path().

const fileName& caseName ( ) const
inline

Return case name.

Reimplemented in Time.

Definition at line 90 of file TimePaths.H.

Referenced by TimePaths::path().

const word& system ( ) const
inline

Return system name.

Definition at line 96 of file TimePaths.H.

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

Foam::fileName caseSystem ( ) const

Return system name for the case.

which for parallel runs returns ../system()

Definition at line 48 of file TimePaths.C.

References TimePaths::system().

Referenced by meshRefinement::write().

Foam::fileName caseConstant ( ) const

Return constant name for the case.

which for parallel runs returns ../constant()

Definition at line 61 of file TimePaths.C.

Referenced by meshRefinement::write().

fileName path ( ) const
inline

Return path.

Reimplemented in Time.

Definition at line 116 of file TimePaths.H.

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

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

fileName systemPath ( ) const
inline

Return system path.

Definition at line 122 of file TimePaths.H.

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

fileName constantPath ( ) const
inline

Return constant path.

Definition at line 128 of file TimePaths.H.

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


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