pointBoundaryMesh.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-2022 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::pointBoundaryMesh
26 
27 Description
28  Foam::pointBoundaryMesh
29 
30 SourceFiles
31  pointBoundaryMesh.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef pointBoundaryMesh_H
36 #define pointBoundaryMesh_H
37 
38 #include "pointPatchList.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of classes
46 class pointMesh;
47 class polyBoundaryMesh;
48 
49 /*---------------------------------------------------------------------------*\
50  Class pointBoundaryMesh Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public pointPatchList
56 {
57  // Private Data
58 
59  //- Reference to mesh
60  const pointMesh& mesh_;
61 
62 
63  // Private Member Functions
64 
65  //- Calculate the geometry for the patches (transformation tensors etc.)
66  void calcGeometry();
67 
68 
69 public:
70 
71  //- Declare friendship with pointMesh
72  friend class pointMesh;
73 
74 
75  // Constructors
76 
77  //- Construct from polyBoundaryMesh
79  (
80  const pointMesh&,
81  const polyBoundaryMesh&
82  );
83 
84  //- Disallow default bitwise copy construction
85  pointBoundaryMesh(const pointBoundaryMesh&) = delete;
86 
87 
88  // Member Functions
89 
90  //- Return the mesh reference
91  const pointMesh& mesh() const
92  {
93  return mesh_;
94  }
95 
96  //- Find patch index given a name
97  label findPatchID(const word& patchName) const;
98 
99  //- Find patch indices given a name
100  labelList findIndices(const wordRe&, const bool useGroups) const;
101 
102  //- Correct pointBoundaryMesh after moving points
103  void movePoints(const pointField&);
104 
105  //- Correct pointBoundaryMesh after topology update
106  void topoChange();
107 
108  //- Reset pointBoundaryMesh with respect to the updated polyBoundaryMesh
109  // For run-time mesh replacement and mesh to mesh mapping
110  void reset();
111 
112  //- Reorders patches. Ordering does not have to be done in
113  // ascending or descending order. Reordering has to be unique.
114  // (is shuffle). If validBoundary calls topoChange()
115  // after reordering to recalculate data (so call needs to be parallel
116  // sync in that case)
117  void shuffle(const labelUList& newToOld, const bool validBoundary);
118 
119 
120  // Member Operators
121 
122  //- Disallow default bitwise assignment
123  void operator=(const pointBoundaryMesh&) = delete;
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
labelList findIndices(const wordRe &, const bool useGroups) const
Find patch indices given a name.
Foam::pointBoundaryMesh.
void movePoints(const pointField &)
Correct pointBoundaryMesh after moving points.
label findPatchID(const word &patchName) const
Find patch index given a name.
void shuffle(const labelUList &newToOld, const bool validBoundary)
Reorders patches. Ordering does not have to be done in.
void topoChange()
Correct pointBoundaryMesh after topology update.
Mesh representing a set of points created from polyMesh.
Definition: pointMesh.H:48
void reset()
Reset pointBoundaryMesh with respect to the updated polyBoundaryMesh.
A class for handling words, derived from string.
Definition: word.H:59
A wordRe is a word, but can also have a regular expression for matching words.
Definition: wordRe.H:74
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
Foam::polyBoundaryMesh.
const pointMesh & mesh() const
Return the mesh reference.
void operator=(const pointBoundaryMesh &)=delete
Disallow default bitwise assignment.
pointBoundaryMesh(const pointMesh &, const polyBoundaryMesh &)
Construct from polyBoundaryMesh.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
Namespace for OpenFOAM.