polyLineEdge.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) 2011-2019 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::blockEdges::polyLineEdge
26 
27 Description
28  A blockEdge defined in terms of a series of straight line segments.
29 
30 SourceFiles
31  polyLineEdge.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef blockEdges_polyLineEdge_H
36 #define blockEdges_polyLineEdge_H
37 
38 #include "blockEdge.H"
39 #include "polyLine.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace blockEdges
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class polyLineEdge Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class polyLineEdge
53 :
54  public blockEdge,
55  public polyLine
56 {
57 public:
58 
59  // Static Data Members
60  TypeName("polyLine");
61 
62 
63  // Constructors
64 
65  //- Construct from components
67  (
68  const pointField&,
69  const label start,
70  const label end,
71  const pointField& otherPoints
72  );
73 
74  //- Construct from Istream
76  (
77  const dictionary& dict,
78  const label index,
79  const searchableSurfaces& geometry,
80  const pointField&,
81  Istream&
82  );
83 
84  //- Disallow default bitwise copy construction
85  polyLineEdge(const polyLineEdge&) = delete;
86 
87 
88  //- Destructor
89  virtual ~polyLineEdge();
90 
91 
92  // Member Functions
93 
94  //- Return the point position corresponding to the curve parameter
95  // 0 <= lambda <= 1
96  point position(const scalar lambda) const;
97 
98  //- Return the length of the curve
99  scalar length() const;
100 
101 
102  // Member Operators
103 
104  //- Disallow default bitwise assignment
105  void operator=(const polyLineEdge&) = delete;
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End of namespace blockEdges
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
Define a curved edge that is parameterised for 0<lambda<1 between the start and end point.
Definition: blockEdge.H:57
label end() const
Return label of end point.
Definition: blockEdgeI.H:34
label start() const
Return label of start point.
Definition: blockEdgeI.H:28
A blockEdge defined in terms of a series of straight line segments.
Definition: polyLineEdge.H:55
scalar length() const
Return the length of the curve.
Definition: polyLineEdge.C:84
polyLineEdge(const pointField &, const label start, const label end, const pointField &otherPoints)
Construct from components.
Definition: polyLineEdge.C:44
void operator=(const polyLineEdge &)=delete
Disallow default bitwise assignment.
virtual ~polyLineEdge()
Destructor.
Definition: polyLineEdge.C:72
point position(const scalar lambda) const
Return the point position corresponding to the curve parameter.
Definition: polyLineEdge.C:78
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
A series of straight line segments, which can also be interpreted as a series of control points for s...
Definition: polyLine.H:54
Container for searchableSurfaces.
dimensionedScalar lambda(viscosity->lookup("lambda"))
Namespace for OpenFOAM.
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
dictionary dict