cyclicSlipPolyPatch.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2012 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,
73  )
74  :
75  cyclicPolyPatch(name, size, start, index, bm, patchType, transform)
76  {}
77 
78  //- Construct from dictionary
80  (
81  const word& name,
82  const dictionary& dict,
83  const label index,
84  const polyBoundaryMesh& bm,
85  const word& patchType
86  )
87  :
88  cyclicPolyPatch(name, dict, index, bm, patchType)
89  {}
90 
91  //- Construct as copy, resetting the boundary mesh
93  (
94  const cyclicSlipPolyPatch& pp,
95  const polyBoundaryMesh& bm
96  )
97  :
98  cyclicPolyPatch(pp, bm)
99  {}
100 
101  //- Construct given the original patch and resetting the
102  // face list and boundary mesh information
104  (
105  const cyclicSlipPolyPatch& pp,
106  const polyBoundaryMesh& bm,
107  const label index,
108  const label newSize,
109  const label newStart,
110  const word& neighbPatchName
111  )
112  :
113  cyclicPolyPatch(pp, bm, index, newSize, newStart, neighbPatchName)
114  {}
115 
116 
117  //- Construct given the original patch and a map
119  (
120  const cyclicPolyPatch& pp,
121  const polyBoundaryMesh& bm,
122  const label index,
123  const labelUList& mapAddressing,
124  const label newStart
125  )
126  :
127  cyclicPolyPatch(pp, bm, index, mapAddressing, newStart)
128  {}
129 
130 
131  //- Construct and return a clone, resetting the boundary mesh
132  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
133  {
134  return autoPtr<polyPatch>(new cyclicSlipPolyPatch(*this, bm));
135  }
136 
137  //- Construct and return a clone, resetting the face list
138  // and boundary mesh
140  (
141  const polyBoundaryMesh& bm,
142  const label index,
143  const label newSize,
144  const label newStart
145  ) const
146  {
147  return autoPtr<polyPatch>
148  (
150  (
151  *this,
152  bm,
153  index,
154  newSize,
155  newStart,
157  )
158  );
159  }
160 
161  //- Construct and return a clone, resetting the face list
162  // and boundary mesh
164  (
165  const polyBoundaryMesh& bm,
166  const label index,
167  const labelUList& mapAddressing,
168  const label newStart
169  ) const
170  {
171  return autoPtr<polyPatch>
172  (
174  (
175  *this,
176  bm,
177  index,
178  mapAddressing,
179  newStart
180  )
181  );
182  }
183 
184 
185  // Destructor
187  virtual ~cyclicSlipPolyPatch()
188  {}
189 
190 
191 };
192 
193 
194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
195 
196 } // End namespace Foam
197 
198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
199 
200 #endif
201 
202 // ************************************************************************* //
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
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
const word & neighbPatchName() const
Neighbour patch name.
virtual autoPtr< polyPatch > clone(const polyBoundaryMesh &bm) const
Construct and return a clone, resetting the boundary mesh.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
Copy of cyclicSlip - used to be able to instantiate cyclicSlip pointPatch which is cyclicSlip with sl...
A class for handling words, derived from string.
Definition: word.H:59
virtual transformType transform() const
Type of transform.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
TypeName("cyclicSlip")
Runtime type information.
Cyclic plane patch.
Foam::polyBoundaryMesh.
cyclicSlipPolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const transformType transform=UNKNOWN)
Construct from components.