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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2012 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::midPointAndFaceSet
28
29Description
30
31SourceFiles
32 midPointAndFaceSet.C
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef midPointAndFaceSet_H
37#define midPointAndFaceSet_H
38
39#include "faceOnlySet.H"
40
41// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43namespace Foam
44{
45
46// Forward declarations
47class meshSearch;
48
49/*---------------------------------------------------------------------------*\
50 Class midPointAndFaceSet Declaration
51\*---------------------------------------------------------------------------*/
54:
55 public faceOnlySet
56{
57
58 // Private Member Functions
59
60 void genSamples();
61
62
63public:
64
65 //- Runtime type information
66 TypeName("midPointAndFace");
67
68
69 // Constructors
70
71 //- Construct from components
73 (
74 const word& name,
75 const polyMesh& mesh,
77 const word& axis,
78 const point& start,
79 const point& end
80 );
81
82 //- Construct from dictionary
84 (
85 const word& name,
86 const polyMesh& mesh,
88 const dictionary& dict
89 );
90
91
92 //- Destructor
93 virtual ~midPointAndFaceSet() = default;
94};
95
96
97// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98
99} // End namespace Foam
100
101// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102
103#endif
104
105// ************************************************************************* //
const word & axis() const
The sort axis name.
Definition: coordSet.H:140
const word & name() const noexcept
The coord-set name.
Definition: coordSet.H:134
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Sample on faces along a specified path.
Definition: faceOnlySet.H:89
const point & start() const
Definition: faceOnlySet.H:173
const point & end() const
Definition: faceOnlySet.H:178
Various (local, not parallel) searches on polyMesh; uses (demand driven) octree to search.
Definition: meshSearch.H:61
TypeName("midPointAndFace")
Runtime type information.
virtual ~midPointAndFaceSet()=default
Destructor.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
const meshSearch & searchEngine() const noexcept
Definition: sampledSet.H:324
const polyMesh & mesh() const noexcept
Definition: sampledSet.H:319
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73