Public Member Functions | Private Attributes
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, 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...
 
fileName & caseName ()
 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 path () const
 Return path. More...
 
fileName systemPath () const
 Return system path. More...
 
fileName constantPath () const
 Return constant path. More...
 

Private Attributes

bool processorCase_
 
const fileName rootPath_
 
fileName globalCaseName_
 
fileName case_
 
const word system_
 
const word constant_
 

Detailed Description

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

Source files

Definition at line 49 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 90 of file TimePaths.H.

References TimePaths::processorCase_.

Referenced by extractSurface().

Here is the caller graph for this function:

◆ rootPath()

const fileName& rootPath ( ) const
inline

Return root path.

Definition at line 96 of file TimePaths.H.

References TimePaths::rootPath_.

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

Here is the caller graph for this function:

◆ globalCaseName()

const fileName& globalCaseName ( ) const
inline

Return global case name.

Definition at line 102 of file TimePaths.H.

References TimePaths::globalCaseName_.

Referenced by main(), and cyclicPeriodicAMIPolyPatch::resetAMI().

Here is the caller graph for this function:

◆ caseName() [1/2]

const fileName& caseName ( ) const
inline

Return case name.

Definition at line 108 of file TimePaths.H.

References TimePaths::case_.

Referenced by Time::caseName(), determineDecomposition(), and TimePaths::path().

Here is the caller graph for this function:

◆ caseName() [2/2]

fileName& caseName ( )
inline

Return case name.

Definition at line 114 of file TimePaths.H.

References TimePaths::case_.

◆ system()

const word& system ( ) const
inline

Return system name.

Definition at line 120 of file TimePaths.H.

References TimePaths::system_.

Referenced by TimePaths::caseSystem(), createDummyFvMeshFiles(), main(), TimePaths::systemPath(), and triSurfaceMesh::writeObject().

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::processorCase_, and TimePaths::system().

Referenced by triSurfaceMesh::writeObject().

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

References TimePaths::constant_.

Referenced by calcCurvature(), faceShading::calculate(), faceHeatShading::calculate(), polyMeshGenCells::calculateOwnersAndNeighbours(), TimePaths::constantPath(), blockMesh::createTopology(), main(), meshReader::mesh(), motionSolver::New(), engineMesh::New(), coordinateSystems::New(), dynamicFvMesh::New(), displacementMotionSolver::points0IO(), refinementFeatures::read(), polyMeshGenPoints::read(), polyMeshGenCells::read(), polyMeshGenFaces::read(), timeSelector::select0(), regionCoupledBase::surfPtr(), cyclicAMIPolyPatch::surfPtr(), mappedPatchBase::surfPtr(), triSurfaceMeshPointSet::triSurfaceMeshPointSet(), triSurface::triSurfInstance(), velocityDisplacementMotionSolver::velocityDisplacementMotionSolver(), polyMeshGen::write(), polyMeshGenPoints::write(), polyMeshGenCells::write(), polyMeshGenFaces::write(), writeCellDistance(), meshReader::writeInterfaces(), meshReader::writeMeshLabelList(), and triSurfaceMesh::writeObject().

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.

Referenced by triSurfaceMesh::writeObject().

Here is the caller graph for this function:

◆ path()

fileName path ( ) const
inline

Return path.

Definition at line 140 of file TimePaths.H.

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

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

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

◆ systemPath()

fileName systemPath ( ) const
inline

Return system path.

Definition at line 146 of file TimePaths.H.

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

Here is the call graph for this function:

◆ constantPath()

fileName constantPath ( ) const
inline

Return constant path.

Definition at line 152 of file TimePaths.H.

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

Referenced by main().

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

Field Documentation

◆ processorCase_

bool processorCase_
private

Definition at line 53 of file TimePaths.H.

Referenced by TimePaths::caseSystem(), and TimePaths::processorCase().

◆ rootPath_

const fileName rootPath_
private

Definition at line 54 of file TimePaths.H.

Referenced by TimePaths::rootPath().

◆ globalCaseName_

fileName globalCaseName_
private

Definition at line 55 of file TimePaths.H.

Referenced by TimePaths::globalCaseName().

◆ case_

fileName case_
private

Definition at line 56 of file TimePaths.H.

Referenced by TimePaths::caseName().

◆ system_

const word system_
private

Definition at line 57 of file TimePaths.H.

Referenced by TimePaths::system().

◆ constant_

const word constant_
private

Definition at line 58 of file TimePaths.H.

Referenced by TimePaths::constant().

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