pointMesh.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-2020 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::pointMesh
26 
27 Description
28  Mesh representing a set of points created from polyMesh.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef pointMesh_H
33 #define pointMesh_H
34 
35 #include "GeoMesh.H"
36 #include "MeshObject.H"
37 #include "polyMesh.H"
38 #include "pointBoundaryMesh.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class pointMesh Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class pointMesh
50 :
51  public MeshObject<polyMesh, PatchMeshObject, pointMesh>,
52  public GeoMesh<polyMesh>
53 {
54  // Permanent data
55 
56  //- Boundary mesh
57  pointBoundaryMesh boundary_;
58 
59 
60  // Private Member Functions
61 
62  //- Map all fields
63  void mapFields(const mapPolyMesh&);
64 
65 
66 public:
67 
68  // Declare name of the class and its debug switch
69  ClassName("pointMesh");
70 
71 
72  typedef pointMesh Mesh;
74 
75 
76  // Constructors
77 
78  //- Construct from polyMesh
79  explicit pointMesh(const polyMesh& pMesh);
80 
81  //- Disallow default bitwise copy construction
82  pointMesh(const pointMesh&) = delete;
83 
84 
85  //- Destructor
86  ~pointMesh();
87 
88 
89  // Member Functions
90 
91  //- Return number of points
92  label size() const
93  {
94  return size(*this);
95  }
96 
97  //- Return number of points
98  static label size(const Mesh& mesh)
99  {
100  return mesh.GeoMesh<polyMesh>::mesh_.nPoints();
101  }
102 
103  //- Return reference to boundary mesh
104  const pointBoundaryMesh& boundary() const
105  {
106  return boundary_;
107  }
108 
109  //- Return parallel info
110  const globalMeshData& globalData() const
111  {
112  return GeoMesh<polyMesh>::mesh_.globalData();
113  }
114 
115  //- Return database. For now is its polyMesh.
116  const objectRegistry& thisDb() const
117  {
119  }
120 
121  //- Reset for changed polyMesh
122  void reset(const bool validBoundary);
123 
124 
125  // Mesh callbacks
126 
127  //- Move points
128  virtual bool movePoints();
129 
130  //- Update the mesh corresponding to given map
131  virtual void updateMesh(const mapPolyMesh& mpm);
132 
133  //- Reordered/removed trailing patches. If validBoundary call is
134  // parallel synced and all add the same patch with same settings
135  virtual void reorderPatches
136  (
137  const labelUList& newToOld,
138  const bool validBoundary
139  );
140 
141  //- Inserted patch at patchi
142  virtual void addPatch(const label patchi);
143 
144 
145  // Member Operators
146 
147  //- Disallow default bitwise assignment
148  void operator=(const pointMesh&) = delete;
150  bool operator!=(const pointMesh& pm) const
151  {
152  return &pm != this;
153  }
155  bool operator==(const pointMesh& pm) const
156  {
157  return &pm == this;
158  }
159 };
160 
161 
162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
163 
164 } // End namespace Foam
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 #endif
169 
170 // ************************************************************************* //
virtual bool movePoints()
Move points.
Definition: pointMesh.C:124
virtual void reorderPatches(const labelUList &newToOld, const bool validBoundary)
Reordered/removed trailing patches. If validBoundary call is.
Definition: pointMesh.C:154
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
Foam::pointBoundaryMesh.
void reset(const bool validBoundary)
Reset for changed polyMesh.
Definition: pointMesh.C:106
Various mesh related information for a parallel run. Upon construction, constructs all info using par...
bool operator==(const pointMesh &pm) const
Definition: pointMesh.H:154
ClassName("pointMesh")
virtual void addPatch(const label patchi)
Inserted patch at patchi.
Definition: pointMesh.C:177
virtual void updateMesh(const mapPolyMesh &mpm)
Update the mesh corresponding to given map.
Definition: pointMesh.C:138
pointMesh Mesh
Definition: pointMesh.H:71
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:158
Mesh representing a set of points created from polyMesh.
Definition: pointMesh.H:48
bool operator!=(const pointMesh &pm) const
Definition: pointMesh.H:149
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:85
const globalMeshData & globalData() const
Return parallel info.
Definition: pointMesh.H:109
const objectRegistry & thisDb() const
Return database. For now is its polyMesh.
Definition: pointMesh.H:115
~pointMesh()
Destructor.
Definition: pointMesh.C:93
label size() const
Return number of points.
Definition: pointMesh.H:91
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:60
const objectRegistry & thisDb() const
Return the object registry.
Definition: GeoMesh.H:77
label patchi
pointBoundaryMesh BoundaryMesh
Definition: pointMesh.H:72
label nPoints() const
pointMesh(const polyMesh &pMesh)
Construct from polyMesh.
Definition: pointMesh.C:73
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:46
Registry of regIOobjects.
GeoMesh(const MESH &mesh)
Construct from MESH.
Definition: GeoMesh.H:68
const pointBoundaryMesh & boundary() const
Return reference to boundary mesh.
Definition: pointMesh.H:103
const polyMesh & mesh_
Reference to Mesh.
Definition: GeoMesh.H:54
Namespace for OpenFOAM.
void operator=(const pointMesh &)=delete
Disallow default bitwise assignment.