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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2012 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::midPointSet
28 
29 Description
30 
31 SourceFiles
32  midPointSet.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef midPointSet_H
37 #define midPointSet_H
38 
39 #include "faceOnlySet.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declarations
47 class meshSearch;
48 
49 /*---------------------------------------------------------------------------*\
50  Class midPointSet Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class midPointSet
54 :
55  public faceOnlySet
56 {
57  // Private Member Functions
58 
59  void genSamples();
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("midPoint");
66 
67 
68  // Constructors
69 
70  //- Construct from components
72  (
73  const word& name,
74  const polyMesh& mesh,
75  const meshSearch& searchEngine,
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  const meshSearch& searchEngine,
87  const dictionary& dict
88  );
89 
90 
91  //- Destructor
92  virtual ~midPointSet() = default;
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
Sample on faces along a specified path.
Definition: faceOnlySet.H:82
Various (local, not parallel) searches on polyMesh; uses (demand driven) octree to search...
Definition: meshSearch.H:56
dictionary dict
const word & axis() const
The sort axis name.
Definition: coordSet.H:160
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
const point & start() const
Definition: faceOnlySet.H:192
const point & end() const
Definition: faceOnlySet.H:197
TypeName("midPoint")
Runtime type information.
A class for handling words, derived from Foam::string.
Definition: word.H:63
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:108
const word & name() const noexcept
The coord-set name.
Definition: coordSet.H:152
A Vector of values with scalar precision, where scalar is float/double depending on the compilation f...
const polyMesh & mesh() const noexcept
Definition: sampledSet.H:373
virtual ~midPointSet()=default
Destructor.
const meshSearch & searchEngine() const noexcept
Definition: sampledSet.H:378
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.