namedVertex.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2016-2020 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::blockVertices::namedVertex
26 
27 Description
28  Gives name to a vertex.
29 
30 SourceFiles
31  namedVertex.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef blockVertices_namedVertex_H
36 #define blockVertices_namedVertex_H
37 
38 #include "blockVertex.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace blockVertices
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class namedVertex Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class namedVertex
52 :
53  public blockVertex
54 {
55 protected:
56 
57  // Protected member data
58 
59  //- The dictionary variable name for the vertex number
60  word name_;
61 
62  //- The vertex location
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("name");
70 
71 
72  // Constructors
73 
74  //- Construct from Istream setting pointsList
76  (
77  const dictionary&,
78  const label index,
79  const searchableSurfaces& geometry,
80  Istream&
81  );
82 
83 
84  //- Destructor
85  virtual ~namedVertex()
86  {}
87 
88 
89  // Member Functions
90 
91  virtual operator point() const;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace blockVertices
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
virtual ~namedVertex()
Destructor.
Definition: namedVertex.H:84
autoPtr< blockVertex > vertexPtr_
The vertex location.
Definition: namedVertex.H:62
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
TypeName("name")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:59
namedVertex(const dictionary &, const label index, const searchableSurfaces &geometry, Istream &)
Construct from Istream setting pointsList.
Definition: namedVertex.C:44
Container for searchableSurfaces.
Gives name to a vertex.
Definition: namedVertex.H:50
word name_
The dictionary variable name for the vertex number.
Definition: namedVertex.H:59
Define a block vertex.
Definition: blockVertex.H:48
vector point
Point is a vector.
Definition: point.H:41
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Namespace for OpenFOAM.