/
cellModel.H
194 lines (134 loc) · 5.21 KB
/
cellModel.H
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
188
189
190
191
192
193
194
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-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::cellModel
Description
Maps a geometry to a set of cell primitives, which enables
geometric cell data to be calculated without access to the primitive
geometric level. This means mapping a 3D geometry to a set of
pyramids which are each described by a cell face and the cell centre
point.
SourceFiles
cellModelI.H
\*---------------------------------------------------------------------------*/
#ifndef cellModel_H
#define cellModel_H
#include "pointField.H"
#include "edgeList.H"
#include "faceList.H"
#include "InfoProxy.H"
#include "autoPtr.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class cellModel;
inline bool operator==(const cellModel&, const cellModel&);
inline bool operator!=(const cellModel&, const cellModel&);
Ostream& operator<<(Ostream&, const cellModel&);
/*---------------------------------------------------------------------------*\
Class cellModel Declaration
\*---------------------------------------------------------------------------*/
class cellModel
{
// Private data
//- Name
word name_;
//- Label in the model list
label index_;
//- Number of points in the model which determines the geometry
label nPoints_;
//- Faces of the model
faceList faces_;
//- Edges of the model
edgeList edges_;
public:
// Constructors
//- Construct from Istream
cellModel(Istream&);
//- Return a new cellModel on free-store created from Istream
static autoPtr<cellModel> New(Istream& is)
{
return autoPtr<cellModel>(new cellModel(is));
}
//- Return clone
autoPtr<cellModel> clone() const
{
return autoPtr<cellModel>(new cellModel(*this));
}
// Member functions
// Access
//- Return model name
inline const word& name() const;
//- Return index of model in the model list
inline label index() const;
//- Return number of points
inline label nPoints() const;
//- Return number of edges
inline label nEdges() const;
//- Return number of faces
inline label nFaces() const;
//- Return list of edges
inline edgeList edges(const labelList& pointLabels) const;
//- Return a raw list of model faces
inline const faceList& modelFaces() const;
//- Return list of faces
inline faceList faces(const labelList& pointLabels) const;
//- Vector centroid
vector centre
(
const labelList& pointLabels,
const pointField& points
) const;
//- Cell volume
scalar mag
(
const labelList& pointLabels,
const pointField& points
) const;
//- Return info proxy.
// Used to print token information to a stream
InfoProxy<cellModel> info() const
{
return *this;
}
//- WriteData member function required by regIOobject
bool writeData(Ostream& os) const
{
os << *this;
return os.good();
}
// Friend operators
//- Equality operator: true => ptr to models are equal !
friend bool operator==(const cellModel&, const cellModel&);
//- Inequality operator: true => ptr to models are not equal !
friend bool operator!=(const cellModel&, const cellModel&);
// Ostream operator
friend Ostream& operator<<(Ostream&, const cellModel&);
};
template<>
Ostream& operator<<(Ostream& os, const InfoProxy<cellModel>& ip);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "cellModelI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //