mappedWallPolyPatch.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-2024 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::mappedWallPolyPatch
26 
27 Description
28  Wall poly patch which can do interpolative mapping of values from another
29  globally conforming poly patch
30 
31 SourceFiles
32  mappedWallPolyPatch.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef mappedWallPolyPatch_H
37 #define mappedWallPolyPatch_H
38 
39 #include "wallPolyPatch.H"
40 #include "mappedPatchBase.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class mappedWallPolyPatch Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public wallPolyPatch,
54  public mappedPatchBase
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("mappedWall");
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  const word& patchType
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  const word& patchType
109  );
110 
111  //- Construct as copy, resetting the boundary mesh
113  (
114  const mappedWallPolyPatch&,
115  const polyBoundaryMesh&
116  );
117 
118  //- Construct given the original patch and resetting the
119  // face list and boundary mesh information
121  (
122  const mappedWallPolyPatch& pp,
123  const polyBoundaryMesh& bm,
124  const label index,
125  const label newSize,
126  const label newStart
127  );
128 
129  //- Construct and return a clone, resetting the boundary mesh
130  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
131  {
132  return autoPtr<polyPatch>(new mappedWallPolyPatch(*this, bm));
133  }
134 
135  //- Construct and return a clone, resetting the face list
136  // and boundary mesh
137  virtual autoPtr<polyPatch> clone
138  (
139  const polyBoundaryMesh& bm,
140  const label index,
141  const label newSize,
142  const label newStart
143  ) const
144  {
145  return autoPtr<polyPatch>
146  (
148  (
149  *this,
150  bm,
151  index,
152  newSize,
153  newStart
154  )
155  );
156  }
157 
158 
159  //- Destructor
160  virtual ~mappedWallPolyPatch();
161 
162 
163  // Member Functions
164 
165  //- Write the polyPatch data as a dictionary
166  virtual void write(Ostream&) const;
167 };
168 
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 } // End namespace Foam
173 
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 
176 #endif
177 
178 // ************************************************************************* //
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 keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Engine and base class for poly patches which provides interpolative mapping between two globally conf...
Wall poly patch which can do interpolative mapping of values from another globally conforming poly pa...
mappedWallPolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
Construct from components.
virtual void write(Ostream &) const
Write the polyPatch data as a dictionary.
virtual void calcGeometry(PstreamBuffers &)
Calculate the patch geometry.
TypeName("mappedWall")
Runtime type information.
virtual ~mappedWallPolyPatch()
Destructor.
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.
label start() const
Return start label of this patch in the polyMesh face list.
Definition: polyPatch.H:280
Foam::wallPolyPatch.
Definition: wallPolyPatch.H:51
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