applications/utilities/mesh/generation/blockMesh/curvedEdges/lineEdge.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::lineEdge
  27
  28 Description
  29     lineEdge class : defines a straight line between the start point and the
  30     end point
  31
  32 SourceFiles
  33     lineEdge.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef lineEdge_H
  38 #define lineEdge_H
  39
  40 #include "curvedEdge.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class lineEdge Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51
  52 class lineEdge
  53 :
  54     public curvedEdge
  55 {
  56     // Private data
  57
  58         vector startPoint_;
  59         vector direction_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("line");
  66
  67     // Constructors
  68
  69         //- Construct from components
  70         lineEdge(const pointField& points, const label start, const label end);
  71
  72         //- Construct from Istream setting pointsList
  73         lineEdge(const pointField& points, Istream&);
  74
  75
  76     // Destructor
  77
  78         virtual ~lineEdge(){}
  79
  80
  81     // Member Functions
  82
  83         //- Return the position of a point on the curve given by
  84         //  the parameter 0 <= lambda <= 1
  85         vector position(const scalar) const;
  86
  87         //- Return the length of the curve
  88         scalar length() const;
  89 };
  90
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 } // End namespace Foam
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #endif
  99
 100 // ************************************************************************* //