Public Member Functions | Static Public Member Functions | List of all members
TimePaths Class Reference

Address the time paths without using the Time class. More...

Inheritance diagram for TimePaths:
Inheritance graph
[legend]

Public Member Functions

 TimePaths (const argList &args, const word &systemName="system", const word &constantName="constant")
 
 TimePaths (const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant")
 
 TimePaths (const bool processorCase, const fileName &rootPath, const bool distributed, const fileName &globalCaseName, const fileName &caseName, const word &systemName="system", const word &constantName="constant")
 
bool distributed () const noexcept
 
bool processorCase () const noexcept
 
bool processorCase (const bool isProcessorCase) noexcept
 
const fileName & rootPath () const
 
const fileName & globalCaseName () const
 
const fileName & caseName () const
 
fileName & caseName ()
 
fileName path () const
 
fileName globalPath () const
 
fileName relativePath (const fileName &input, const bool caseTag=false) const
 
const word & constant () const
 
const word & system () const
 
fileName caseConstant () const
 
fileName caseSystem () const
 
fileName constantPath () const
 
fileName systemPath () const
 
instantList times () const
 
instant findClosestTime (const scalar t) const
 

Static Public Member Functions

static instantList findTimes (const fileName &directory, const word &constantName="constant")
 
static label findClosestTimeIndex (const instantList &timeDirs, const scalar t, const word &constantName="constant")
 

Detailed Description

Address the time paths without using the Time class.

Source files

Definition at line 52 of file TimePaths.H.

Constructor & Destructor Documentation

◆ TimePaths() [1/3]

TimePaths ( const argList &  args,
const word &  systemName = "system",
const word &  constantName = "constant" 
)
explicit

Definition at line 62 of file TimePaths.C.

◆ TimePaths() [2/3]

TimePaths ( const fileName &  rootPath,
const fileName &  caseName,
const word &  systemName = "system",
const word &  constantName = "constant" 
)

Definition at line 84 of file TimePaths.C.

◆ TimePaths() [3/3]

TimePaths ( const bool  processorCase,
const fileName &  rootPath,
const bool  distributed,
const fileName &  globalCaseName,
const fileName &  caseName,
const word &  systemName = "system",
const word &  constantName = "constant" 
)

Definition at line 105 of file TimePaths.C.

Member Function Documentation

◆ distributed()

bool distributed ( ) const
inlinenoexcept

Definition at line 23 of file TimePathsI.H.

Referenced by Time::readDict().

Here is the caller graph for this function:

◆ processorCase() [1/2]

bool processorCase ( ) const
inlinenoexcept

Definition at line 29 of file TimePathsI.H.

Referenced by cyclicAMIPolyPatch::canResetAMI(), cyclicAMIFvPatch::coupled(), masterUncollatedFileOperation::exists(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), collatedFileOperation::objectPath(), and collatedFileOperation::writeObject().

Here is the caller graph for this function:

◆ processorCase() [2/2]

bool processorCase ( const bool  isProcessorCase)
inlinenoexcept

Definition at line 35 of file TimePathsI.H.

◆ rootPath()

const Foam::fileName & rootPath ( ) const
inline

Definition at line 43 of file TimePathsI.H.

Referenced by Time::path().

Here is the caller graph for this function:

◆ globalCaseName()

const Foam::fileName & globalCaseName ( ) const
inline

Definition at line 49 of file TimePathsI.H.

Referenced by uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::localObjectPath(), and fileOperation::processorsCasePath().

Here is the caller graph for this function:

◆ caseName() [1/2]

Foam::fileName & caseName ( ) const
inline

Definition at line 55 of file TimePathsI.H.

Referenced by Time::path().

Here is the caller graph for this function:

◆ caseName() [2/2]

fileName& caseName ( )
inline

◆ path()

Foam::fileName path ( ) const
inline

Definition at line 67 of file TimePathsI.H.

◆ globalPath()

Foam::fileName globalPath ( ) const
inline

Definition at line 73 of file TimePathsI.H.

Referenced by CloudFunctionObject< CloudType >::CloudFunctionObject(), meshRefinement::findRegions(), averageNeighbourFvGeometryScheme::movePoints(), objectiveManager::objectiveManager(), abort::read(), and shortestPathSet::shortestPathSet().

Here is the caller graph for this function:

◆ relativePath()

Foam::fileName relativePath ( const fileName &  input,
const bool  caseTag = false 
) const
inline

Definition at line 80 of file TimePathsI.H.

References Foam::input().

Referenced by PDRblock::writeBlockMeshDict().

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

◆ constant()

const Foam::word & constant ( ) const
inline

Definition at line 89 of file TimePathsI.H.

Referenced by timeVaryingMappedFixedValuePointPatchField< Type >::checkTable(), componentDisplacementMotionSolver::componentDisplacementMotionSolver(), masterUncollatedFileOperation::filePath(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), meshReader::mesh(), simplifiedDynamicFvMeshBase::New(), motionSolver::New(), engineMesh::New(), basicThermo::New(), coordinateSystems::New(), dynamicFvMesh::New(), motionSolver::iNew::operator()(), points0MotionSolver::points0IO(), 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().

Here is the caller graph for this function:

◆ system()

const Foam::word & system ( ) const
inline

Definition at line 95 of file TimePathsI.H.

Referenced by codedBase::codeDict(), fvMeshTools::createDummyFvMeshFiles(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), optimisationManager::New(), PDRblock::writeBlockMeshDict(), and triSurfaceMesh::writeObject().

Here is the caller graph for this function:

◆ caseConstant()

Foam::fileName caseConstant ( ) const
inline

Definition at line 101 of file TimePathsI.H.

Referenced by timeVaryingMappedFixedValuePointPatchField< Type >::checkTable(), and triSurfaceMesh::writeObject().

Here is the caller graph for this function:

◆ caseSystem()

Foam::fileName caseSystem ( ) const
inline

Definition at line 112 of file TimePathsI.H.

References Foam::system().

Referenced by lumpedPointIOMovement::New(), sensitivitySurface::smoothSensitivities(), and triSurfaceMesh::writeObject().

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

◆ constantPath()

Foam::fileName constantPath ( ) const
inline

Definition at line 123 of file TimePathsI.H.

References path().

Here is the call graph for this function:

◆ systemPath()

Foam::fileName systemPath ( ) const
inline

Definition at line 129 of file TimePathsI.H.

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

Here is the call graph for this function:

◆ findTimes()

Foam::instantList findTimes ( const fileName &  directory,
const word &  constantName = "constant" 
)
static

Definition at line 133 of file TimePaths.C.

References Foam::fileHandler(), and fileOperation::findTimes().

Referenced by uniformInterpolatedDisplacementPointPatchVectorField::uniformInterpolatedDisplacementPointPatchVectorField().

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

◆ findClosestTimeIndex()

Foam::label findClosestTimeIndex ( const instantList &  timeDirs,
const scalar  t,
const word &  constantName = "constant" 
)
static

Definition at line 149 of file TimePaths.C.

References Foam::diff(), Foam::mag(), and Foam::name().

Referenced by if(), and timeSelector::selected().

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

◆ times()

Foam::instantList times ( ) const

Definition at line 142 of file TimePaths.C.

References path().

Referenced by fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), timeSelector::select0(), and triSurface::triSurfInstance().

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

◆ findClosestTime()

Foam::instant findClosestTime ( const scalar  t) const

Definition at line 176 of file TimePaths.C.

References Foam::diff(), Foam::mag(), and path().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17