All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
wallPolyPatch.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-2022 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::wallPolyPatch
26 
27 Description
28  Foam::wallPolyPatch
29 
30 SourceFiles
31  wallPolyPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef wallPolyPatch_H
36 #define wallPolyPatch_H
37 
38 #include "polyPatch.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class wallPolyPatch Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class wallPolyPatch
50 :
51  public polyPatch
52 {
53 public:
54 
55  //- Runtime type information
56  TypeName("wall");
57 
58 
59  // Constructors
60 
61  //- Construct from components
63  (
64  const word& name,
65  const label size,
66  const label start,
67  const label index,
68  const polyBoundaryMesh& bm,
69  const word& patchType
70  );
71 
72  //- Construct from dictionary
74  (
75  const word& name,
76  const dictionary& dict,
77  const label index,
78  const polyBoundaryMesh& bm,
79  const word& patchType
80  );
81 
82  //- Construct as copy, resetting the boundary mesh
84 
85  //- Construct given the original patch and resetting the
86  // face list and boundary mesh information
88  (
89  const wallPolyPatch& pp,
90  const polyBoundaryMesh& bm,
91  const label index,
92  const label newSize,
93  const label newStart
94  );
95 
96  //- Construct and return a clone, resetting the boundary mesh
97  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
98  {
99  return autoPtr<polyPatch>(new wallPolyPatch(*this, bm));
100  }
101 
102  //- Construct and return a clone, resetting the face list
103  // and boundary mesh
104  virtual autoPtr<polyPatch> clone
105  (
106  const polyBoundaryMesh& bm,
107  const label index,
108  const label newSize,
109  const label newStart
110  ) const
111  {
112  return autoPtr<polyPatch>
113  (
114  new wallPolyPatch(*this, bm, index, newSize, newStart)
115  );
116  }
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
autoPtr< PrimitivePatch< SubList< face >, const pointField & > > clone() const
Construct and return a clone.
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
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
Foam::wallPolyPatch.
Definition: wallPolyPatch.H:51
wallPolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
Construct from components.
Definition: wallPolyPatch.C:42
TypeName("wall")
Runtime type information.
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