src/foam/interpolations/RBFInterpolation/RBFInterpolation.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     RBFInterpolation
  26
  27 Description
  28     Radial basis function interpolation class
  29
  30 Description
  31     Interpolation class which uses Radial Basis Functions to interpolate
  32     field from given data points to arbitrary set of points.
  33
  34     The coefficient vectors, alpha and beta are determined by solving
  35     the system:
  36
  37     | db | = | Mbb Pb | | alpha |
  38     | 0  |   | Pb  0  | |  beta |
  39
  40     where db are the given field values at data carrier points.
  41     Mbb the boundary RBF correlation matrix (NbxNb), containing RBF evaluations
  42     at the boundary nodes, and Pb some linear polynomial matrix (Nbx4).
  43
  44     In cases where far field data is not of interest, a cutoff function
  45     is used to eliminate unnecessary data points in the far field
  46
  47 Author
  48     Frank Bos, TU Delft.  All rights reserved.
  49     Dubravko Matijasevic, FSB Zagreb.
  50     Reorganisation by Hrvoje Jasak, Wikki Ltd.
  51
  52 SourceFiles
  53     RBFInterpolation.C
  54     RBFInterpolationTemplates.C
  55
  56 \*---------------------------------------------------------------------------*/
  57
  58 #ifndef RBFInterpolation_H
  59 #define RBFInterpolation_H
  60
  61 #include "dictionary.H"
  62 #include "RBFFunction.H"
  63 #include "point.H"
  64 #include "Switch.H"
  65 #include "simpleMatrix.H"
  66
  67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  68
  69 namespace Foam
  70 {
  71
  72 /*---------------------------------------------------------------------------*\
  73                         Class RBFInterpolation Declaration
  74 \*---------------------------------------------------------------------------*/
  75
  76 class RBFInterpolation
  77 {
  78     // Private data
  79
  80         //- Reference to control points
  81         const vectorField& controlPoints_;
  82
  83         //- Reference to all points
  84         const vectorField& dataPoints_;
  85
  86         //- RBF function
  87         autoPtr<RBFFunction> RBF_;
  88
  89         //- Interpolation matrix
  90         mutable scalarSquareMatrix* BPtr_;
  91
  92         //- Focal point for cut-off radii
  93         point focalPoint_;
  94
  95         //- Inner cut-off radius
  96         scalar innerRadius_;
  97
  98         //- Outer cut-off radius
  99         scalar outerRadius_;
 100
 101         //- Add polynomials to RBF matrix
 102         Switch polynomials_;
 103
 104
 105     // Private Member Functions
 106
 107         //- Disallow default bitwise assignment
 108         void operator=(const RBFInterpolation&);
 109
 110
 111         //- Return interpolation matrix
 112         const scalarSquareMatrix& B() const;
 113
 114         //- Calculate interpolation matrix
 115         void calcB() const;
 116
 117         //- Clear out
 118         void clearOut();
 119
 120
 121 public:
 122
 123     // Constructors
 124
 125         //- Construct from components
 126         RBFInterpolation
 127         (
 128             const dictionary& dict,
 129             const vectorField& controlPoints,
 130             const vectorField& dataPoints
 131         );
 132
 133         //- Construct as copy
 134         RBFInterpolation(const RBFInterpolation&);
 135
 136
 137     // Destructor
 138
 139         ~RBFInterpolation();
 140
 141
 142     // Member Functions
 143
 144         //- Return reference to control points
 145         const vectorField& controlPoints() const
 146         {
 147             return controlPoints_;
 148         }
 149
 150         //- Reference to all points
 151         const vectorField& dataPoints() const
 152         {
 153             return dataPoints_;
 154         }
 155
 156         //- Interpolate
 157         template<class Type>
 158         tmp<Field<Type> > interpolate(const Field<Type>& ctrlField) const;
 159
 160         //- Move points
 161         void movePoints();
 162 };
 163
 164
 165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 166
 167 } // End namespace Foam
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 #ifdef NoRepository
 172 #   include "RBFInterpolationTemplates.C"
 173 #endif
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 #endif
 178
 179 // ************************************************************************* //