mappedExtrudedWallPolyPatch.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-2026 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::mappedExtrudedWallPolyPatch
26 
27 Description
28  Wall patch which holds a mapping engine to map values from another patch
29 
30 SourceFiles
31  mappedExtrudedWallPolyPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef mappedExtrudedWallPolyPatch_H
36 #define mappedExtrudedWallPolyPatch_H
37 
38 #include "wallPolyPatch.H"
40 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class mappedExtrudedWallPolyPatch Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public wallPolyPatch,
55 {
56 protected:
57 
58  // Protected Member Functions
59 
60  //- Calculate the patch geometry
61  virtual void calcGeometry(PstreamBuffers&);
62 
63  //- Correct patches after moving points
64  virtual void movePoints(PstreamBuffers&, const pointField&);
65 
66  //- Update of the patch topology
67  virtual void topoChange(PstreamBuffers&);
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("mappedExtrudedWall");
74 
75 
76  // Constructors
77 
78  //- Construct from components
80  (
81  const word& name,
82  const label size,
83  const label start,
84  const label index,
85  const polyBoundaryMesh& bm
86  );
87 
88  //- Construct from components
90  (
91  const word& name,
92  const label size,
93  const label start,
94  const label index,
95  const word& neighbourRegion,
96  const word& neighbourPatch,
97  const bool isExtrudedRegion,
98  const polyBoundaryMesh& bm
99  );
100 
101  //- Construct from dictionary
103  (
104  const word& name,
105  const dictionary& dict,
106  const label index,
107  const polyBoundaryMesh& bm
108  );
109 
110  //- Construct as copy, resetting the boundary mesh
112  (
114  const polyBoundaryMesh&
115  );
116 
117  //- Construct given the original patch and resetting the
118  // face list and boundary mesh information
120  (
121  const mappedExtrudedWallPolyPatch& pp,
122  const polyBoundaryMesh& bm,
123  const label index,
124  const label newSize,
125  const label newStart
126  );
127 
128  //- Construct and return a clone, resetting the boundary mesh
129  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
130  {
131  return autoPtr<polyPatch>
132  (
133  new mappedExtrudedWallPolyPatch(*this, bm)
134  );
135  }
136 
137  //- Construct and return a clone, resetting the face list
138  // and boundary mesh
139  virtual autoPtr<polyPatch> clone
140  (
141  const polyBoundaryMesh& bm,
142  const label index,
143  const label newSize,
144  const label newStart
145  ) const
146  {
147  return autoPtr<polyPatch>
148  (
150  (
151  *this,
152  bm,
153  index,
154  newSize,
155  newStart
156  )
157  );
158  }
159 
160 
161  //- Destructor
163 
164 
165  // Member Functions
166 
167  //- Write the polyPatch data as a dictionary
168  virtual void write(Ostream&) const;
169 };
170 
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 } // End namespace Foam
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 #endif
179 
180 // ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
autoPtr< PrimitivePatch< SubList< face >, const pointField & > > clone() const
Construct and return a clone.
Buffers for inter-processor communications streams (UOPstream, UIPstream).
label size() const
Return the number of elements in the UList.
Definition: UListI.H:311
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 keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Engine which provides mapping between two patches and which offsets the geometry to account for the e...
Wall patch which holds a mapping engine to map values from another patch.
virtual void write(Ostream &) const
Write the polyPatch data as a dictionary.
mappedExtrudedWallPolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)
Construct from components.
virtual void calcGeometry(PstreamBuffers &)
Calculate the patch geometry.
virtual void movePoints(PstreamBuffers &, const pointField &)
Correct patches after moving points.
TypeName("mappedExtrudedWall")
Runtime type information.
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.
label start() const
Return start label of this patch in the polyMesh face list.
Definition: polyPatch.H:277
Foam::wallPolyPatch.
Definition: wallPolyPatch.H:51
A class for handling words, derived from string.
Definition: word.H:63
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