cellToFaceStencil.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-2019 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::cellToFaceStencil
26 
27 Description
28  Base class for extended cell-to-face stencils (face values from
29  neighbouring cells)
30 
31 SourceFiles
32  faceStencil.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef cellToFaceStencil_H
37 #define cellToFaceStencil_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 cellToFaceStencil Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public labelListList
58 {
59  // Private Data
60 
61  const polyMesh& mesh_;
62 
63  //- Global numbering for cells and boundary faces
64  const globalIndex globalNumbering_;
65 
66 
67 protected:
68 
69  //- Merge two lists.
70  // Guarantee global0, global1 are first.
71  static void merge
72  (
73  const label global0,
74  const label global1,
75  const labelList& listA,
76  labelList& listB
77  );
78 
79  //- Merge two lists and guarantee globalI is first.
80  static void merge
81  (
82  const label globalI,
83  const labelList& pGlobals,
84  labelList& cCells
85  );
86 
87  //- Valid boundary faces (not empty and not coupled)
88  void validBoundaryFaces(boolList& isValidBFace) const;
89 
90  //- Return patch of all coupled faces.
92 
93  //- Combine operator for labelLists
94  class unionEqOp
95  {
96  public:
97  void operator()( labelList& x, const labelList& y ) const;
98  };
99 
100  //- Collect cell neighbours of faces in global numbering
101  void insertFaceCells
102  (
103  const label exclude0,
104  const label exclude1,
105  const boolList& nonEmptyFace,
106  const labelList& faceLabels,
107  labelHashSet& globals
108  ) const;
109 
110  //- Collect cell neighbours of faces in global numbering
112  (
113  const boolList& nonEmptyFace,
114  const labelList& faceLabels,
115  labelHashSet& globals
116  ) const;
117 
118 
119  //- Collect cell neighbours into extended stencil
120  void calcFaceStencil
121  (
122  const labelListList& globalCellCells,
123  labelListList& faceStencil
124  ) const;
125 
126 
127 public:
128 
129  // Constructors
130 
131  //- Construct from mesh
132  explicit cellToFaceStencil(const polyMesh&);
133 
134 
135  // Member Functions
137  const polyMesh& mesh() const
138  {
139  return mesh_;
140  }
141 
142  //- Global numbering for cells and boundary faces
143  const globalIndex& globalNumbering() const
144  {
145  return globalNumbering_;
146  }
147 
148 };
149 
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 } // End namespace Foam
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #endif
158 
159 // ************************************************************************* //
cellToFaceStencil(const polyMesh &)
Construct from mesh.
void insertFaceCells(const label exclude0, const label exclude1, const boolList &nonEmptyFace, const labelList &faceLabels, labelHashSet &globals) const
Collect cell neighbours of faces in global numbering.
Combine operator for labelLists.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
void operator()(labelList &x, const labelList &y) const
Base class for extended cell-to-face stencils (face values from neighbouring cells) ...
const globalIndex & globalNumbering() const
Global numbering for cells and boundary faces.
scalar y
Calculates a unique integer (label so might not have enough room - 2G max) for processor + local inde...
Definition: globalIndex.H:63
const polyMesh & mesh() const
void calcFaceStencil(const labelListList &globalCellCells, labelListList &faceStencil) const
Collect cell neighbours into extended stencil.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
void validBoundaryFaces(boolList &isValidBFace) const
Valid boundary faces (not empty and not coupled)
labelList calcFaceCells(const boolList &nonEmptyFace, const labelList &faceLabels, labelHashSet &globals) const
Collect cell neighbours of faces in global numbering.
static void merge(const label global0, const label global1, const labelList &listA, labelList &listB)
Merge two lists.
Namespace for OpenFOAM.
autoPtr< indirectPrimitivePatch > allCoupledFacesPatch() const
Return patch of all coupled faces.