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) 2011-2012 OpenFOAM Foundation
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 "faceOnlySet.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 // Forward declaration of classes
45 class meshSearch;
46 
47 /*---------------------------------------------------------------------------*\
48  Class midPointSet Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class midPointSet
52 :
53  public faceOnlySet
54 {
55  // Private Member Functions
56 
57  void genSamples();
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("midPoint");
64 
65 
66  // Constructors
67 
68  //- Construct from components
70  (
71  const word& name,
72  const polyMesh& mesh,
73  const meshSearch& searchEngine,
74  const word& axis,
75  const point& start,
76  const point& end
77  );
78 
79  //- Construct from dictionary
81  (
82  const word& name,
83  const polyMesh& mesh,
84  const meshSearch& searchEngine,
85  const dictionary& dict
86  );
87 
88 
89  //- Destructor
90  virtual ~midPointSet();
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Various (local, not parallel) searches on polyMesh; uses (demand driven) octree to search...
Definition: meshSearch.H:57
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const point & start() const
Definition: faceOnlySet.H:136
TypeName("midPoint")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:59
midPointSet(const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis, const point &start, const point &end)
Construct from components.
Definition: midPointSet.C:105
const word & name() const
Definition: coordSet.H:111
virtual ~midPointSet()
Destructor.
Definition: midPointSet.C:146
word axis() const
Definition: coordSet.H:116
const point & end() const
Definition: faceOnlySet.H:141
const polyMesh & mesh() const
Definition: sampledSet.H:241
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const meshSearch & searchEngine() const
Definition: sampledSet.H:246
Namespace for OpenFOAM.