Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
db
Time
TimePaths.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
License
9
This file is part of OpenFOAM.
10
11
OpenFOAM is free software: you can redistribute it and/or modify it
12
under the terms of the GNU General Public License as published by
13
the Free Software Foundation, either version 3 of the License, or
14
(at your option) any later version.
15
16
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19
for more details.
20
21
You should have received a copy of the GNU General Public License
22
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23
24
Class
25
Foam::TimePaths
26
27
Description
28
A class for addressing time paths without using the Time class.
29
30
SourceFiles
31
TimePaths.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef TimePaths_H
36
#define TimePaths_H
37
38
#include <
OpenFOAM/fileName.H
>
39
40
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41
42
namespace
Foam
43
{
44
45
/*---------------------------------------------------------------------------*\
46
Class TimePaths Declaration
47
\*---------------------------------------------------------------------------*/
48
49
50
class
TimePaths
51
{
52
// Private data
53
54
bool
processorCase_;
55
fileName
rootPath_;
56
fileName
case_;
57
word
system_;
58
word
constant_;
59
60
61
public
:
62
63
// Constructors
64
65
//- Construct given database name, rootPath and casePath
66
TimePaths
67
(
68
const
fileName
&
rootPath
,
69
const
fileName
&
caseName
,
70
const
word
& systemName,
71
const
word
& constantName
72
);
73
74
75
// Member functions
76
77
//- Return true if this is a processor case
78
bool
processorCase
()
const
79
{
80
return
processorCase_;
81
}
82
83
//- Return root path
84
const
fileName
&
rootPath
()
const
85
{
86
return
rootPath_;
87
}
88
89
//- Return case name
90
const
fileName
&
caseName
()
const
91
{
92
return
case_;
93
}
94
95
//- Return system name
96
const
word
&
system
()
const
97
{
98
return
system_;
99
}
100
101
//- Return system name for the case
102
// which for parallel runs returns ../system()
103
fileName
caseSystem
()
const
;
104
105
//- Return constant name
106
const
word
&
constant
()
const
107
{
108
return
constant_;
109
}
110
111
//- Return constant name for the case
112
// which for parallel runs returns ../constant()
113
fileName
caseConstant
()
const
;
114
115
//- Return path
116
fileName
path
()
const
117
{
118
return
rootPath
()/
caseName
();
119
}
120
121
//- Return system path
122
fileName
systemPath
()
const
123
{
124
return
path
()/
system
();
125
}
126
127
//- Return constant path
128
fileName
constantPath
()
const
129
{
130
return
path
()/
constant
();
131
}
132
};
133
134
135
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136
137
}
// End namespace Foam
138
139
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140
141
#endif
142
143
// ************************ vim: set sw=4 sts=4 et: ************************ //