FreeFOAM The Cross-Platform CFD Toolkit
midPointAndFaceSet.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::midPointAndFaceSet
26 
27 Description
28 
29 SourceFiles
30  midPointAndFaceSet.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef midPointAndFaceSet_H
35 #define midPointAndFaceSet_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 midPointAndFaceSet Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public faceOnlySet
56 {
57 
58  // Private Member Functions
59 
60  void genSamples();
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("midPointAndFace");
66 
67 
68  // Constructors
69 
70  //- Construct from components
72  (
73  const word& name,
74  const polyMesh& mesh,
76  const word& axis,
77  const point& start,
78  const point& end
79  );
80 
81  //- Construct from dictionary
83  (
84  const word& name,
85  const polyMesh& mesh,
86  meshSearch& searchEngine,
87  const dictionary& dict
88  );
89 
90 
91  // Destructor
92 
93  virtual ~midPointAndFaceSet();
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************ vim: set sw=4 sts=4 et: ************************ //