polyLineEdge.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9  Copyright (C) 2019-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "polyLineEdge.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace blockEdges
37 {
38  defineTypeNameAndDebug(polyLineEdge, 0);
39  addToRunTimeSelectionTable(blockEdge, polyLineEdge, Istream);
40 }
41 }
42 
43 
44 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
45 
46 Foam::blockEdges::polyLineEdge::polyLineEdge
47 (
48  const pointField& points,
49  const edge& fromTo,
50  const pointField& intermediate
51 )
52 :
53  blockEdge(points, fromTo),
54  polyLine(firstPoint(), intermediate, lastPoint())
55 {}
56 
57 
58 Foam::blockEdges::polyLineEdge::polyLineEdge
59 (
60  const pointField& points,
61  const label from,
62  const label to,
63  const pointField& intermediate
64 )
65 :
66  polyLineEdge(points, edge(from, to), intermediate)
67 {}
68 
69 
70 Foam::blockEdges::polyLineEdge::polyLineEdge
71 (
72  const dictionary& dict,
73  const label index,
74  const searchableSurfaces&,
75  const pointField& points,
76  Istream& is
77 )
78 :
79  blockEdge(dict, index, points, is),
80  polyLine(firstPoint(), pointField(is), lastPoint())
81 {}
82 
83 
84 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
85 
87 {
88  return polyLine::position(lambda);
89 }
90 
91 
93 {
94  return polyLine::lineLength_;
95 }
96 
97 
98 // ************************************************************************* //
Foam::polyLine
A series of straight line segments, which can also be interpreted as a series of control points for s...
Definition: polyLine.H:55
Foam::pointField
vectorField pointField
pointField is a vectorField.
Definition: pointFieldFwd.H:44
Foam::edge
An edge is a list of two point labels. The functionality it provides supports the discretisation on a...
Definition: edge.H:63
Foam::blockEdges::polyLineEdge::position
point position(const scalar lambda) const
The point position corresponding to the curve parameter.
Definition: polyLineEdge.C:86
Foam::blockEdge
Define a curved edge that is parameterized for 0<lambda<1 between the start/end points.
Definition: blockEdge.H:63
Foam::blockEdges::defineTypeNameAndDebug
defineTypeNameAndDebug(arcEdge, 0)
Foam::Field< vector >
Foam::blockEdges::addToRunTimeSelectionTable
addToRunTimeSelectionTable(blockEdge, arcEdge, Istream)
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::polyLine::position
point position(const scalar) const
The point position corresponding to the curve parameter.
Definition: polyLine.C:158
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
lambda
dimensionedScalar lambda("lambda", dimTime/sqr(dimLength), laminarTransport)
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
polyLineEdge.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::blockEdges::polyLineEdge::length
scalar length() const
The length of the curve.
Definition: polyLineEdge.C:92
Foam::blockEdges::polyLineEdge
A blockEdge defined in terms of a series of straight line segments.
Definition: polyLineEdge.H:54
Foam::Vector< scalar >
Foam::searchableSurfaces
Container for searchableSurfaces. The collection is specified as a dictionary. For example,...
Definition: searchableSurfaces.H:92
Foam::polyLine::lineLength_
scalar lineLength_
The real (total) line length.
Definition: polyLine.H:65
points
const pointField & points
Definition: gmvOutputHeader.H:1