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) 2011 OpenFOAM Foundation
   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::oppositeFace
  26
  27 Description
  28     Class containing opposite face for a prismatic cell with addressing
  29     and a possibility of failure.
  30
  31 SourceFiles
  32     oppositeFace.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef oppositeFace_H
  37 #define oppositeFace_H
  38
  39 #include "face.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class oppositeFace Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class oppositeFace
  51 :
  52     public face
  53 {
  54     // Private data
  55
  56         //- Master face index
  57         const label masterIndex_;
  58
  59         //- Opposite face index
  60         const label oppositeIndex_;
  61
  62
  63 public:
  64
  65     // Constructors
  66
  67         //- Construct from components
  68         oppositeFace
  69         (
  70             const face& f,
  71             const label masterIndex,
  72             const label oppositeIndex
  73         )
  74         :
  75             face(f),
  76             masterIndex_(masterIndex),
  77             oppositeIndex_(oppositeIndex)
  78
  79         {}
  80
  81
  82     // Member Functions
  83
  84         //- Master face index
  85         inline label masterIndex() const
  86         {
  87             return masterIndex_;
  88         }
  89
  90         //- Slave face index
  91         inline label oppositeIndex() const
  92         {
  93             return oppositeIndex_;
  94         }
  95
  96         //- Does the opposite face exist?
  97         inline bool found() const
  98         {
  99             return oppositeIndex_ >= 0;
 100         }
 101 };
 102
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 } // End namespace Foam
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 #endif
 111
 112 // ************************************************************************* //