FreeFOAM The Cross-Platform CFD Toolkit
pointSet.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::pointSet
26 
27 Description
28  A set of point labels.
29 
30 SourceFiles
31  pointSet.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef pointSet_H
36 #define pointSet_H
37 
38 #include <meshTools/topoSet.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class pointSet Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class pointSet
50 :
51  public topoSet
52 {
53 
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("pointSet");
59 
60 
61  // Constructors
62 
63 
64  //- Construct from IOobject
65  pointSet(const IOobject& obj);
66 
67  //- Construct from objectRegistry and name
68  pointSet
69  (
70  const polyMesh& mesh,
71  const word& name,
74  );
75 
76  //- Construct from additional size of labelHashSet
77  pointSet
78  (
79  const polyMesh& mesh,
80  const word& name,
81  const label,
83  );
84 
85  //- Construct from additional labelHashSet
86  pointSet
87  (
88  const polyMesh& mesh,
89  const word& name,
90  const topoSet&,
92  );
93 
94  //- Construct from additional labelHashSet
95  pointSet
96  (
97  const polyMesh& mesh,
98  const word& name,
99  const labelHashSet&,
101  );
102 
103 
104  // Destructor
105 
106  virtual ~pointSet();
107 
108 
109  // Member functions
110 
111  //- Sync set across coupled patches. Adds coupled points to set.
112  virtual void sync(const polyMesh& mesh);
113 
114  //- Return max index+1.
115  virtual label maxSize(const polyMesh& mesh) const;
116 
117  //- Update any stored data for new labels
118  virtual void updateMesh(const mapPolyMesh& morphMap);
119 
120  //- Update any stored data for new labels
121  //virtual void updateMesh(const polyTopoChange& meshMod);
122 
123  //- Write maxLen items with label and coordinates.
124  virtual void writeDebug
125  (
126  Ostream& os,
127  const primitiveMesh&,
128  const label maxLen
129  ) const;
130 
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #endif
141 
142 // ************************ vim: set sw=4 sts=4 et: ************************ //