FreeFOAM The Cross-Platform CFD Toolkit
cyclicPointPatch.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) 1991-2010 OpenCFD Ltd.
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::cyclicPointPatch
26 
27 Description
28  Cyclic patch for post-processing.
29 
30 SourceFiles
31  cyclicPointPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cyclicPointPatch_H
36 #define cyclicPointPatch_H
37 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cyclicPointPatch Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
53 {
54  // Private data
55 
56  //- Local reference cast into the cyclic patch
57  const cyclicPolyPatch& cyclicPolyPatch_;
58 
59 
60  // Private Member Functions
61 
62  //- Disallow default construct as copy
64 
65  //- Disallow default assignment
66  void operator=(const cyclicPointPatch&);
67 
68 
69  // Demand driven private data
70 
71  //- The set of pairs of points that require transformation
72  // and/or mapping
73  edgeList transformPairs_;
74 
75  //- Initialise the calculation of the patch geometry
76  virtual void initGeometry();
77 
78  //- Calculate the patch geometry
79  virtual void calcGeometry();
80 
81  //- Initialise the patches for moving points
82  virtual void initMovePoints(const pointField&);
83 
84  //- Correct patches after moving points
85  virtual void movePoints(const pointField&);
86 
87  //- Initialise the update of the patch topology
88  virtual void initUpdateMesh();
89 
90  //- Update of the patch topology
91  virtual void updateMesh();
92 
93 
94 public:
95 
96  //- Runtime type information
97  TypeName(cyclicPolyPatch::typeName_());
98 
99 
100  // Constructors
101 
102  //- Construct from components
104  (
105  const polyPatch& patch,
106  const pointBoundaryMesh& bm
107  );
108 
109 
110  // Destructor
111 
112  virtual ~cyclicPointPatch();
113 
114 
115  // Member Functions
116 
117  // Access
118 
119  //- Return the underlying cyclicPolyPatch
121  {
122  return cyclicPolyPatch_;
123  }
124 
125  //- Are the cyclic planes parallel
126  bool parallel() const
127  {
128  return cyclicPolyPatch_.parallel();
129  }
130 
131  //- Return face transformation tensor
132  const tensorField& forwardT() const
133  {
134  return cyclicPolyPatch_.forwardT();
135  }
136 
137  //- Return neighbour-cell transformation tensor
138  const tensorField& reverseT() const
139  {
140  return cyclicPolyPatch_.reverseT();
141  }
142 
143 
144  // Access functions for demand driven data
145 
146  //- Return the set of pairs of points that require transformation
147  // and/or mapping
148  virtual const edgeList& transformPairs() const;
149 };
150 
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 } // End namespace Foam
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 #endif
159 
160 // ************************ vim: set sw=4 sts=4 et: ************************ //