pointVertex.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) 2016 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::blockVertices::pointVertex
29 
30 Description
31 
32 SourceFiles
33  pointVertex.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef blockVertices_pointVertex_H
38 #define blockVertices_pointVertex_H
39 
40 #include "blockVertex.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace blockVertices
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class pointVertex Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class pointVertex
54 :
55  public blockVertex
56 {
57 protected:
58 
59  // Protected member data
60 
61  //- The vertex location
62  point vertex_;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("point");
69 
70 
71  // Constructors
72 
73  //- Construct from Istream setting pointsList
75  (
76  const dictionary& dict,
77  const label index,
78  const searchableSurfaces& geometry,
79  Istream& is
80  );
81 
82 
83  //- Destructor
84  virtual ~pointVertex() = default;
85 
86 
87  // Member Functions
88 
89  virtual operator point() const;
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace blockVertices
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Foam::blockVertices::pointVertex::TypeName
TypeName("point")
Runtime type information.
Foam::blockVertices::pointVertex::vertex_
point vertex_
The vertex location.
Definition: pointVertex.H:61
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::blockVertex
Define a block vertex.
Definition: blockVertex.H:51
dict
dictionary dict
Definition: searchingEngine.H:14
blockVertex.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::blockVertices::pointVertex::pointVertex
pointVertex(const dictionary &dict, const label index, const searchableSurfaces &geometry, Istream &is)
Construct from Istream setting pointsList.
Definition: pointVertex.C:46
Foam::Vector< scalar >
Foam::searchableSurfaces
Container for searchableSurfaces. The collection is specified as a dictionary. For example,...
Definition: searchableSurfaces.H:92
Foam::blockVertices::pointVertex::~pointVertex
virtual ~pointVertex()=default
Destructor.
Foam::point
vector point
Point is a vector.
Definition: point.H:43
Foam::blockVertices::pointVertex
Definition: pointVertex.H:52