applications/utilities/mesh/generation/blockMesh/curvedEdges/polyLine.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::polyLine
  27
  28 Description
  29     polyLine class : defines a curvedEdge in terms of a series of straight
  30     line segments. This is the basic polyLine class which implements
  31    just the line (no topology : its not derived from curvedEdge)
  32
  33 SourceFiles
  34     polyLine.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef polyLine_H
  39 #define polyLine_H
  40
  41 #include "pointField.H"
  42 #include "scalarList.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class polyLine Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53
  54 class polyLine
  55 {
  56
  57 protected:
  58
  59     // Protected data
  60
  61         pointField controlPoints_;
  62         scalarList distances_;
  63         scalar lineLength_;
  64
  65     // Protected member functions
  66
  67         void calcDistances();
  68
  69
  70 public:
  71
  72     // Constructors
  73
  74         //- Construct from components
  75         polyLine(const pointField& ps);
  76
  77
  78     // Member Functions
  79
  80         //- Return the position of a point on the curve given by
  81         //  the parameter 0 <= lambda <= 1
  82         vector position(const scalar) const;
  83
  84         //- Return the length of the curve
  85         scalar length() const;
  86 };
  87
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 } // End namespace Foam
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 #endif
  96
  97 // ************************************************************************* //