lineEdge.H 2.7 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
6
7
8
9
10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    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.
15
16
17
18
19
20
21

    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
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
23
24

Class
25
    Foam::blockEdges::lineEdge
26
27

Description
28
    A straight edge between the start point and the end point.
29
30
31
32
33
34

SourceFiles
    lineEdge.C

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

35
36
#ifndef blockEdges_lineEdge_H
#define blockEdges_lineEdge_H
37

38
#include "blockEdge.H"
39
40
41
42
43

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

namespace Foam
{
44
45
namespace blockEdges
{
46
47

/*---------------------------------------------------------------------------*\
48
                          Class lineEdge Declaration
49
50
51
52
53
\*---------------------------------------------------------------------------*/


class lineEdge
:
54
    public blockEdge
55
{
56

57
58
59
60
61
public:

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

62

63
64
65
    // Constructors

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

68
        //- Construct from Istream with a pointField
69
70
71
72
73
74
        lineEdge
        (
            const searchableSurfaces& geometry,
            const pointField&,
            Istream&
        );
75
76


77
78
    //- Destructor
    virtual ~lineEdge();
79
80
81
82


    // Member Functions

83
84
85
        //- Return the point position corresponding to the curve parameter
        //  0 <= lambda <= 1
        point position(const scalar) const;
86
87
88
89
90
91
92
93

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


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

94
} // End of namespace blockEdges
95
96
97
98
99
100
101
} // End namespace Foam

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

#endif

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