FreeFOAM The Cross-Platform CFD Toolkit
midPointSet.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::midPointSet
26 
27 Description
28 
29 SourceFiles
30  midPointSet.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef midPointSet_H
35 #define midPointSet_H
36 
37 #include <sampling/faceOnlySet.H>
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 // Forward declaration of classes
45 class passiveParticle;
46 template<class Type> class particle;
47 class meshSearch;
48 
49 /*---------------------------------------------------------------------------*\
50  Class midPointSet Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public faceOnlySet
56 {
57  // Private Member Functions
58 
59  void genSamples();
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("midPoint");
65 
66 
67  // Constructors
68 
69  //- Construct from components
71  (
72  const word& name,
73  const polyMesh& mesh,
75  const word& axis,
76  const point& start,
77  const point& end
78  );
79 
80  //- Construct from dictionary
82  (
83  const word& name,
84  const polyMesh& mesh,
85  meshSearch& searchEngine,
86  const dictionary& dict
87  );
88 
89 
90  // Destructor
91 
92  virtual ~midPointSet();
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************ vim: set sw=4 sts=4 et: ************************ //