src/mesh/cfMesh/meshLibrary/utilities/helperClasses/geometry/quadricFitting/quadricFitting.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | cfMesh: A library for mesh generation
   4    \\    /   O peration     |
   5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
   6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of cfMesh.
  10
  11     cfMesh 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     cfMesh 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 cfMesh.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     quadricFitting
  26
  27 Description
  28     A class for fitting a quadric surface through the set of points. It is
  29     useful for curvature estimation and for calculating normals.
  30
  31 SourceFiles
  32     quadricFittingI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef quadricFitting_H
  37 #define quadricFitting_H
  38
  39 #include "DynList.H"
  40 #include "plane.H"
  41 #include "simpleMatrix.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                         class quadricFitting Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class quadricFitting
  53 {
  54     // Private data
  55         //- seed point for fitting the quadric surface
  56         point origin_;
  57
  58         //- normal vector at the origin
  59         vector normal_;
  60
  61         //- x-coordinate vector for the transformed coordinate system
  62         vector vecX_;
  63
  64         //- y-coordinate vector for the transformed coordinate system
  65         vector vecY_;
  66
  67         //- other points
  68         DynList<point> otherPoints_;
  69
  70         //- transformed coordinates of other points
  71         DynList<point> transformedPoints_;
  72
  73         //- coefficients of the quadric surface
  74         scalarField coefficients_;
  75
  76     // Private member functions
  77         //- initial estimate of the normal vector
  78         void calculateNormalVector();
  79
  80         //- calculate transformed coordinate system
  81         void calculateCoordinateSystem();
  82
  83         //- calculate coefficients of the quadric surface fit
  84         void calculateQuadricCoeffs();
  85
  86         //- iterative procedure for updating normals
  87         //- until the best fit is achieved
  88         void calculateBestFit();
  89
  90 public:
  91
  92     // Constructors
  93
  94         //- Construct from point, normal, and neighbouring points
  95         template<class ListType>
  96         inline quadricFitting(const point&, const vector, const ListType&);
  97
  98         //- Construct from point and other points
  99         template<class ListType>
 100         inline quadricFitting(const point&, const ListType&);
 101
 102     // Destructor
 103         ~quadricFitting();
 104
 105
 106     // Member Functions
 107
 108         // Access
 109
 110             //- Return surface normal
 111             inline const vector& normal() const;
 112
 113             //- Return min curvature
 114             inline scalar minCurvature() const;
 115
 116             //- Return max curvature
 117             inline scalar maxCurvature() const;
 118
 119             //- Return mean curvature
 120             inline scalar meanCurvature() const;
 121
 122             //- Return Gaussian curvature
 123             inline scalar gaussianCurvature() const;
 124
 125             //- Return min curvature vector
 126             inline vector minCurvatureVector() const;
 127
 128             //- Return max curvature vector
 129             inline vector maxCurvatureVector() const;
 130 };
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 } // End namespace Foam
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #include "quadricFittingI.H"
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 #endif
 143
 144 // ************************************************************************* //