FreeFOAM The Cross-Platform CFD Toolkit
faceToCellStencil.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
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::faceToCellStencil
26 
27 Description
28  baseclass for extended cell centred addressing. Contains per cell a
29  list of neighbouring faces in global addressing.
30 
31 SourceFiles
32  faceToCellStencil.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef faceToCellStencil_H
37 #define faceToCellStencil_H
38 
39 #include <OpenFOAM/globalIndex.H>
40 #include <OpenFOAM/boolList.H>
41 #include <OpenFOAM/HashSet.H>
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 class polyMesh;
50 
51 /*---------------------------------------------------------------------------*\
52  Class faceToCellStencil Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public labelListList
58 {
59  // Private data
60 
61  const polyMesh& mesh_;
62 
63  //- Global numbering for faces
64  const globalIndex globalNumbering_;
65 
66 
67  // Private Member Functions
68 
69  //- Disallow default bitwise copy construct
71 
72  //- Disallow default bitwise assignment
73  void operator=(const faceToCellStencil&);
74 
75 public:
76 
77  // Constructors
78 
79  //- Construct from mesh
80  explicit faceToCellStencil(const polyMesh&);
81 
82 
83  // Member Functions
84 
85  const polyMesh& mesh() const
86  {
87  return mesh_;
88  }
89 
90  //- Global numbering for faces
92  {
93  return globalNumbering_;
94  }
95 
96  //- Work-around for C++ Standard Core Language Defect 391
97  const faceToCellStencil& by_ref() const
98  {
99  return *this;
100  }
101 
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************ vim: set sw=4 sts=4 et: ************************ //