projectEdge.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-2020 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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
27Class
28 Foam::blockEdges::projectEdge
29
30Description
31 Defines the edge from the projection onto a surface (single surface)
32 or intersection of two surfaces.
33
34SourceFiles
35 projectEdge.C
36
37\*---------------------------------------------------------------------------*/
38
39#ifndef blockEdges_projectEdge_H
40#define blockEdges_projectEdge_H
41
42#include "blockEdge.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48
49// Forward Declarations
50class pointConstraint;
51
52namespace blockEdges
53{
54
55/*---------------------------------------------------------------------------*\
56 Class projectEdge Declaration
57\*---------------------------------------------------------------------------*/
59class projectEdge
60:
61 public blockEdge
62{
63 // Private Data
64
65 const searchableSurfaces& geometry_;
66
67 //- The indices of surfaces onto which the points are projected
68 labelList surfaces_;
69
70
71 // Private Member Functions
72
73 //- Single point find nearest
74 void findNearest(const point&, point& near, pointConstraint&) const;
75
76 //- No copy construct
77 projectEdge(const projectEdge&) = delete;
78
79 //- No copy assignment
80 void operator=(const projectEdge&) = delete;
81
82
83public:
84
85 //- Runtime type information
86 TypeName("project");
87
88
89 // Constructors
90
91 //- Construct from Istream and point field.
93 (
94 const dictionary& dict,
95 const label index,
96 const searchableSurfaces& geometry,
97 const pointField& points,
98 Istream& is
99 );
100
101
102 //- Destructor
103 virtual ~projectEdge() = default;
104
105
106 // Member Functions
107
108 //- The point position corresponding to the curve parameter
109 // 0 <= lambda <= 1
110 virtual point position(const scalar) const;
111
112 //- The point positions corresponding to the curve parameters
113 // 0 <= lambda <= 1
114 virtual tmp<pointField> position(const scalarList&) const;
115
116 //- The length of the edge
117 // \note NotImplemented
118 virtual scalar length() const;
119};
120
121
122// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123
124} // End namespace blockEdges
125} // End namespace Foam
126
127// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128
129#endif
130
131// ************************************************************************* //
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:64
Define a curved edge that is parameterized for 0<lambda<1 between the start/end points.
Definition: blockEdge.H:64
Defines the edge from the projection onto a surface (single surface) or intersection of two surfaces.
Definition: projectEdge.H:61
TypeName("project")
Runtime type information.
virtual scalar length() const
The length of the edge.
Definition: projectEdge.C:273
virtual ~projectEdge()=default
Destructor.
virtual point position(const scalar) const
The point position corresponding to the curve parameter.
Definition: projectEdge.C:115
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Accumulates point constraints through successive applications of the applyConstraint function.
Container for searchableSurfaces. The collection is specified as a dictionary. For example,...
A class for managing temporary objects.
Definition: tmp.H:65
const pointField & points
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73