All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
lineEdge.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-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::blockEdges::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 blockEdges_lineEdge_H
36 #define blockEdges_lineEdge_H
37 
38 #include "blockEdge.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace blockEdges
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class lineEdge Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 
52 class lineEdge
53 :
54  public blockEdge
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("line");
61 
62 
63  // Constructors
64 
65  //- Construct from components
66  lineEdge(const pointField&, const label start, const label end);
67 
68  //- Construct from Istream with a pointField
69  lineEdge
70  (
71  const dictionary& dict,
72  const label index,
73  const searchableSurfaces& geometry,
74  const pointField&,
75  Istream&
76  );
77 
78 
79  //- Destructor
80  virtual ~lineEdge();
81 
82 
83  // Member Functions
84 
85  //- Return the point position corresponding to the curve parameter
86  // 0 <= lambda <= 1
87  point position(const scalar) const;
88 
89  //- Return the length of the curve
90  scalar length() const;
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End of namespace blockEdges
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
dictionary dict
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 straight edge between the start point and the end point.
Definition: lineEdge.H:51
scalar length() const
Return the length of the curve.
Definition: lineEdge.C:88
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.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
Container for searchableSurfaces.
point position(const scalar) const
Return the point position corresponding to the curve parameter.
Definition: lineEdge.C:75
Define a curved edge that is parameterized for 0<lambda<1 between the start and end point...
Definition: blockEdge.H:56
virtual ~lineEdge()
Destructor.
Definition: lineEdge.C:69
lineEdge(const pointField &, const label start, const label end)
Construct from components.
Definition: lineEdge.C:44
TypeName("line")
Runtime type information.
Namespace for OpenFOAM.