polyLineEdge.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 | Copyright (C) 2011 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::polyLineEdge
26 
27 Description
28  A curvedEdge defined in terms of a series of straight line segments.
29 
30 SourceFiles
31  polyLineEdge.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef polyLineEdge_H
36 #define polyLineEdge_H
37 
38 #include "curvedEdge.H"
39 #include "polyLine.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class polyLineEdge Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class polyLineEdge
51 :
52  public curvedEdge,
53  public polyLine
54 {
55  // Private Member Functions
56 
57  //- Disallow default bitwise copy construct
58  polyLineEdge(const polyLineEdge&);
59 
60  //- Disallow default bitwise assignment
61  void operator=(const polyLineEdge&);
62 
63 
64 public:
65 
66  // Static data members
67  TypeName("polyLine");
68 
69 
70  // Constructors
71 
72  //- Construct from components
74  (
75  const pointField&,
76  const label start,
77  const label end,
78  const pointField& otherPoints
79  );
80 
81  //- Construct from Istream
83 
84 
85  //- Destructor
86  virtual ~polyLineEdge();
87 
88 
89  // Member Functions
90 
91  //- Return the point position corresponding to the curve parameter
92  // 0 <= lambda <= 1
93  point position(const scalar lambda) const;
94 
95  //- Return the length of the curve
96  scalar length() const;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
scalar length() const
Return the length of the curve.
Definition: polyLineEdge.C:75
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
TypeName("polyLine")
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
virtual ~polyLineEdge()
Destructor.
Definition: polyLineEdge.C:63
A curvedEdge defined in terms of a series of straight line segments.
Definition: polyLineEdge.H:49
A series of straight line segments, which can also be interpreted as a series of control points for s...
Definition: polyLine.H:53
label end() const
Return label of end point.
Definition: curvedEdgeI.H:34
dimensionedScalar lambda(laminarTransport.lookup("lambda"))
Define a curved edge that is parameterized for 0<lambda<1 between the start and end point...
Definition: curvedEdge.H:60
point position(const scalar lambda) const
Return the point position corresponding to the curve parameter.
Definition: polyLineEdge.C:69
Namespace for OpenFOAM.
label start() const
Return label of start point.
Definition: curvedEdgeI.H:28