-
Notifications
You must be signed in to change notification settings - Fork 123
/
cell.H
150 lines (101 loc) · 4.21 KB
/
cell.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
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 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::cell
Description
A cell is defined as a list of faces with extra functionality
SourceFiles
cellI.H
\*---------------------------------------------------------------------------*/
#ifndef cell_H
#define cell_H
#include "faceList.H"
#include "oppositeFace.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class cell;
bool operator==(const cell&, const cell&);
inline bool operator!=(const cell&, const cell&);
/*---------------------------------------------------------------------------*\
Class cell Declaration
\*---------------------------------------------------------------------------*/
class cell
:
public labelList
{
public:
// Static data members
static const char* const typeName;
// Constructors
//- Construct null
inline cell();
//- Construct given size
explicit inline cell(label);
//- Construct from list of labels
explicit inline cell(const labelUList&);
//- Construct by transferring the parameter contents
explicit inline cell(const Xfer<labelList>&);
//- Construct from Istream
inline cell(Istream&);
// Member Functions
//- Return number of faces
inline label nFaces() const;
//- Return labels of cell vertices
labelList labels(const faceUList&) const;
//- Return the cell vertices
pointField points(const faceUList&, const pointField&) const;
//- Return cell edges
edgeList edges(const faceUList&) const;
//- Return index of opposite face
label opposingFaceLabel
(
const label masterFaceLabel,
const faceUList& meshFaces
) const;
//- Return opposite face oriented the same way as the master face
oppositeFace opposingFace
(
const label masterFaceLabel,
const faceUList& meshFaces
) const;
// Instructions for centre and mag:
// When one wants to access the cell centre and magnitude, the
// functionality on the mesh level should be used in preference to the
// functions provided here. They do not rely to the functionality
// implemented here, provide additional checking and are more efficient.
// The cell::centre and cell::mag functions may be removed in the
// future.
//- Returns cell centre
point centre(const pointField&, const faceUList&) const;
//- Returns cell volume
scalar mag(const pointField&, const faceUList&) const;
// Friend Operators
friend bool operator==(const cell&, const cell&);
friend bool operator!=(const cell&, const cell&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "cellI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //