src/OpenFOAM/meshes/meshShapes/face/oppositeFace.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::oppositeFace
  27
  28 Description
  29     Class containing opposite face for a prismatic cell with addresing
  30     and a possibility of failure.
  31
  32 SourceFiles
  33     oppositeFace.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef oppositeFace_H
  38 #define oppositeFace_H
  39
  40 #include "face.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class oppositeFace Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class oppositeFace
  52 :
  53     public face
  54 {
  55     // Private data
  56
  57         //- Master face index
  58         const label masterIndex_;
  59
  60         //- Opposite face index
  61         const label oppositeIndex_;
  62
  63
  64 public:
  65
  66     // Constructors
  67
  68         //- Construct from components
  69         oppositeFace
  70         (
  71             const face& f,
  72             const label masterIndex,
  73             const label oppositeIndex
  74         )
  75         :
  76             face(f),
  77             masterIndex_(masterIndex),
  78             oppositeIndex_(oppositeIndex)
  79
  80         {}
  81
  82
  83     // Member Functions
  84
  85         //- Master face index
  86         inline label masterIndex() const
  87         {
  88             return masterIndex_;
  89         }
  90
  91         //- Slave face index
  92         inline label oppositeIndex() const
  93         {
  94             return oppositeIndex_;
  95         }
  96
  97         //- Does the opposite face exist?
  98         inline bool found() const
  99         {
 100             return oppositeIndex_ >= 0;
 101         }
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //