All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
symmetryPlanePolyPatch.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) 2013-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::symmetryPlanePolyPatch
26 
27 Description
28  Symmetry-plane patch.
29 
30 SourceFiles
31  symmetryPlanePolyPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef symmetryPlanePolyPatch_H
36 #define symmetryPlanePolyPatch_H
37 
38 #include "polyPatch.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class symmetryPlanePolyPatch Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public polyPatch
52 {
53  // Private Data
54 
55  //- Symmetry plane normal
56  vector n_;
57 
58 
59 protected:
60 
61  // Protected Member Functions
62 
63  //- Calculate the patch geometry
64  virtual void calcGeometry(PstreamBuffers&);
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("symmetryPlane");
71 
72 
73  // Constructors
74 
75  //- Construct from components
77  (
78  const word& name,
79  const label size,
80  const label start,
81  const label index,
82  const polyBoundaryMesh& bm,
83  const word& patchType
84  );
85 
86  //- Construct from dictionary
88  (
89  const word& name,
90  const dictionary& dict,
91  const label index,
92  const polyBoundaryMesh& bm,
93  const word& patchType
94  );
95 
96  //- Construct as copy, resetting the boundary mesh
98  (
100  const polyBoundaryMesh&
101  );
102 
103  //- Construct given the original patch and resetting the
104  // face list and boundary mesh information
106  (
107  const symmetryPlanePolyPatch& pp,
108  const polyBoundaryMesh& bm,
109  const label index,
110  const label newSize,
111  const label newStart
112  );
113 
114  //- Construct and return a clone, resetting the boundary mesh
115  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
116  {
117  return autoPtr<polyPatch>(new symmetryPlanePolyPatch(*this, bm));
118  }
119 
120  //- Construct and return a clone, resetting the face list
121  // and boundary mesh
122  virtual autoPtr<polyPatch> clone
123  (
124  const polyBoundaryMesh& bm,
125  const label index,
126  const label newSize,
127  const label newStart
128  ) const
129  {
130  return autoPtr<polyPatch>
131  (
132  new symmetryPlanePolyPatch(*this, bm, index, newSize, newStart)
133  );
134  }
135 
136 
137  // Member Functions
138 
139  //- Return symmetry plane normal
140  const vector& n() const
141  {
142  return n_;
143  }
144 };
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #endif
154 
155 // ************************************************************************* //
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
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
virtual void calcGeometry(PstreamBuffers &)
Calculate the patch geometry.
TypeName("symmetryPlane")
Runtime type information.
const vector & n() const
Return symmetry plane normal.
symmetryPlanePolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
Construct from components.
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