cyclicSlipPolyPatch.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-2020 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::cyclicSlipPolyPatch
26 
27 Description
28  Copy of cyclicSlip - used to be able to instantiate cyclicSlip pointPatch
29  which is cyclicSlip with slip constraints
30 
31 SourceFiles
32  cyclicSlipPolyPatch.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef cyclicSlipPolyPatch_H
37 #define cyclicSlipPolyPatch_H
38 
39 #include "cyclicPolyPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cyclicSlipPolyPatch Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public cyclicPolyPatch
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("cyclicSlip");
59 
60 
61  // Constructors
62 
63  //- Construct from components
65  (
66  const word& name,
67  const label size,
68  const label start,
69  const label index,
70  const polyBoundaryMesh& bm,
71  const word& patchType
72  )
73  :
74  cyclicPolyPatch(name, size, start, index, bm, patchType)
75  {}
76 
77  //- Construct from dictionary
79  (
80  const word& name,
81  const dictionary& dict,
82  const label index,
83  const polyBoundaryMesh& bm,
84  const word& patchType
85  )
86  :
87  cyclicPolyPatch(name, dict, index, bm, patchType)
88  {}
89 
90  //- Construct as copy, resetting the boundary mesh
92  (
93  const cyclicSlipPolyPatch& pp,
94  const polyBoundaryMesh& bm
95  )
96  :
97  cyclicPolyPatch(pp, bm)
98  {}
99 
100  //- Construct given the original patch and resetting the
101  // face list and boundary mesh information
103  (
104  const cyclicSlipPolyPatch& pp,
105  const polyBoundaryMesh& bm,
106  const label index,
107  const label newSize,
108  const label newStart,
109  const word& nbrPatchName
110  )
111  :
112  cyclicPolyPatch(pp, bm, index, newSize, newStart, nbrPatchName)
113  {}
114 
115 
116  //- Construct given the original patch and a map
118  (
119  const cyclicPolyPatch& pp,
120  const polyBoundaryMesh& bm,
121  const label index,
122  const labelUList& mapAddressing,
123  const label newStart
124  )
125  :
126  cyclicPolyPatch(pp, bm, index, mapAddressing, newStart)
127  {}
128 
129 
130  //- Construct and return a clone, resetting the boundary mesh
131  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
132  {
133  return autoPtr<polyPatch>(new cyclicSlipPolyPatch(*this, bm));
134  }
135 
136  //- Construct and return a clone, resetting the face list
137  // and boundary mesh
139  (
140  const polyBoundaryMesh& bm,
141  const label index,
142  const label newSize,
143  const label newStart
144  ) const
145  {
146  return autoPtr<polyPatch>
147  (
149  (
150  *this,
151  bm,
152  index,
153  newSize,
154  newStart,
155  nbrPatchName()
156  )
157  );
158  }
159 
160  //- Construct and return a clone, resetting the face list
161  // and boundary mesh
163  (
164  const polyBoundaryMesh& bm,
165  const label index,
166  const labelUList& mapAddressing,
167  const label newStart
168  ) const
169  {
170  return autoPtr<polyPatch>
171  (
173  (
174  *this,
175  bm,
176  index,
177  mapAddressing,
178  newStart
179  )
180  );
181  }
182 
183 
184  // Destructor
186  virtual ~cyclicSlipPolyPatch()
187  {}
188 
189 
190 };
191 
192 
193 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
194 
195 } // End namespace Foam
196 
197 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
198 
199 #endif
200 
201 // ************************************************************************* //
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const word & nbrPatchName() const
Neighbour patch name.
virtual autoPtr< PrimitivePatch< FaceList, PointField > > clone() const
Construct and return a clone.
A class for handling words, derived from string.
Definition: word.H:59
Cyclic plane patch.
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:60
Copy of cyclicSlip - used to be able to instantiate cyclicSlip pointPatch which is cyclicSlip with sl...
Foam::polyBoundaryMesh.
cyclicSlipPolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
Construct from components.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Namespace for OpenFOAM.
TypeName("cyclicSlip")
Runtime type information.