mappedWallPolyPatch.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2012 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::mappedWallPolyPatch
28 
29 Description
30  Determines a mapping between patch face centres and mesh cell or face
31  centres and processors they're on.
32 
33 Note
34  Storage is not optimal. It stores all face centres and cells on all
35  processors to keep the addressing calculation simple.
36 
37 SourceFiles
38  mappedWallPolyPatch.C
39 
40 \*---------------------------------------------------------------------------*/
41 
42 #ifndef mappedWallPolyPatch_H
43 #define mappedWallPolyPatch_H
44 
45 #include "wallPolyPatch.H"
46 #include "mappedPatchBase.H"
47 
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 
54 class polyMesh;
55 
56 /*---------------------------------------------------------------------------*\
57  Class mappedWallPolyPatch Declaration
58 \*---------------------------------------------------------------------------*/
59 
61 :
62  public wallPolyPatch,
63  public mappedPatchBase
64 {
65 
66 protected:
67 
68  //- Initialise the calculation of the patch geometry
69  virtual void initGeometry(PstreamBuffers&);
70 
71  //- Calculate the patch geometry
72  virtual void calcGeometry(PstreamBuffers&);
73 
74  //- Initialise the patches for moving points
75  virtual void initMovePoints(PstreamBuffers&, const pointField&);
76 
77  //- Correct patches after moving points
78  virtual void movePoints(PstreamBuffers&, const pointField&);
79 
80  //- Initialise the update of the patch topology
81  virtual void initUpdateMesh(PstreamBuffers&);
82 
83  //- Update of the patch topology
84  virtual void updateMesh(PstreamBuffers&);
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("mappedWall");
91 
92 
93  // Constructors
94 
95  //- Construct from components
97  (
98  const word& name,
99  const label size,
100  const label start,
101  const label index,
102  const polyBoundaryMesh& bm,
103  const word& patchType
104  );
105 
106  //- Construct from components
108  (
109  const word& name,
110  const label size,
111  const label start,
112  const label index,
113  const word& sampleRegion,
115  const word& samplePatch,
116  const vectorField& offset,
117  const polyBoundaryMesh& bm
118  );
119 
120  //- Construct from components. Uniform offset.
122  (
123  const word& name,
124  const label size,
125  const label start,
126  const label index,
127  const word& sampleRegion,
129  const word& samplePatch,
130  const vector& offset,
131  const polyBoundaryMesh& bm
132  );
133 
134  //- Construct from dictionary
136  (
137  const word& name,
138  const dictionary& dict,
139  const label index,
140  const polyBoundaryMesh& bm,
141  const word& patchType
142  );
143 
144  //- Construct as copy, resetting the boundary mesh
146  (
147  const mappedWallPolyPatch&,
148  const polyBoundaryMesh&
149  );
150 
151  //- Construct given the original patch and resetting the
152  // face list and boundary mesh information
154  (
155  const mappedWallPolyPatch& pp,
156  const polyBoundaryMesh& bm,
157  const label index,
158  const label newSize,
159  const label newStart
160  );
161 
162  //- Construct given the original patch and a map
164  (
165  const mappedWallPolyPatch& pp,
166  const polyBoundaryMesh& bm,
167  const label index,
168  const labelUList& mapAddressing,
169  const label newStart
170  );
171 
172  //- Construct and return a clone, resetting the boundary mesh
173  virtual autoPtr<polyPatch> clone(const polyBoundaryMesh& bm) const
174  {
175  return autoPtr<polyPatch>(new mappedWallPolyPatch(*this, bm));
176  }
177 
178  //- Construct and return a clone, resetting the face list
179  // and boundary mesh
181  (
182  const polyBoundaryMesh& bm,
183  const label index,
184  const label newSize,
185  const label newStart
186  ) const
187  {
188  return autoPtr<polyPatch>
189  (
191  (
192  *this,
193  bm,
194  index,
195  newSize,
196  newStart
197  )
198  );
199  }
200 
201  //- Construct and return a clone, resetting the face list
202  // and boundary mesh
204  (
205  const polyBoundaryMesh& bm,
206  const label index,
207  const labelUList& mapAddressing,
208  const label newStart
209  ) const
210  {
211  return autoPtr<polyPatch>
212  (
214  (
215  *this,
216  bm,
217  index,
218  mapAddressing,
219  newStart
220  )
221  );
222  }
223 
224 
225  //- Destructor
226  virtual ~mappedWallPolyPatch();
227 
228 
229  // Member functions
230 
231  //- Write the polyPatch data as a dictionary
232  virtual void write(Ostream&) const;
233 };
234 
235 
236 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
237 
238 } // End namespace Foam
239 
240 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
241 
242 #endif
243 
244 // ************************************************************************* //
Foam::mappedWallPolyPatch::calcGeometry
virtual void calcGeometry(PstreamBuffers &)
Calculate the patch geometry.
Definition: mappedWallPolyPatch.C:196
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::mappedWallPolyPatch::~mappedWallPolyPatch
virtual ~mappedWallPolyPatch()
Destructor.
Definition: mappedWallPolyPatch.C:182
Foam::polyBoundaryMesh
A polyBoundaryMesh is a polyPatch list with additional search methods and registered IO.
Definition: polyBoundaryMesh.H:62
Foam::mappedWallPolyPatch::updateMesh
virtual void updateMesh(PstreamBuffers &)
Update of the patch topology.
Definition: mappedWallPolyPatch.C:230
Foam::mappedWallPolyPatch::movePoints
virtual void movePoints(PstreamBuffers &, const pointField &)
Correct patches after moving points.
Definition: mappedWallPolyPatch.C:214
Foam::PstreamBuffers
Buffers for inter-processor communications streams (UOPstream, UIPstream).
Definition: PstreamBuffers.H:87
wallPolyPatch.H
Foam::mappedPatchBase
Determines a mapping between patch face centres and mesh cell or face centres and processors they're ...
Definition: mappedPatchBase.H:112
Foam::mappedWallPolyPatch::clone
virtual autoPtr< polyPatch > clone(const polyBoundaryMesh &bm) const
Construct and return a clone, resetting the boundary mesh.
Definition: mappedWallPolyPatch.H:172
Foam::mappedPatchBase::offset
const vector & offset() const
Offset vector (from patch faces to destination mesh objects)
Definition: mappedPatchBaseI.H:135
Foam::mappedWallPolyPatch::TypeName
TypeName("mappedWall")
Runtime type information.
Foam::Field< vector >
Foam::mappedPatchBase::mode
const sampleMode & mode() const
What to sample.
Definition: mappedPatchBaseI.H:30
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::mappedWallPolyPatch::initGeometry
virtual void initGeometry(PstreamBuffers &)
Initialise the calculation of the patch geometry.
Definition: mappedWallPolyPatch.C:190
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::wallPolyPatch
Foam::wallPolyPatch.
Definition: wallPolyPatch.H:50
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::mappedWallPolyPatch::mappedWallPolyPatch
mappedWallPolyPatch(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
Construct from components.
Definition: mappedWallPolyPatch.C:51
Foam::polyPatch::start
label start() const
Return start label of this patch in the polyMesh face list.
Definition: polyPatch.H:313
Foam::mappedPatchBase::sampleRegion
const word & sampleRegion() const
Region to sample.
Definition: mappedPatchBaseI.H:42
Foam::mappedWallPolyPatch
Determines a mapping between patch face centres and mesh cell or face centres and processors they're ...
Definition: mappedWallPolyPatch.H:59
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::Vector< scalar >
Foam::UList< label >
Foam::mappedWallPolyPatch::initMovePoints
virtual void initMovePoints(PstreamBuffers &, const pointField &)
Initialise the patches for moving points.
Definition: mappedWallPolyPatch.C:204
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::patchIdentifier::name
const word & name() const
The patch name.
Definition: patchIdentifier.H:134
Foam::patchIdentifier::index
label index() const
The index of this patch in the boundaryMesh.
Definition: patchIdentifier.H:158
Foam::mappedPatchBase::sampleMode
sampleMode
Mesh items to sample.
Definition: mappedPatchBase.H:120
Foam::mappedWallPolyPatch::write
virtual void write(Ostream &) const
Write the polyPatch data as a dictionary.
Definition: mappedWallPolyPatch.C:237
Foam::mappedWallPolyPatch::initUpdateMesh
virtual void initUpdateMesh(PstreamBuffers &)
Initialise the update of the patch topology.
Definition: mappedWallPolyPatch.C:224
mappedPatchBase.H
Foam::mappedPatchBase::samplePatch
const word & samplePatch() const
Patch (only if NEARESTPATCHFACE)
Definition: mappedPatchBaseI.H:68