FreeFOAM The Cross-Platform CFD Toolkit
pointPatch.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::pointPatch
26 
27 Description
28  Basic pointPatch represents a set of points from the mesh.
29 
30 SourceFiles
31  pointPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef pointPatch_H
36 #define pointPatch_H
37 
38 #include <OpenFOAM/labelList.H>
39 #include <OpenFOAM/vectorField.H>
40 #include <OpenFOAM/triFaceList.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // Forward declaration of classes
48 
49 class pointBoundaryMesh;
50 class pointConstraint;
51 
52 /*---------------------------------------------------------------------------*\
53  Class pointPatch Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 {
58  // Private data
59 
60  //- Reference to boundary mesh
61  const pointBoundaryMesh& boundaryMesh_;
62 
63 
64  // Private Member Functions
65 
66  //- Disallow default bitwise copy construct
67  pointPatch(const pointPatch&);
68 
69  //- Disallow default bitwise assignment
70  void operator=(const pointPatch&);
71 
72 
73 protected:
74 
75  // Protected Member Functions
76 
77  // The pointPatch geometry initialisation is called by pointBoundaryMesh
78  friend class pointBoundaryMesh;
79 
80  //- Initialise the calculation of the patch geometry
81  virtual void initGeometry()
82  {}
83 
84  //- Calculate the patch geometry
85  virtual void calcGeometry()
86  {}
87 
88  //- Initialise the patches for moving points
89  virtual void initMovePoints(const pointField&)
90  {}
91 
92  //- Correct patches after moving points
93  virtual void movePoints(const pointField&)
94  {}
95 
96  //- Initialise the update of the patch topology
97  virtual void initUpdateMesh()
98  {}
99 
100  //- Update of the patch topology
101  virtual void updateMesh()
102  {}
103 
104 
105 public:
106 
107  //- Runtime type information
108  TypeName("basePatch");
109 
110 
111  // Constructor
112 
113  pointPatch
114  (
115  const pointBoundaryMesh& bm
116  )
117  :
118  boundaryMesh_(bm)
119  {}
120 
121 
122  // Destructor
123 
124  virtual ~pointPatch()
125  {}
126 
127 
128  // Member Functions
129 
130  //- Return name
131  virtual const word& name() const = 0;
132 
133  //- Return size
134  virtual label size() const = 0;
135 
136  //- Return the index of this patch in the pointBoundaryMesh
137  virtual label index() const = 0;
138 
139  //- Return boundaryMesh reference
141  {
142  return boundaryMesh_;
143  }
144 
145  //- Return true if this patch field is coupled
146  virtual bool coupled() const
147  {
148  return false;
149  }
150 
151  //- Return mesh points
152  virtual const labelList& meshPoints() const = 0;
153 
154  //- Return mesh points
155  virtual const vectorField& localPoints() const = 0;
156 
157  //- Return point normals
158  virtual const vectorField& pointNormals() const = 0;
159 
160  //- Accumulate the effect of constraint direction of this patch
161  virtual void applyConstraint
162  (
163  const label pointi,
165  ) const
166  {}
167 };
168 
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 } // End namespace Foam
173 
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 
176 #endif
177 
178 // ************************ vim: set sw=4 sts=4 et: ************************ //