FreeFOAM The Cross-Platform CFD Toolkit
cloudSet.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::cloudSet
26 
27 Description
28 
29 SourceFiles
30  cloudSet.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef cloudSet_H
35 #define cloudSet_H
36 
37 #include <sampling/sampledSet.H>
38 #include <OpenFOAM/DynamicList.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of classes
46 class passiveParticle;
47 template<class Type> class particle;
48 
49 /*---------------------------------------------------------------------------*\
50  Class cloudSet Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class cloudSet
54 :
55  public sampledSet
56 {
57  // Private data
58 
59  //- Sampling points
60  List<point> sampleCoords_;
61 
62 
63  // Private Member Functions
64 
65  //- Samples all points in sampleCoords.
66  void calcSamples
67  (
68  DynamicList<point>& samplingPts,
69  DynamicList<label>& samplingCells,
70  DynamicList<label>& samplingFaces,
71  DynamicList<label>& samplingSegments,
72  DynamicList<scalar>& samplingCurveDist
73  ) const;
74 
75  //- Uses calcSamples to obtain samples. Copies them into *this.
76  void genSamples();
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("cloud");
82 
83 
84  // Constructors
85 
86  //- Construct from components
87  cloudSet
88  (
89  const word& name,
90  const polyMesh& mesh,
92  const word& axis,
93  const List<point>& sampleCoords
94  );
95 
96  //- Construct from dictionary
97  cloudSet
98  (
99  const word& name,
100  const polyMesh& mesh,
101  meshSearch& searchEngine,
102  const dictionary& dict
103  );
104 
105 
106  // Destructor
107 
108  virtual ~cloudSet();
109 
110 
111  // Member Functions
112 
113  //- Get reference point
114  virtual point getRefPoint(const List<point>&) const;
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************ vim: set sw=4 sts=4 et: ************************ //