src/mesh/blockMesh/curvedEdges/BSpline.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::BSpline
  26
  27 Description
  28     An implementation of B-splines.
  29
  30     In this implementation, the end tangents are created automatically
  31     by reflection.
  32
  33     In matrix form, the \e local interpolation on the interval t=[0..1] is
  34     described as follows:
  35     \verbatim
  36     P(t) = 1/6 * [ t^3 t^2 t 1 ] * [ -1  3 -3  1 ] * [ P-1 ]
  37                                    [  3 -6  3  0 ]   [ P0 ]
  38                                    [ -3  0  3  0 ]   [ P1 ]
  39                                    [  1  4  1  0 ]   [ P2 ]
  40     \endverbatim
  41
  42     Where P-1 and P2 represent the neighbouring points or the extrapolated
  43     end points. Simple reflection is used to automatically create the end
  44     points.
  45
  46     The spline is discretized based on the chord length of the individual
  47     segments. In rare cases (sections with very high curvatures), the
  48     resulting distribution may be sub-optimal.
  49
  50     A future implementation could also handle closed splines.
  51
  52 SeeAlso
  53     CatmullRomSpline
  54
  55 SourceFiles
  56     BSpline.C
  57
  58 \*---------------------------------------------------------------------------*/
  59
  60 #ifndef BSpline_H
  61 #define BSpline_H
  62
  63 #include "polyLine.H"
  64
  65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  66
  67 namespace Foam
  68 {
  69
  70 /*---------------------------------------------------------------------------*\
  71                            Class BSpline Declaration
  72 \*---------------------------------------------------------------------------*/
  73
  74 class BSpline
  75 :
  76     public polyLine
  77 {
  78     // Private Member Functions
  79
  80         //- Disallow default bitwise copy construct
  81         BSpline(const BSpline&);
  82
  83         //- Disallow default bitwise assignment
  84         void operator=(const BSpline&);
  85
  86
  87 public:
  88
  89     // Constructors
  90
  91         //- Construct from components
  92         BSpline
  93         (
  94             const pointField& knots,
  95             const bool notImplementedClosed = false
  96         );
  97
  98
  99     // Member Functions
 100
 101         //- Return the point position corresponding to the curve parameter
 102         //  0 <= lambda <= 1
 103         point position(const scalar lambda) const;
 104
 105         //- Return the point position corresponding to the local parameter
 106         //  0 <= lambda <= 1 on the given segment
 107         point position(const label segment, const scalar lambda) const;
 108
 109         //- Return the length of the curve
 110         scalar length() const;
 111 };
 112
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 } // End namespace Foam
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 #endif
 121
 122 // ************************************************************************* //