00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::coupledFacePair 00026 00027 Description 00028 Data associated with a pair of coupled faces 00029 00030 SourceFiles 00031 coupledFacePair.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef coupledFacePair_H 00036 #define coupledFacePair_H 00037 00038 #include <OpenFOAM/label.H> 00039 00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00041 00042 namespace Foam 00043 { 00044 00045 /*---------------------------------------------------------------------------*\ 00046 Class coupledFacePair Declaration 00047 \*---------------------------------------------------------------------------*/ 00048 00049 class coupledFacePair 00050 { 00051 // Private data 00052 00053 //- STAR couple ID 00054 label coupleID_; 00055 00056 //- Master cell (lower cell label) 00057 label masterCellID_; 00058 00059 //- Master face (lower cell label) 00060 label masterFaceID_; 00061 00062 //- Slave cell (higher cell label) 00063 label slaveCellID_; 00064 00065 //- Slave face (higher cell label) 00066 label slaveFaceID_; 00067 00068 //- Integral or arbitrary flag 00069 bool integralMatch_; 00070 00071 00072 public: 00073 00074 00075 // Constructors 00076 00077 //- Construct from components 00078 coupledFacePair 00079 ( 00080 const label coupleNo, // STAR couple ID 00081 const label mC, const label mF, // master cell and face 00082 const label sC, const label sF, // slave cell and face 00083 const label integral 00084 ); 00085 00086 00087 // Member Functions 00088 00089 //- Return STAR couple ID 00090 label coupleID() const 00091 { 00092 return coupleID_; 00093 } 00094 00095 //- Return master cell 00096 label masterCell() const 00097 { 00098 return masterCellID_; 00099 } 00100 00101 //- Return master face 00102 label masterFace() const 00103 { 00104 return masterFaceID_; 00105 } 00106 00107 //- Return slave cell 00108 label slaveCell() const 00109 { 00110 return slaveCellID_; 00111 } 00112 00113 //- Return slave face 00114 label slaveFace() const 00115 { 00116 return slaveFaceID_; 00117 } 00118 00119 //- Is this an integral match? 00120 bool integralMatch() const 00121 { 00122 return integralMatch_; 00123 } 00124 00125 // IOstream Operators 00126 00127 friend Ostream& operator<<(Ostream&, const coupledFacePair&); 00128 }; 00129 00130 00131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00132 00133 } // End namespace Foam 00134 00135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00136 00137 #endif 00138 00139 // ************************ vim: set sw=4 sts=4 et: ************************ //
