mappedPolyPatch.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::mappedPolyPatch
26 
27 Description
28  Patch which holds a mapping engine to map values from another patch
29 
30 SourceFiles
31  mappedPolyPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef mappedPolyPatch_H
36 #define mappedPolyPatch_H
37 
38 #include "polyPatch.H"
39 #include "mappedPatchBase.H"
40 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class mappedPolyPatch Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class mappedPolyPatch
52 :
53  public polyPatch,
54  public mappedPatchBase
55 {
56 
57 protected:
58 
59  // Protected Member Functions
60 
61  //- Calculate the patch geometry
62  virtual void calcGeometry(PstreamBuffers&);
63 
64  //- Correct patches after moving points
65  virtual void movePoints(PstreamBuffers&, const pointField&);
66 
67  //- Update of the patch topology
68  virtual void topoChange(PstreamBuffers&);
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("mapped");
75 
76 
77  // Constructors
78 
79  //- Construct from components
81  (
82  const word& name,
83  const label size,
84  const label start,
85  const label index,
86  const polyBoundaryMesh& bm,
87  const word& patchType
88  );
89 
90  //- Construct from dictionary
92  (
93  const word& name,
94  const dictionary& dict,
95  const label index,
96  const polyBoundaryMesh& bm,
97  const word& patchType
98  );
99 
100  //- Construct as copy, resetting the boundary mesh
102  (
103  const mappedPolyPatch&,
104  const polyBoundaryMesh&
105  );
106 
107  //- Construct given the original patch and resetting the
108  // face list and boundary mesh information
110  (
111  const mappedPolyPatch& pp,
112  const polyBoundaryMesh& bm,
113  const label index,
114  const label newSize,
115  const label newStart
116  );
117 
118  //- Construct and return a clone, resetting the boundary mesh
119  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
120  {
121  return autoPtr<polyPatch>(new mappedPolyPatch(*this, bm));
122  }
123 
124  //- Construct and return a clone, resetting the face list
125  // and boundary mesh
126  virtual autoPtr<polyPatch> clone
127  (
128  const polyBoundaryMesh& bm,
129  const label index,
130  const label newSize,
131  const label newStart
132  ) const
133  {
134  return autoPtr<polyPatch>
135  (
136  new mappedPolyPatch(*this, bm, index, newSize, newStart)
137  );
138  }
139 
140 
141  //- Destructor
142  virtual ~mappedPolyPatch();
143 
144 
145  // Member Functions
146 
147  //- Write the polyPatch data as a dictionary
148  virtual void write(Ostream&) const;
149 };
150 
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 } // End namespace Foam
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 #endif
159 
160 // ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
autoPtr< PrimitivePatch< FaceList, PointField > > clone() const
Construct and return a clone.
Buffers for inter-processor communications streams (UOPstream, UIPstream).
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
Engine which provides mapping between two patches.
Patch which holds a mapping engine to map values from another patch.
TypeName("mapped")
Runtime type information.
virtual ~mappedPolyPatch()
Destructor.
virtual void write(Ostream &) const
Write the polyPatch data as a dictionary.
mappedPolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
Construct from components.
virtual void calcGeometry(PstreamBuffers &)
Calculate the patch geometry.
virtual void movePoints(PstreamBuffers &, const pointField &)
Correct patches after moving points.
virtual void topoChange(PstreamBuffers &)
Update of the patch topology.
label index() const
Return the index of this patch in the boundaryMesh.
const word & name() const
Return name.
Foam::polyBoundaryMesh.
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:70
label start() const
Return start label of this patch in the polyMesh face list.
Definition: polyPatch.H:280
A class for handling words, derived from string.
Definition: word.H:62
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
dictionary dict