projectVertex.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-2018 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::projectVertex
26 
27 Description
28  Projects the vertex onto the selected surfacees of the
29  geometry provided as a searchableSurfaces object.
30 
31 SourceFiles
32  projectVertex.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef blockVertices_projectVertex_H
37 #define blockVertices_projectVertex_H
38 
39 #include "pointVertex.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace blockVertices
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class projectVertex Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class projectVertex
53 :
54  public pointVertex
55 {
56  // Private data
57 
58  const searchableSurfaces& geometry_;
59 
60  //- The indices of surfaces onto which the points are projected
61  labelList surfaces_;
62 
63 
64  // Private Member Functions
65 
66  //- Disallow default bitwise copy construct
68 
69  //- Disallow default bitwise assignment
70  void operator=(const projectVertex&);
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("project");
77 
78 
79  // Constructors
80 
81  //- Construct from Istream setting pointsList
83  (
84  const dictionary&,
85  const label index,
86  const searchableSurfaces& geometry,
87  Istream&
88  );
89 
90 
91  //- Destructor
92  virtual ~projectVertex()
93  {}
94 
95 
96  // Member Functions
97 
98  //- Project the given points onto the surface
99  virtual operator point() const;
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace blockVertices
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~projectVertex()
Destructor.
Definition: projectVertex.H:91
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Projects the vertex onto the selected surfacees of the geometry provided as a searchableSurfaces obje...
Definition: projectVertex.H:51
TypeName("project")
Runtime type information.
Container for searchableSurfaces.
vector point
Point is a vector.
Definition: point.H:41
Namespace for OpenFOAM.