/
coupledFacePair.H
146 lines (102 loc) · 3.66 KB
/
coupledFacePair.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
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 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::coupledFacePair
Description
Data associated with a pair of coupled faces
SourceFiles
coupledFacePair.C
\*---------------------------------------------------------------------------*/
#ifndef coupledFacePair_H
#define coupledFacePair_H
#include "label.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class coupledFacePair;
Ostream& operator<<(Ostream&, const coupledFacePair&);
/*---------------------------------------------------------------------------*\
Class coupledFacePair Declaration
\*---------------------------------------------------------------------------*/
class coupledFacePair
{
// Private data
//- STAR couple ID
label coupleID_;
//- Master cell (lower cell label)
label masterCellID_;
//- Master face (lower cell label)
label masterFaceID_;
//- Slave cell (higher cell label)
label slaveCellID_;
//- Slave face (higher cell label)
label slaveFaceID_;
//- Integral or arbitrary flag
bool integralMatch_;
public:
// Constructors
//- Construct from components
coupledFacePair
(
const label coupleNo, // STAR couple ID
const label mC, const label mF, // master cell and face
const label sC, const label sF, // slave cell and face
const label integral
);
// Member Functions
//- Return STAR couple ID
label coupleID() const
{
return coupleID_;
}
//- Return master cell
label masterCell() const
{
return masterCellID_;
}
//- Return master face
label masterFace() const
{
return masterFaceID_;
}
//- Return slave cell
label slaveCell() const
{
return slaveCellID_;
}
//- Return slave face
label slaveFace() const
{
return slaveFaceID_;
}
//- Is this an integral match?
bool integralMatch() const
{
return integralMatch_;
}
// IOstream Operators
friend Ostream& operator<<(Ostream&, const coupledFacePair&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //