splineEdge.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 "splineEdge.H"
30 #include "polyLine.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace blockEdges
38 {
39  defineTypeNameAndDebug(splineEdge, 0);
40 
42  (
43  blockEdge,
44  splineEdge,
45  Istream
46  );
47 }
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
53 Foam::blockEdges::splineEdge::splineEdge
54 (
55  const pointField& points,
56  const edge& fromTo,
57  const pointField& internalPoints
58 )
59 :
60  blockEdge(points, fromTo),
62  (
63  polyLine::concat(firstPoint(), internalPoints, lastPoint())
64  )
65 {}
66 
67 
68 Foam::blockEdges::splineEdge::splineEdge
69 (
70  const pointField& points,
71  const label from,
72  const label to,
73  const pointField& internalPoints
74 )
75 :
76  splineEdge(points, edge(from,to), internalPoints)
77 {}
78 
79 
80 Foam::blockEdges::splineEdge::splineEdge
81 (
82  const dictionary& dict,
83  const label index,
84  const searchableSurfaces&,
85  const pointField& points,
86  Istream& is
87 )
88 :
89  blockEdge(dict, index, points, is),
91  (
92  polyLine::concat(firstPoint(), pointField(is), lastPoint())
93  )
94 {
95  token tok(is);
96  is.putBack(tok);
97 
98  // Discard unused start/end tangents
99  if (tok == token::BEGIN_LIST)
100  {
101  vector tangent0Ignored(is);
102  vector tangent1Ignored(is);
103  }
104 }
105 
106 
107 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
108 
110 {
112 }
113 
114 
116 {
117  return CatmullRomSpline::length();
118 }
119 
120 
121 // ************************************************************************* //
Foam::pointField
vectorField pointField
pointField is a vectorField.
Definition: pointFieldFwd.H:44
Foam::constant::physicoChemical::mu
const dimensionedScalar mu
Atomic mass unit.
Definition: createFieldRefs.H:4
splineEdge.H
polyLine.H
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::token
A token holds an item read from Istream.
Definition: token.H:68
Foam::CatmullRomSpline
An implementation of Catmull-Rom splines (sometimes known as Overhauser splines).
Definition: CatmullRomSpline.H:78
Foam::blockEdge
Define a curved edge that is parameterized for 0<lambda<1 between the start/end points.
Definition: blockEdge.H:63
Foam::CatmullRomSpline::position
point position(const scalar lambda) const
The point position corresponding to the curve parameter.
Definition: CatmullRomSpline.C:94
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
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
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::blockEdges::splineEdge
A blockEdge interface for Catmull-Rom splines.
Definition: splineEdge.H:58
Foam::blockEdges::splineEdge::length
virtual scalar length() const
The length of the spline curve.
Definition: splineEdge.C:115
Foam::Vector< scalar >
Foam::Istream::putBack
void putBack(const token &tok)
Put back a token. Only a single put back is permitted.
Definition: Istream.C:70
Foam::searchableSurfaces
Container for searchableSurfaces. The collection is specified as a dictionary. For example,...
Definition: searchableSurfaces.H:92
points
const pointField & points
Definition: gmvOutputHeader.H:1
Foam::blockEdges::splineEdge::position
virtual point position(const scalar) const
The point position corresponding to the curve parameter.
Definition: splineEdge.C:109
Foam::CatmullRomSpline::length
scalar length() const
The length of the curve.
Definition: CatmullRomSpline.C:184