src/finiteVolume/fvMesh/extendedStencil/faceToCell/fullStencils/faceToCellStencil.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::faceToCellStencil
  27
  28 Description
  29     baseclass for extended cell centred addressing. Contains per cell a
  30     list of neighbouring faces in global addressing.
  31
  32 SourceFiles
  33     faceToCellStencil.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef faceToCellStencil_H
  38 #define faceToCellStencil_H
  39
  40 #include "globalIndex.H"
  41 #include "boolList.H"
  42 #include "HashSet.H"
  43 #include "indirectPrimitivePatch.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 class polyMesh;
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class faceToCellStencil Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class faceToCellStencil
  57 :
  58     public labelListList
  59 {
  60     // Private data
  61
  62         const polyMesh& mesh_;
  63
  64         //- Global numbering for faces
  65         const globalIndex globalNumbering_;
  66
  67
  68     // Private Member Functions
  69
  70         //- Disallow default bitwise copy construct
  71         faceToCellStencil(const faceToCellStencil&);
  72
  73         //- Disallow default bitwise assignment
  74         void operator=(const faceToCellStencil&);
  75
  76 public:
  77
  78     // Constructors
  79
  80         //- Construct from mesh
  81         explicit faceToCellStencil(const polyMesh&);
  82
  83
  84     // Member Functions
  85
  86         const polyMesh& mesh() const
  87         {
  88             return mesh_;
  89         }
  90
  91         //- Global numbering for faces
  92         const globalIndex& globalNumbering() const
  93         {
  94             return globalNumbering_;
  95         }
  96
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //