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 fileName & rootPath () const
 Return root path. More...
 
const fileName & globalCaseName () const
 Return global case name. More...
 
const fileName & caseName () const
 Return case name. More...
 
const word & system () const
 Return system name. More...
 
fileName caseSystem () const
 Return system name for the case. More...
 
const word & constant () const
 Return constant name. 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...
 

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,
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() [2/2]

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

◆ processorCase()

bool processorCase ( ) const
inline

Return true if this is a processor case.

Definition at line 89 of file TimePaths.H.

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

Here is the caller graph for this function:

◆ rootPath()

const fileName& rootPath ( ) const
inline

Return root path.

Definition at line 95 of file TimePaths.H.

Referenced by searchableSurface::geometryDir(), 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 101 of file TimePaths.H.

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

Here is the caller graph for this function:

◆ caseName()

const fileName& caseName ( ) const
inline

Return case name.

Definition at line 107 of file TimePaths.H.

Referenced by TimePaths::path(), triSurface::triSurface(), triSurface::triSurfInstance(), and triSurface::write().

Here is the caller graph for this function:

◆ system()

const word& system ( ) const
inline

Return system name.

Definition at line 113 of file TimePaths.H.

References TimePaths::caseSystem().

Referenced by TimePaths::caseSystem(), masterUncollatedFileOperation::filePathInfo(), Foam::systemDictIO(), and meshRefinement::write().

Here is the call graph for this function:
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 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:

◆ constant()

const word& constant ( ) const
inline

Return constant name.

Definition at line 123 of file TimePaths.H.

References TimePaths::caseConstant().

Referenced by basicSpecieMixture::basicSpecieMixture(), TimePaths::caseConstant(), componentDisplacementMotionSolver::componentDisplacementMotionSolver(), triSurfaceMesh::extractCloseness(), triSurfaceMesh::extractPointCloseness(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), searchableSurface::geometryDir(), edgeMeshFormatsCore::getLineNoComment(), surfaceFormatsCore::getLineNoComment(), greyMean::greyMean(), meshReader::mesh(), surfaceFilmModel::New(), engineMesh::New(), laminarFlameSpeed::New(), twoPhaseChangeModel::New(), SRFModel::New(), thermalBaffleModel::New(), radiationModel::New(), waveSuperposition::New(), basicThermo::New(), polyMesh::points0IO(), points0MotionSolver::points0MotionSolver(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), masterUncollatedFileOperation::read(), momentumTransportModel::readModelDict(), masterUncollatedFileOperation::readObjects(), timeSelector::select0(), masterUncollatedFileOperation::setTime(), regionCoupledBase::surfPtr(), mappedPatchBase::surfPtr(), triSurface::triSurfInstance(), meshReader::warnDuplicates(), wideBand::wideBand(), STARCD::write(), and meshRefinement::write().

Here is the call graph for this function:
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 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:

◆ globalPath()

fileName globalPath ( ) const
inline

Return the global path.

Definition at line 133 of file TimePaths.H.

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

Referenced by writeFile::baseFileDir(), Foam::systemDictIO(), and streamlines::write().

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 139 of file TimePaths.H.

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

Referenced by snappyLayerDriver::addLayers(), meshRefinement::baffleAndSplitMesh(), meshRefinement::createZoneBaffles(), snappySnapDriver::detectNearSurfaces(), snappySnapDriver::doSnap(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePathInfo(), edgeMeshFormatsCore::getLineNoComment(), surfaceFormatsCore::getLineNoComment(), meshRefinement::mergeBaffles(), listPlusEqOp< T >::operator()(), snappySnapDriver::preSmoothPatch(), masterUncollatedFileOperation::read(), masterUncollatedFileOperation::readObjects(), polyMesh::removeFiles(), cyclicAMIPolyPatch::resetAMI(), Time::runTimeModifiable(), duplicatePoints::setRefinement(), masterUncollatedFileOperation::setTime(), snappySnapDriver::smoothDisplacement(), snappyRefineDriver::snappyRefineDriver(), Time::timePath(), triSurface::triSurface(), triSurface::triSurfInstance(), triSurface::write(), Foam::writeCellGraph(), and meshRefinement::zonify().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: