src/finiteVolume/interpolation/pointVolInterpolation/pointVolInterpolation.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     pointVolInterpolation
  26
  27 Description
  28
  29 SourceFiles
  30     pointVolInterpolation.C
  31     pointVolInterpolate.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef pointVolInterpolation_H
  36 #define pointVolInterpolation_H
  37
  38 #include "primitiveFieldsFwd.H"
  39 #include "primitivePatchInterpolation.H"
  40 #include "volFieldsFwd.H"
  41 #include "pointFieldsFwd.H"
  42 #include "scalarList.H"
  43 #include "tmp.H"
  44 #include "className.H"
  45 #include "FieldFields.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 class fvMesh;
  53 class pointMesh;
  54
  55 /*---------------------------------------------------------------------------*\
  56                       Class pointVolInterpolation Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class pointVolInterpolation
  60 {
  61     // Private data
  62
  63         const pointMesh& pointMesh_;
  64         const fvMesh& fvMesh_;
  65
  66         //- Interpolation scheme weighting factor array.
  67         mutable FieldField<Field, scalar>* volWeightsPtr_;
  68
  69         //- Primitive patch interpolators
  70         mutable PtrList<primitivePatchInterpolation>* patchInterpolatorsPtr_;
  71
  72
  73     // Private member functions
  74
  75         //- Return patch interpolators
  76         const PtrList<primitivePatchInterpolation>& patchInterpolators() const;
  77
  78         //- Construct point weighting factors
  79         void makeWeights() const;
  80
  81         //- Clear addressing
  82         void clearAddressing() const;
  83
  84         //- Clear geometry
  85         void clearGeom() const;
  86
  87
  88 protected:
  89
  90         const pointMesh& pMesh() const
  91         {
  92             return pointMesh_;
  93         }
  94
  95         const fvMesh& vMesh() const
  96         {
  97             return fvMesh_;
  98         }
  99
 100
 101 public:
 102
 103     // Declare name of the class and it's debug switch
 104     ClassName("pointVolInterpolation");
 105
 106
 107     // Constructors
 108
 109         //- Constructor given pointMesh and fvMesh.
 110         pointVolInterpolation(const pointMesh&, const fvMesh&);
 111
 112
 113     // Destructor
 114
 115         ~pointVolInterpolation();
 116
 117
 118     // Member functions
 119
 120         // Access
 121
 122             //- Return reference to weights arrays.
 123             //  This also constructs the weighting factors if neccessary.
 124             const FieldField<Field, scalar>& volWeights() const;
 125
 126
 127         // Edit
 128
 129             //- Update mesh topology using the morph engine
 130             void updateTopology();
 131
 132             //- Correct weighting factors for moving mesh.
 133             bool movePoints();
 134
 135
 136     // Interpolation functions
 137
 138         //- Interpolate from pointField to volField
 139         //  using inverse distance weighting
 140         template<class Type>
 141         void interpolate
 142         (
 143             const GeometricField<Type, pointPatchField, pointMesh>&,
 144             GeometricField<Type, fvPatchField, volMesh>&
 145         ) const;
 146
 147         //- Interpolate pointField returning volField
 148         //  using inverse distance weighting
 149         template<class Type>
 150         tmp<GeometricField<Type, fvPatchField, volMesh> > interpolate
 151         (
 152             const GeometricField<Type, pointPatchField, pointMesh>&
 153         ) const;
 154
 155         //- Interpolate tmp<pointField> returning volField
 156         //  using inverse distance weighting
 157         template<class Type>
 158         tmp<GeometricField<Type, fvPatchField, volMesh> > interpolate
 159         (
 160             const tmp<GeometricField<Type, pointPatchField, pointMesh> >&
 161         ) const;
 162 };
 163
 164
 165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 166
 167 } // End namespace Foam
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 #ifdef NoRepository
 172 #   include "pointVolInterpolate.C"
 173 #endif
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 #endif
 178
 179 // ************************************************************************* //