File size: 4,056 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::TimePaths
Description
A class for addressing time paths without using the Time class.
SourceFiles
TimePaths.C
\*---------------------------------------------------------------------------*/
#ifndef TimePaths_H
#define TimePaths_H
#include "fileName.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class TimePaths Declaration
\*---------------------------------------------------------------------------*/
class TimePaths
{
// Private Data
bool processorCase_;
const fileName rootPath_;
fileName globalCaseName_;
const fileName case_;
public:
// Static Data
static const word systemName;
static const word constantName;
// Constructors
//- Construct given database name, rootPath and casePath
TimePaths
(
const fileName& rootPath,
const fileName& caseName
);
//- Construct given database name, rootPath and casePath
TimePaths
(
const bool processorCase,
const fileName& rootPath,
const fileName& globalCaseName,
const fileName& caseName
);
// Member Functions
//- Return true if this is a processor case
bool processorCase() const
{
return processorCase_;
}
//- Return root path
const fileName& rootPath() const
{
return rootPath_;
}
//- Return global case name
const fileName& globalCaseName() const
{
return globalCaseName_;
}
//- Return case name
const fileName& caseName() const
{
return case_;
}
//- Return system name
static const word& system()
{
return systemName;
}
//- Return system name for the case
// which for parallel runs returns ../system()
fileName caseSystem() const;
//- Return constant name
static const word& constant()
{
return constantName;
}
//- Return constant name for the case
// which for parallel runs returns ../constant()
fileName caseConstant() const;
//- Return the global path
fileName globalPath() const
{
return rootPath()/globalCaseName();
}
//- Return path
fileName path() const
{
return rootPath()/caseName();
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|