faceToCellStencil.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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::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 "globalIndex.H"
40 #include "boolList.H"
41 #include "HashSet.H"
42 #include "indirectPrimitivePatch.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 public:
67 
68  // Constructors
69 
70  //- Construct from mesh
71  explicit faceToCellStencil(const polyMesh&);
72 
73 
74  // Member Functions
75 
76  const polyMesh& mesh() const
77  {
78  return mesh_;
79  }
80 
81  //- Global numbering for faces
82  const globalIndex& globalNumbering() const
83  {
84  return globalNumbering_;
85  }
86 
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace Foam
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************************************************************* //
const globalIndex & globalNumbering() const
Global numbering for faces.
baseclass for extended cell centred addressing. Contains per cell a list of neighbouring faces in glo...
Calculates a unique integer (label so might not have enough room - 2G max) for processor + local inde...
Definition: globalIndex.H:63
faceToCellStencil(const polyMesh &)
Construct from mesh.
const polyMesh & mesh() const
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.