FreeFOAM The Cross-Platform CFD Toolkit
coupledFacePair.C
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 Description
25  Data associated with a pair of coupled faces.
26  1 represents integral match; all other number are arbitrary matches
27 
28 \*---------------------------------------------------------------------------*/
29 
30 #include "coupledFacePair.H"
31 #include <OpenFOAM/error.H>
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 
38 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
39 
40 // Construct from components
42 (
43  const label coupleNo,
44  const label mC, const label mF,
45  const label sC, const label sF,
46  const label integral
47 )
48 :
49  coupleID_(coupleNo),
50  masterCellID_(mC),
51  masterFaceID_(mF),
52  slaveCellID_(sC),
53  slaveFaceID_(sF),
54  integralMatch_(integral == 1)
55 {}
56 
57 
58 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
59 
60 
61 // * * * * * * * * * * * * * * * Friend Operators * * * * * * * * * * * * * //
62 
63 Ostream& operator<<(Ostream& os, const coupledFacePair& c)
64 {
65  os << "Master cell: " << c.masterCellID_
66  << " face: " << c.masterFaceID_ << endl
67  << "Slave cell: " << c.slaveCellID_
68  << " face: " << c.slaveFaceID_ << endl
69  << "Integral: " << c.integralMatch_ << endl;
70 
71  return os;
72 }
73 
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 } // End namespace Foam
78 
79 // ************************ vim: set sw=4 sts=4 et: ************************ //