lineEdge.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 "lineEdge.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace blockEdges
37 {
38  defineTypeNameAndDebug(lineEdge, 0);
39  addToRunTimeSelectionTable(blockEdge, lineEdge, Istream);
40 }
41 }
42 
43 
44 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
45 
47 (
48  const pointField& points,
49  const edge& fromTo
50 )
51 :
52  blockEdge(points, fromTo)
53 {}
54 
55 
57 (
58  const pointField& points,
59  const label from,
60  const label to
61 )
62 :
63  blockEdge(points, from, to)
64 {}
65 
66 
68 (
69  const dictionary& dict,
70  const label index,
71  const searchableSurfaces&,
72  const pointField& points,
73  Istream& is
74 )
75 :
76  blockEdge(dict, index, points, is)
77 {}
78 
79 
80 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
81 
83 {
85 }
86 
87 
88 Foam::scalar Foam::blockEdges::lineEdge::length() const
89 {
90  return Foam::mag(lastPoint() - firstPoint());
91 }
92 
93 
94 // ************************************************************************* //
dictionary dict
scalar length() const
The length of the curve.
Definition: lineEdge.C:81
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
lineEdge(const pointField &points, const edge &fromTo)
Construct from components.
Definition: lineEdge.C:40
point linearPosition(const scalar lambda) const
The point position in the straight line.
Definition: blockEdgeI.H:81
Macros for easy insertion into run-time selection tables.
const pointField & points
An edge is a list of two vertex labels. This can correspond to a directed graph edge or an edge on a ...
Definition: edge.H:59
dimensionedScalar lambda("lambda", dimTime/sqr(dimLength), laminarTransport)
Container for searchableSurfaces. The collection is specified as a dictionary. For example...
A Vector of values with scalar precision, where scalar is float/double depending on the compilation f...
point position(const scalar) const
The point position corresponding to the curve parameter.
Definition: lineEdge.C:75
defineTypeNameAndDebug(arcEdge, 0)
addToRunTimeSelectionTable(blockEdge, arcEdge, Istream)
Define a curved edge that is parameterized for 0<lambda<1 between the start/end points.
Definition: blockEdge.H:60
Namespace for OpenFOAM.