lineEdge.H 3.12 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
OpenFOAM bot's avatar
OpenFOAM bot committed
5
    \\  /    A nd           | www.openfoam.com
6
     \\/     M anipulation  |
OpenFOAM bot's avatar
OpenFOAM bot committed
7
-------------------------------------------------------------------------------
OpenFOAM bot's avatar
OpenFOAM bot committed
8
    Copyright (C) 2011-2016 OpenFOAM Foundation
9
    Copyright (C) 2019-2020 OpenCFD Ltd.
10
11
12
13
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

14
15
16
17
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
18
19
20
21
22
23
24

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    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

Class
28
    Foam::blockEdges::lineEdge
29
30

Description
31
    A straight edge between the start point and the end point.
32
33
34
35
36
37

SourceFiles
    lineEdge.C

\*---------------------------------------------------------------------------*/

38
39
#ifndef blockEdges_lineEdge_H
#define blockEdges_lineEdge_H
40

41
#include "blockEdge.H"
42
43
44
45
46

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{
47
48
namespace blockEdges
{
49
50

/*---------------------------------------------------------------------------*\
51
                          Class lineEdge Declaration
52
53
54
55
\*---------------------------------------------------------------------------*/

class lineEdge
:
56
    public blockEdge
57
58
59
60
61
62
{
public:

    //- Runtime type information
    TypeName("line");

63

64
65
66
    // Constructors

        //- Construct from components
67
68
69
70
71
72
        lineEdge
        (
            const pointField& points,   //!< Referenced point field
            const label start,      //!< Start point in referenced point field
            const label end         //!< End point in referenced point field
        );
73

74
        //- Construct from Istream and point field.
75
76
        lineEdge
        (
77
78
            const dictionary& dict,
            const label index,
79
            const searchableSurfaces& geometry,
80
            const pointField& points,   //!< Referenced point field
81
            Istream& is
82
        );
83
84


85
    //- Destructor
86
    virtual ~lineEdge() = default;
87
88
89
90


    // Member Functions

91
        //- The point position corresponding to the curve parameter
92
93
        //  0 <= lambda <= 1
        point position(const scalar) const;
94

95
        //- The length of the curve
96
97
98
99
100
101
        scalar length() const;
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

102
} // End namespace blockEdges
103
104
105
106
107
108
109
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //