faceMapper.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-2023 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::faceMapper
26 
27 Description
28  This object provides mapping and fill-in information for face data
29  between the two meshes after the topological change. It is
30  constructed from polyTopoChangeMap.
31 
32 SourceFiles
33  faceMapper.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef faceMapper_H
38 #define faceMapper_H
39 
40 #include "morphFieldMapper.H"
41 #include "HashSet.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declaration of classes
49 class polyMesh;
50 class polyTopoChangeMap;
51 
52 /*---------------------------------------------------------------------------*\
53  Class faceMapper Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class faceMapper
57 :
58  public morphFieldMapper
59 {
60  // Private Data
61 
62  //- Reference to polyMesh
63  const polyMesh& mesh_;
64 
65  //- Reference to polyTopoChangeMap
66  const polyTopoChangeMap& mpm_;
67 
68  //- Are there any inserted (unmapped) faces
69  bool insertedFaces_;
70 
71  //- Is the mapping direct
72  bool direct_;
73 
74 
75  // Demand-driven private data
76 
77  //- Direct addressing (only one for of addressing is used)
78  mutable labelList* directAddrPtr_;
79 
80  //- Interpolated addressing (only one for of addressing is used)
81  mutable labelListList* interpolationAddrPtr_;
82 
83  //- Interpolation weights
84  mutable scalarListList* weightsPtr_;
85 
86  //- Inserted faces
87  mutable labelList* insertedFaceLabelsPtr_;
88 
89 
90  // Private Member Functions
91 
92  //- Calculate addressing for mapping with inserted faces
93  void calcAddressing() const;
94 
95  //- Clear out local storage
96  void clearOut();
97 
98 
99 public:
100 
101  // Constructors
102 
103  //- Construct from polyTopoChangeMap
104  faceMapper(const polyTopoChangeMap& mpm);
105 
106  //- Disallow default bitwise copy construction
107  faceMapper(const faceMapper&) = delete;
108 
109 
110  //- Destructor
111  virtual ~faceMapper();
112 
113 
114  // Member Functions
115 
116  //- Is the mapping direct
117  virtual bool direct() const
118  {
119  return direct_;
120  }
121 
122  //- Return direct addressing
123  virtual const labelUList& directAddressing() const;
124 
125  //- Return interpolated addressing
126  virtual const labelListList& addressing() const;
127 
128  //- Return interpolation weights
129  virtual const scalarListList& weights() const;
130 
131  //- Return size of field before mapping
132  virtual label sizeBeforeMapping() const;
133 
134  //- Return number of internal faces before mapping
136 
137  //- Are there any inserted faces
138  virtual bool insertedObjects() const
139  {
140  return insertedFaces_;
141  }
142 
143  //- Return list of inserted faces
144  virtual const labelList& insertedObjectLabels() const;
145 
146  //- Return flux flip map
147  const labelHashSet& flipFaceFlux() const;
148 
149  //- Return number of old internalFaces
150  label nOldInternalFaces() const;
151 
152  //- Return old patch starts
153  const labelList& oldPatchStarts() const;
154 
155  //- Return old patch sizes
156  const labelList& oldPatchSizes() const;
157 
158 
159  // Member Operators
160 
161  //- Disallow default bitwise assignment
162  void operator=(const faceMapper&) = delete;
163 };
164 
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 } // End namespace Foam
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
This object provides mapping and fill-in information for face data between the two meshes after the t...
Definition: faceMapper.H:58
virtual const labelListList & addressing() const
Return interpolated addressing.
Definition: faceMapper.C:244
virtual const scalarListList & weights() const
Return interpolation weights.
Definition: faceMapper.C:262
virtual const labelUList & directAddressing() const
Return direct addressing.
Definition: faceMapper.C:218
virtual const labelList & insertedObjectLabels() const
Return list of inserted faces.
Definition: faceMapper.C:292
const labelList & oldPatchStarts() const
Return old patch starts.
Definition: faceMapper.C:323
const labelList & oldPatchSizes() const
Return old patch sizes.
Definition: faceMapper.C:329
virtual label sizeBeforeMapping() const
Return size of field before mapping.
Definition: faceMapper.C:280
void operator=(const faceMapper &)=delete
Disallow default bitwise assignment.
label nOldInternalFaces() const
Return number of old internalFaces.
Definition: faceMapper.C:317
label internalSizeBeforeMapping() const
Return number of internal faces before mapping.
Definition: faceMapper.C:286
virtual ~faceMapper()
Destructor.
Definition: faceMapper.C:210
const labelHashSet & flipFaceFlux() const
Return flux flip map.
Definition: faceMapper.C:311
virtual bool insertedObjects() const
Are there any inserted faces.
Definition: faceMapper.H:137
faceMapper(const polyTopoChangeMap &mpm)
Construct from polyTopoChangeMap.
Definition: faceMapper.C:158
virtual bool direct() const
Is the mapping direct.
Definition: faceMapper.H:116
Abstract base class to hold the Field mapping for mesh morphs.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Namespace for OpenFOAM.
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