pointMapper.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::pointMapper
26 
27 Description
28  This object provides mapping and fill-in information for point data
29  between the two meshes after the topological change. It is
30  constructed from polyTopoChangeMap.
31 
32 SourceFiles
33  pointMapper.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef pointMapper_H
38 #define pointMapper_H
39 
40 #include "morphFieldMapper.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // Forward declaration of classes
48 class pointMesh;
49 class polyTopoChangeMap;
50 class polyMesh;
51 
52 /*---------------------------------------------------------------------------*\
53  Class pointMapper Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class pointMapper
57 :
58  public morphFieldMapper
59 {
60  // Private Data
61 
62  //- Reference to pointMesh
63  const pointMesh& pMesh_;
64 
65  //- Reference to polyTopoChangeMap
66  const polyTopoChangeMap& map_;
67 
68  //- Are there any inserted (unmapped) points
69  bool insertedPoints_;
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 points
87  mutable labelList* insertedPointLabelsPtr_;
88 
89 
90  // Private Member Functions
91 
92  //- Calculate addressing for mapping with inserted points
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  pointMapper(const pointMesh&, const polyTopoChangeMap& map);
105 
106  //- Disallow default bitwise copy construction
107  pointMapper(const pointMapper&) = delete;
108 
109 
110  //- Destructor
111  virtual ~pointMapper();
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 before mapping
132  virtual label sizeBeforeMapping() const;
133 
134  //- Are there any inserted points
135  virtual bool insertedObjects() const
136  {
137  return insertedPoints_;
138  }
139 
140  //- Return list of inserted points
141  virtual const labelList& insertedObjectLabels() const;
142 
143 
144  // Member Operators
145 
146  //- Disallow default bitwise assignment
147  void operator=(const pointMapper&) = delete;
148 };
149 
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 } // End namespace Foam
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #endif
158 
159 // ************************************************************************* //
Foam::tmp< Foam::Field< Type > > map(const Field< Type > &mapF) const
Abstract base class to hold the Field mapping for mesh morphs.
This object provides mapping and fill-in information for point data between the two meshes after the ...
Definition: pointMapper.H:58
virtual const labelListList & addressing() const
Return interpolated addressing.
Definition: pointMapper.C:255
virtual const scalarListList & weights() const
Return interpolation weights.
Definition: pointMapper.C:273
virtual const labelUList & directAddressing() const
Return direct addressing.
Definition: pointMapper.C:229
pointMapper(const pointMesh &, const polyTopoChangeMap &map)
Construct from polyTopoChangeMap.
Definition: pointMapper.C:167
virtual const labelList & insertedObjectLabels() const
Return list of inserted points.
Definition: pointMapper.C:297
virtual ~pointMapper()
Destructor.
Definition: pointMapper.C:221
virtual label sizeBeforeMapping() const
Return size before mapping.
Definition: pointMapper.C:291
void operator=(const pointMapper &)=delete
Disallow default bitwise assignment.
virtual bool insertedObjects() const
Are there any inserted points.
Definition: pointMapper.H:134
virtual bool direct() const
Is the mapping direct.
Definition: pointMapper.H:116
Mesh representing a set of points created from polyMesh.
Definition: pointMesh.H:53
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