FreeFOAM The Cross-Platform CFD Toolkit
coupledFacePair.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::coupledFacePair
26 
27 Description
28  Data associated with a pair of coupled faces
29 
30 SourceFiles
31  coupledFacePair.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef coupledFacePair_H
36 #define coupledFacePair_H
37 
38 #include <OpenFOAM/label.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class coupledFacePair Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51  // Private data
52 
53  //- STAR couple ID
54  label coupleID_;
55 
56  //- Master cell (lower cell label)
57  label masterCellID_;
58 
59  //- Master face (lower cell label)
60  label masterFaceID_;
61 
62  //- Slave cell (higher cell label)
63  label slaveCellID_;
64 
65  //- Slave face (higher cell label)
66  label slaveFaceID_;
67 
68  //- Integral or arbitrary flag
69  bool integralMatch_;
70 
71 
72 public:
73 
74 
75  // Constructors
76 
77  //- Construct from components
79  (
80  const label coupleNo, // STAR couple ID
81  const label mC, const label mF, // master cell and face
82  const label sC, const label sF, // slave cell and face
83  const label integral
84  );
85 
86 
87  // Member Functions
88 
89  //- Return STAR couple ID
90  label coupleID() const
91  {
92  return coupleID_;
93  }
94 
95  //- Return master cell
96  label masterCell() const
97  {
98  return masterCellID_;
99  }
100 
101  //- Return master face
102  label masterFace() const
103  {
104  return masterFaceID_;
105  }
106 
107  //- Return slave cell
108  label slaveCell() const
109  {
110  return slaveCellID_;
111  }
112 
113  //- Return slave face
114  label slaveFace() const
115  {
116  return slaveFaceID_;
117  }
118 
119  //- Is this an integral match?
120  bool integralMatch() const
121  {
122  return integralMatch_;
123  }
124 
125  // IOstream Operators
126 
127  friend Ostream& operator<<(Ostream&, const coupledFacePair&);
128 };
129 
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #endif
138 
139 // ************************ vim: set sw=4 sts=4 et: ************************ //