applications/utilities/mesh/generation/blockMesh/curvedEdges/spline.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::spline
  27
  28 Description
  29     spline class : define a basic spline on nKnots knots - this
  30     does not go anywhere near these knots (will act as a base type for
  31     various splines that will have real uses)
  32
  33 SourceFiles
  34     spline.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef spline_H
  39 #define spline_H
  40
  41 #include "pointField.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class spline Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class spline
  53 {
  54     // Private data
  55
  56         //- The knots defining the spline
  57         pointField knots_;
  58
  59
  60     // Private member functions
  61
  62         //- Blending function for constructing spline
  63         scalar B(const scalar&) const;
  64
  65
  66 public:
  67
  68     // Constructors
  69
  70         //- Construct from components
  71         spline(const pointField&);
  72
  73
  74     // Member Functions
  75
  76         // Access
  77
  78             //- Return the number of knots in the spline
  79             label nKnots() const
  80             {
  81                 return knots_.size();
  82             }
  83
  84
  85         //- Return the position of a point on the curve given by
  86         //  the parameter 0 <= lambda <= 1
  87         vector position(const scalar) const;
  88
  89         //- Return the length of the spline curve
  90         scalar length() const;
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //