FreeFOAM The Cross-Platform CFD Toolkit
coupledPointPatch.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::coupledPointPatch
26 
27 Description
28  coupled patch for post-processing. Used as the base class for processor
29  and cyclic pointPatches
30 
31 SourceFiles
32  coupledPointPatch.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef coupledPointPatch_H
37 #define coupledPointPatch_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class pointBoundaryMesh;
47 
48 /*---------------------------------------------------------------------------*\
49  Class coupledPointPatch Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 {
54  // Private Member Functions
55 
56  //- Disallow default construct as copy
58 
59  //- Disallow default assignment
60  void operator=(const coupledPointPatch&);
61 
62 
63 protected:
64 
65  // Protected Member Functions
66 
67  //- Initialise the calculation of the patch geometry
68  virtual void initGeometry() = 0;
69 
70  //- Calculate the patch geometry
71  virtual void calcGeometry() = 0;
72 
73  //- Initialise the patches for moving points
74  virtual void initMovePoints(const pointField&) = 0;
75 
76  //- Correct patches after moving points
77  virtual void movePoints(const pointField&) = 0;
78 
79  //- Initialise the update of the patch topology
80  virtual void initUpdateMesh() = 0;
81 
82  //- Update of the patch topology
83  virtual void updateMesh() = 0;
84 
85 
86 public:
87 
88  //- Runtime type information
89  TypeName(coupledPolyPatch::typeName_());
90 
91 
92  // Constructors
93 
94  //- Construct from components
96 
97 
98  // Destructor
99 
100  virtual ~coupledPointPatch();
101 
102 
103  // Member Functions
104 
105  // Access
106 
107  //- Return true because this patch is coupled
108  virtual bool coupled() const
109  {
110  return true;
111  }
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************ vim: set sw=4 sts=4 et: ************************ //