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::oppositeFace 00026 00027 Description 00028 Class containing opposite face for a prismatic cell with addresing 00029 and a possibility of failure. 00030 00031 SourceFiles 00032 oppositeFace.C 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef oppositeFace_H 00037 #define oppositeFace_H 00038 00039 #include <OpenFOAM/face.H> 00040 00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00042 00043 namespace Foam 00044 { 00045 00046 /*---------------------------------------------------------------------------*\ 00047 Class oppositeFace Declaration 00048 \*---------------------------------------------------------------------------*/ 00049 00050 class oppositeFace 00051 : 00052 public face 00053 { 00054 // Private data 00055 00056 //- Master face index 00057 const label masterIndex_; 00058 00059 //- Opposite face index 00060 const label oppositeIndex_; 00061 00062 00063 public: 00064 00065 // Constructors 00066 00067 //- Construct from components 00068 oppositeFace 00069 ( 00070 const face& f, 00071 const label masterIndex, 00072 const label oppositeIndex 00073 ) 00074 : 00075 face(f), 00076 masterIndex_(masterIndex), 00077 oppositeIndex_(oppositeIndex) 00078 00079 {} 00080 00081 00082 // Member Functions 00083 00084 //- Master face index 00085 inline label masterIndex() const 00086 { 00087 return masterIndex_; 00088 } 00089 00090 //- Slave face index 00091 inline label oppositeIndex() const 00092 { 00093 return oppositeIndex_; 00094 } 00095 00096 //- Does the opposite face exist? 00097 inline bool found() const 00098 { 00099 return oppositeIndex_ >= 0; 00100 } 00101 }; 00102 00103 00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00105 00106 } // End namespace Foam 00107 00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00109 00110 #endif 00111 00112 // ************************ vim: set sw=4 sts=4 et: ************************ //
