mappedFilmWallPolyPatch.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) 2023-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::mappedFilmWallPolyPatch
26 
27 Description
28  Wall patch which holds a mapping engine to map values from another patch
29 
30 SourceFiles
31  mappedFilmWallPolyPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef mappedFilmWallPolyPatch_H
36 #define mappedFilmWallPolyPatch_H
37 
38 #include "filmWallPolyPatch.H"
39 #include "mappedPatchBase.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class polyMesh;
47 
48 /*---------------------------------------------------------------------------*\
49  Class mappedFilmWallPolyPatch Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public filmWallPolyPatch,
55  public mappedPatchBase
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("mappedFilmWall");
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  );
88 
89  //- Construct from components
91  (
92  const word& name,
93  const label size,
94  const label start,
95  const label index,
96  const word& neighbourRegion,
97  const word& neighbourPatch,
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 mappedFilmWallPolyPatch& 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>(new mappedFilmWallPolyPatch(*this, bm));
132  }
133 
134  //- Construct and return a clone, resetting the face list
135  // and boundary mesh
136  virtual autoPtr<polyPatch> clone
137  (
138  const polyBoundaryMesh& bm,
139  const label index,
140  const label newSize,
141  const label newStart
142  ) const
143  {
144  return autoPtr<polyPatch>
145  (
147  (
148  *this,
149  bm,
150  index,
151  newSize,
152  newStart
153  )
154  );
155  }
156 
157 
158  //- Destructor
159  virtual ~mappedFilmWallPolyPatch();
160 
161 
162  // Member Functions
163 
164  //- Write the polyPatch data as a dictionary
165  virtual void write(Ostream&) const;
166 };
167 
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 } // End namespace Foam
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 #endif
176 
177 // ************************************************************************* //
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
Foam::filmWallPolyPatch.
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.
virtual void calcGeometry(PstreamBuffers &)
Calculate the patch geometry.
TypeName("mappedFilmWall")
Runtime type information.
mappedFilmWallPolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)
Construct from components.
virtual ~mappedFilmWallPolyPatch()
Destructor.
virtual void movePoints(PstreamBuffers &, const pointField &)
Correct patches after moving points.
virtual void topoChange(PstreamBuffers &)
Update of the patch topology.
Engine and base class for poly patches which provides interpolative mapping between two globally conf...
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
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