lineEdge.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::lineEdge
26 
27 Description
28  A straight edge between the start point and the end point.
29 
30 SourceFiles
31  lineEdge.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef lineEdge_H
36 #define lineEdge_H
37 
38 #include "curvedEdge.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class lineEdge Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 
50 class lineEdge
51 :
52  public curvedEdge
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("line");
59 
60  // Constructors
61 
62  //- Construct from components
63  lineEdge(const pointField&, const label start, const label end);
64 
65  //- Construct from Istream with a pointField
66  lineEdge(const pointField&, Istream&);
67 
68 
69  //- Destructor
70  virtual ~lineEdge();
71 
72 
73  // Member Functions
74 
75  //- Return the point position corresponding to the curve parameter
76  // 0 <= lambda <= 1
77  point position(const scalar) const;
78 
79  //- Return the length of the curve
80  scalar length() const;
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
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
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A straight edge between the start point and the end point.
Definition: lineEdge.H:49
virtual ~lineEdge()
Destructor.
Definition: lineEdge.C:60
lineEdge(const pointField &, const label start, const label end)
Construct from components.
Definition: lineEdge.C:42
TypeName("line")
Runtime type information.
point position(const scalar) const
Return the point position corresponding to the curve parameter.
Definition: lineEdge.C:66
label end() const
Return label of end point.
Definition: curvedEdgeI.H:34
scalar length() const
Return the length of the curve.
Definition: lineEdge.C:79
Define a curved edge that is parameterized for 0<lambda<1 between the start and end point...
Definition: curvedEdge.H:60
Namespace for OpenFOAM.
label start() const
Return label of start point.
Definition: curvedEdgeI.H:28