Public Member Functions | Static Public Member Functions | Static Public Attributes | 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]
Collaboration diagram for TimePaths:
Collaboration graph
[legend]

Public Member Functions

 TimePaths (const fileName &rootPath, const fileName &caseName)
 Construct given database name, rootPath and casePath. More...
 
 TimePaths (const bool processorCase, const fileName &rootPath, const fileName &globalCaseName, const fileName &caseName)
 Construct given database name, rootPath and casePath. More...
 
bool processorCase () const
 Return true if this is a processor case. More...
 
const fileName & rootPath () const
 Return root path. More...
 
const fileName & globalCaseName () const
 Return global case name. More...
 
const fileName & caseName () const
 Return case name. More...
 
fileName caseSystem () const
 Return system name for the case. More...
 
fileName caseConstant () const
 Return constant name for the case. More...
 
fileName globalPath () const
 Return the global path. More...
 
fileName path () const
 Return path. More...
 

Static Public Member Functions

static const word & system ()
 Return system name. More...
 
static const word & constant ()
 Return constant name. More...
 

Static Public Attributes

static const word systemName = "system"
 
static const word constantName = "constant"
 

Detailed Description

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

Source files

Definition at line 48 of file TimePaths.H.

Constructor & Destructor Documentation

◆ TimePaths() [1/2]

TimePaths ( const fileName &  rootPath,
const fileName &  caseName 
)

Construct given database name, rootPath and casePath.

Definition at line 40 of file TimePaths.C.

References TimePaths::caseName(), and Foam::pos().

Here is the call graph for this function:

◆ TimePaths() [2/2]

TimePaths ( const bool  processorCase,
const fileName &  rootPath,
const fileName &  globalCaseName,
const fileName &  caseName 
)

Construct given database name, rootPath and casePath.

Definition at line 72 of file TimePaths.C.

References TimePaths::caseName(), Foam::pos(), and TimePaths::processorCase().

Here is the call graph for this function:

Member Function Documentation

◆ processorCase()

bool processorCase ( ) const
inline

Return true if this is a processor case.

Definition at line 88 of file TimePaths.H.

Referenced by masterUncollatedFileOperation::exists(), masterUncollatedFileOperation::filePathInfo(), collatedFileOperation::objectPath(), polyMesh::polyMesh(), TimePaths::TimePaths(), and collatedFileOperation::writeObject().

Here is the caller graph for this function:

◆ rootPath()

const fileName& rootPath ( ) const
inline

Return root path.

Definition at line 94 of file TimePaths.H.

Referenced by TimePaths::globalPath(), and TimePaths::path().

Here is the caller graph for this function:

◆ globalCaseName()

const fileName& globalCaseName ( ) const
inline

Return global case name.

Definition at line 100 of file TimePaths.H.

Referenced by masterUncollatedFileOperation::filePathInfo(), searchableSurface::geometryDir(), TimePaths::globalPath(), fileOperation::processorsCasePath(), and masterUncollatedFileOperation::relativeObjectPath().

Here is the caller graph for this function:

◆ caseName()

const fileName& caseName ( ) const
inline

Return case name.

Definition at line 106 of file TimePaths.H.

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

Here is the caller graph for this function:

◆ system()

static const word& system ( )
inlinestatic

Return system name.

Definition at line 112 of file TimePaths.H.

References TimePaths::systemName.

Referenced by masterUncollatedFileOperation::filePathInfo(), and Foam::systemDictIO().

Here is the caller graph for this function:

◆ caseSystem()

Foam::fileName caseSystem ( ) const

Return system name for the case.

which for parallel runs returns ../system()

Definition at line 111 of file TimePaths.C.

References Foam::system().

Here is the call graph for this function:

◆ constant()

static const word& constant ( )
inlinestatic

Return constant name.

Definition at line 122 of file TimePaths.H.

References TimePaths::constantName.

Referenced by componentDisplacementMotionSolver::componentDisplacementMotionSolver(), triSurfaceMesh::extractCloseness(), triSurfaceMesh::extractPointCloseness(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), physicalProperties::findModelDict(), searchableSurface::geometryDir(), greyMean::greyMean(), Foam::fvm::laplacian(), meshReader::mesh(), phaseSolidThermophysicalTransportModel::New(), basicChemistryModel::New(), phaseSystem::New(), waveSuperposition::New(), laminarFlameSpeed::New(), solidThermophysicalTransportModel::New(), fvMeshDistributor::New(), fvMeshMover::New(), fvMeshTopoChanger::New(), fvMeshStitcher::New(), points0MotionSolver::points0MotionSolver(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), masterUncollatedFileOperation::read(), momentumTransportModel::readModelDict(), masterUncollatedFileOperation::readObjects(), points0MotionSolver::readPoints0(), timeSelector::select0(), masterUncollatedFileOperation::setTime(), triSurface::triSurfInstance(), meshToMesh::update(), waveSuperposition::waveSuperposition(), wideBand::wideBand(), and basicSubGrid::XiEq().

Here is the caller graph for this function:

◆ caseConstant()

Foam::fileName caseConstant ( ) const

Return constant name for the case.

which for parallel runs returns ../constant()

Definition at line 124 of file TimePaths.C.

◆ globalPath()

fileName globalPath ( ) const
inline

Return the global path.

Definition at line 132 of file TimePaths.H.

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

Referenced by Foam::meshCheck::checkGeometry(), Foam::meshCheck::checkMeshOutputDir(), CloudFunctionObject< CloudType >::CloudFunctionObject(), and Foam::systemDictIO().

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

◆ path()

fileName path ( ) const
inline

Return path.

Definition at line 138 of file TimePaths.H.

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

Here is the call graph for this function:

Member Data Documentation

◆ systemName

const word systemName = "system"
static

Definition at line 61 of file TimePaths.H.

Referenced by TimePaths::system().

◆ constantName

const word constantName = "constant"
static

Definition at line 62 of file TimePaths.H.

Referenced by TimePaths::constant(), and Time::findTimes().

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