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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 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::solverTemplate
Description
Class to store solver template specifications
\*---------------------------------------------------------------------------*/
#ifndef solverTemplate_H
#define solverTemplate_H
#include "boolList.H"
#include "wordList.H"
#include "dimensionSet.H"
#include "IOobject.H"
#include "Enum.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class Time;
/*---------------------------------------------------------------------------*\
Class solverTemplate Declaration
\*---------------------------------------------------------------------------*/
class solverTemplate
{
public:
// Public enumerations
//- Solver type
enum solverType
{
stCompressible,
stIncompressible,
stBuoyant,
stUnknown
};
//- Solver type names
static const Enum<solverType> solverTypeNames_;
private:
// Private data
//- Solver type
solverType solverType_;
//- Multi-region flag
bool multiRegion_;
// Per-region info
//- Region types
wordList regionTypes_;
//- Region names
wordList regionNames_;
//- Field names
List<wordList> fieldNames_;
//- Field types
List<wordList> fieldTypes_;
//- Field dimensions
List<PtrList<dimensionSet>> fieldDimensions_;
// Public member functions
//- Read a word from a dictionary (offers some protection...)
word readFromDict
(
IOobject& dictHeader,
const word& entryName
) const;
//- Read fluid region templates
dictionary readFluidFieldTemplates
(
const word& regionName,
const fileName& baseDir,
const dictionary& solverDict,
const Time& runTime
) const;
//- Read solid region templates
dictionary readSolidFieldTemplates
(
const word& regionName,
const dictionary& solverDict
) const;
//- Set the properties for region with index regionI
void setRegionProperties
(
const dictionary& dict,
const word& regionType,
const word& regionName,
const label regionI
);
public:
//- Constructor
solverTemplate
(
const fileName& baseDir,
const Time& runTime,
const word& regionName
);
// Public member functions
//- Solver type name
word type() const;
//- Return the multi-region flag
bool multiRegion() const;
//- Return the number of regions
label nRegion() const;
// Per-region info
//- Return the region type
const word& regionType(const label regionI) const;
//- Return the region name
const word& regionName(const label regionI) const;
//- Return the field names
const wordList& fieldNames(const label regionI) const;
//- Return the field types
const wordList& fieldTypes(const label regionI) const;
//- Return the field dimensions
const PtrList<dimensionSet>& fieldDimensions
(
const label regionI
) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|
