lineEdge.H 2.91 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
9
    Copyright (C) 2011-2016 OpenFOAM Foundation
    Copyright (C) 2019 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
56
\*---------------------------------------------------------------------------*/


class lineEdge
:
57
    public blockEdge
58
{
59

60
61
62
63
64
public:

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

65

66
67
68
    // Constructors

        //- Construct from components
Mark Olesen's avatar
Mark Olesen committed
69
        lineEdge(const pointField&, const label start, const label end);
70

71
        //- Construct from Istream with a pointField
72
73
        lineEdge
        (
74
75
            const dictionary& dict,
            const label index,
76
77
            const searchableSurfaces& geometry,
            const pointField&,
78
            Istream& is
79
        );
80
81


82
    //- Destructor
83
    virtual ~lineEdge() = default;
84
85
86
87


    // Member Functions

88
89
90
        //- Return the point position corresponding to the curve parameter
        //  0 <= lambda <= 1
        point position(const scalar) const;
91
92
93
94
95
96
97
98

        //- Return the length of the curve
        scalar length() const;
};


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

99
} // End namespace blockEdges
100
101
102
103
104
105
106
} // End namespace Foam

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

#endif

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