FreeFOAM The Cross-Platform CFD Toolkit
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) 1991-2010 OpenCFD Ltd.
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  // Private Member Functions
55 
56  //- Disallow default bitwise copy construct
57  lineEdge(const lineEdge&);
58 
59  //- Disallow default bitwise assignment
60  void operator=(const lineEdge&);
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("line");
66 
67  // Constructors
68 
69  //- Construct from components
70  lineEdge(const pointField&, const label start, const label end);
71 
72  //- Construct from Istream with a pointField
73  lineEdge(const pointField&, Istream&);
74 
75 
76  //- Destructor
77  virtual ~lineEdge();
78 
79 
80  // Member Functions
81 
82  //- Return the point position corresponding to the curve parameter
83  // 0 <= lambda <= 1
84  point position(const scalar) const;
85 
86  //- Return the length of the curve
87  scalar length() const;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************ vim: set sw=4 sts=4 et: ************************ //