mappedInternalPolyPatch.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) 2022-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::mappedInternalPolyPatch
26 
27 Description
28  Patch which holds a mapping engine to map cell values onto the patch
29 
30 SourceFiles
31  mappedInternalPolyPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef mappedInternalPolyPatch_H
36 #define mappedInternalPolyPatch_H
37 
38 #include "polyPatch.H"
40 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 class polyMesh;
48 
49 /*---------------------------------------------------------------------------*\
50  Class mappedInternalPolyPatch Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public polyPatch,
57 {
58 
59 protected:
60 
61  // Protected Member Functions
62 
63  //- Calculate the patch geometry
64  virtual void calcGeometry(PstreamBuffers&);
65 
66  //- Correct patches after moving points
67  virtual void movePoints(PstreamBuffers&, const pointField&);
68 
69  //- Update of the patch topology
70  virtual void topoChange(PstreamBuffers&);
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("mappedInternal");
77 
78 
79  // Constructors
80 
81  //- Construct from components
83  (
84  const word& name,
85  const label size,
86  const label start,
87  const label index,
88  const polyBoundaryMesh& bm,
89  const word& patchType
90  );
91 
92  //- Construct from dictionary
94  (
95  const word& name,
96  const dictionary& dict,
97  const label index,
98  const polyBoundaryMesh& bm,
99  const word& patchType
100  );
101 
102  //- Construct as copy, resetting the boundary mesh
104  (
106  const polyBoundaryMesh&
107  );
108 
109  //- Construct given the original patch and resetting the
110  // face list and boundary mesh information
112  (
113  const mappedInternalPolyPatch& pp,
114  const polyBoundaryMesh& bm,
115  const label index,
116  const label newSize,
117  const label newStart
118  );
119 
120  //- Construct and return a clone, resetting the boundary mesh
121  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
122  {
123  return autoPtr<polyPatch>(new mappedInternalPolyPatch(*this, bm));
124  }
125 
126  //- Construct and return a clone, resetting the face list
127  // and boundary mesh
128  virtual autoPtr<polyPatch> clone
129  (
130  const polyBoundaryMesh& bm,
131  const label index,
132  const label newSize,
133  const label newStart
134  ) const
135  {
136  return autoPtr<polyPatch>
137  (
138  new mappedInternalPolyPatch(*this, bm, index, newSize, newStart)
139  );
140  }
141 
142 
143  //- Destructor
144  virtual ~mappedInternalPolyPatch();
145 
146 
147  // Member Functions
148 
149  //- Write the polyPatch data as a dictionary
150  virtual void write(Ostream&) const;
151 };
152 
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 } // End namespace Foam
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #endif
161 
162 // ************************************************************************* //
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 from cells to patch faces.
Patch which holds a mapping engine to map cell values onto the patch.
virtual void write(Ostream &) const
Write the polyPatch data as a dictionary.
mappedInternalPolyPatch(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 ~mappedInternalPolyPatch()
Destructor.
virtual void movePoints(PstreamBuffers &, const pointField &)
Correct patches after moving points.
TypeName("mappedInternal")
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.
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