Address the time paths without using the Time class. More...
Public Member Functions | |
TimePaths (const argList &args, const word &systemName="system", const word &constantName="constant") | |
Construct using characteristics given by the argList. More... | |
TimePaths (const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant") | |
Construct given database name, rootPath and casePath. More... | |
TimePaths (const bool processorCase, const fileName &rootPath, const bool distributed, const fileName &globalCaseName, const fileName &caseName, const word &systemName="system", const word &constantName="constant") | |
Construct given database name, rootPath and casePath. More... | |
bool | distributed () const noexcept |
True if case running with parallel distributed directories (ie. not NFS mounted) More... | |
bool | processorCase () const noexcept |
Return true if this is a processor case. More... | |
bool | processorCase (const bool isProcessorCase) noexcept |
Set processor case status. Return old one. More... | |
const fileName & | rootPath () const noexcept |
Return root path. More... | |
const fileName & | globalCaseName () const noexcept |
Return global case name. More... | |
const fileName & | caseName () const noexcept |
Return case name. More... | |
fileName & | caseName () noexcept |
The case name for modification (use with caution) More... | |
fileName | path () const |
Return path for the case. More... | |
fileName | globalPath () const |
Return global path for the case. More... | |
fileName | relativePath (const fileName &input, const bool caseTag=false) const |
Return the input relative to the globalPath by stripping off a leading value of the globalPath. More... | |
const word & | constant () const noexcept |
Return constant name. More... | |
const word & | system () const noexcept |
Return system name. More... | |
fileName | caseConstant () const |
Return the constant name for the case, which is ../constant() for parallel runs. More... | |
fileName | caseSystem () const |
Return the system name for the case, which is ../system() for parallel runs. More... | |
fileName | constantPath () const |
Return constant path. More... | |
fileName | systemPath () const |
Return system path. More... | |
instantList | times () const |
Search the case for valid time directories. More... | |
instant | findClosestTime (const scalar t) const |
Search the case for the time closest to the given time. More... | |
Static Public Member Functions | |
static instantList | findTimes (const fileName &directory, const word &constantName="constant") |
Search a given directory for valid time directories. More... | |
static label | findClosestTimeIndex (const instantList &timeDirs, const scalar t, const word &constantName="constant") |
Search instantList for the time index closest to the specified time. More... | |
Address the time paths without using the Time class.
Definition at line 52 of file TimePaths.H.
|
explicit |
Construct using characteristics given by the argList.
Definition at line 62 of file TimePaths.C.
TimePaths | ( | const fileName & | rootPath, |
const fileName & | caseName, | ||
const word & | systemName = "system" , |
||
const word & | constantName = "constant" |
||
) |
Construct given database name, rootPath and casePath.
Definition at line 84 of file TimePaths.C.
TimePaths | ( | const bool | processorCase, |
const fileName & | rootPath, | ||
const bool | distributed, | ||
const fileName & | globalCaseName, | ||
const fileName & | caseName, | ||
const word & | systemName = "system" , |
||
const word & | constantName = "constant" |
||
) |
Construct given database name, rootPath and casePath.
Definition at line 105 of file TimePaths.C.
|
inlinenoexcept |
True if case running with parallel distributed directories (ie. not NFS mounted)
Definition at line 23 of file TimePathsI.H.
Referenced by Time::readDict().
|
inlinenoexcept |
Return true if this is a processor case.
Definition at line 29 of file TimePathsI.H.
Referenced by cyclicAMIPolyPatch::canResetAMI(), cyclicAMIFvPatch::coupled(), and collatedFileOperation::writeObject().
|
inlinenoexcept |
Set processor case status. Return old one.
Definition at line 35 of file TimePathsI.H.
|
inlinenoexcept |
Return root path.
Definition at line 43 of file TimePathsI.H.
Referenced by Time::path().
|
inlinenoexcept |
Return global case name.
Definition at line 49 of file TimePathsI.H.
Referenced by fileOperation::processorsCasePath().
|
inlinenoexcept |
Return case name.
Definition at line 55 of file TimePathsI.H.
Referenced by Time::path().
|
inlinenoexcept |
The case name for modification (use with caution)
Definition at line 61 of file TimePathsI.H.
|
inline |
Return path for the case.
Definition at line 67 of file TimePathsI.H.
|
inline |
Return global path for the case.
Definition at line 73 of file TimePathsI.H.
Referenced by averageNeighbourFvGeometryScheme::movePoints(), objectiveManager::objectiveManager(), abort::read(), and shortestPathSet::shortestPathSet().
|
inline |
Return the input relative to the globalPath by stripping off a leading value of the globalPath.
input | the directory or filename to make case-relative |
caseTag | replace globalPath with <case> for later use with expand(), or prefix <case> if the file name was not an absolute location |
Definition at line 80 of file TimePathsI.H.
References Foam::input().
Referenced by surfaceNoise::initialise(), and PDRblock::writeBlockMeshDict().
|
inlinenoexcept |
Return constant name.
Definition at line 89 of file TimePathsI.H.
Referenced by componentDisplacementMotionSolver::componentDisplacementMotionSolver(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), meshReader::mesh(), motionSolver::New(), basicThermo::New(), laminarFlameSpeed::New(), adjointTurbulenceModel::New(), adjointRASModel::New(), motionSolver::iNew::operator()(), points0MotionSolver::points0IO(), areaWrite::read(), masterUncollatedFileOperation::readObjects(), regionProperties::regionProperties(), timeSelector::select0(), Foam::selectReadIO(), masterUncollatedFileOperation::setTime(), cyclicAMIPolyPatch::surfPtr(), mappedPatchBase::surfPtr(), triSurfaceMeshPointSet::triSurfaceMeshPointSet(), triSurface::triSurfInstance(), velocityDisplacementMotionSolver::velocityDisplacementMotionSolver(), volBSplinesBase::volBSplinesBase(), FIREMeshWriter::write(), triSurfaceTools::writeCurvature(), and triSurfaceMesh::writeObject().
|
inlinenoexcept |
Return system name.
Definition at line 95 of file TimePathsI.H.
Referenced by codedBase::codeDict(), fvMeshTools::createDummyFvMeshFiles(), optimisationManager::New(), PDRblock::writeBlockMeshDict(), and triSurfaceMesh::writeObject().
|
inline |
Return the constant name for the case, which is ../constant() for parallel runs.
Definition at line 101 of file TimePathsI.H.
Referenced by triSurfaceMesh::writeObject().
|
inline |
Return the system name for the case, which is ../system() for parallel runs.
Definition at line 112 of file TimePathsI.H.
References Foam::system().
Referenced by lumpedPointIOMovement::New(), sensitivitySurface::smoothSensitivities(), and triSurfaceMesh::writeObject().
|
inline |
Return constant path.
Definition at line 123 of file TimePathsI.H.
References path().
|
inline |
Return system path.
Definition at line 129 of file TimePathsI.H.
References path(), and Foam::system().
|
static |
Search a given directory for valid time directories.
Forwards to the current fileHandler
Definition at line 133 of file TimePaths.C.
References Foam::fileHandler.
Referenced by uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().
|
static |
Search instantList for the time index closest to the specified time.
Definition at line 149 of file TimePaths.C.
References Foam::diff(), Foam::mag(), Foam::name(), and UList< T >::size().
Referenced by if(), and timeSelector::selected().
Foam::instantList times | ( | ) | const |
Search the case for valid time directories.
Definition at line 142 of file TimePaths.C.
References path().
Referenced by fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), timeSelector::select0(), and triSurface::triSurfInstance().
Foam::instant findClosestTime | ( | const scalar | t | ) | const |
Search the case for the time closest to the given time.
Definition at line 176 of file TimePaths.C.
References Foam::diff(), UList< T >::first(), UList< T >::last(), Foam::mag(), path(), and UList< T >::size().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.