src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateSurfaceInterpolationScheme/multivariateSurfaceInterpolationScheme.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::multivariateSurfaceInterpolationScheme
  27
  28 Description
  29     Abstract base class for multi-variate surface interpolation schemes.
  30
  31 SourceFiles
  32     multivariateSurfaceInterpolationScheme.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef multivariateSurfaceInterpolationScheme_H
  37 #define multivariateSurfaceInterpolationScheme_H
  38
  39 #include "surfaceInterpolationScheme.H"
  40 #include "HashTable.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                  Class multivariateSurfaceInterpolationScheme Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class multivariateSurfaceInterpolationScheme
  53 :
  54     public refCount
  55 {
  56
  57 public:
  58
  59     //- fieldTable
  60     class fieldTable
  61     :
  62         public HashTable<const GeometricField<Type, fvPatchField, volMesh>*>
  63     {
  64     public:
  65
  66         fieldTable()
  67         {}
  68
  69         void add(const GeometricField<Type, fvPatchField, volMesh>& f)
  70         {
  71             insert(f.name(), &f);
  72         }
  73     };
  74
  75
  76 private:
  77
  78     // Private data
  79
  80         //- Hold reference to mesh
  81         const fvMesh& mesh_;
  82
  83         //- HashTable of pointers to the field set
  84         const fieldTable& fields_;
  85
  86
  87     // Private Member Functions
  88
  89         //- Disallow default bitwise copy construct
  90         multivariateSurfaceInterpolationScheme
  91         (
  92             const multivariateSurfaceInterpolationScheme&
  93         );
  94
  95         //- Disallow default bitwise assignment
  96         void operator=(const multivariateSurfaceInterpolationScheme&);
  97
  98
  99 public:
 100
 101     //- Runtime type information
 102     virtual const word& type() const = 0;
 103
 104
 105     // Declare run-time constructor selection tables
 106
 107         declareRunTimeSelectionTable
 108         (
 109             tmp,
 110             multivariateSurfaceInterpolationScheme,
 111             Istream,
 112             (
 113                 const fvMesh& mesh,
 114                 const fieldTable& fields,
 115                 const surfaceScalarField& faceFlux,
 116                 Istream& is
 117             ),
 118             (mesh, fields, faceFlux, is)
 119         );
 120
 121
 122     // Constructors
 123
 124         //- Construct for interpolating given field
 125         multivariateSurfaceInterpolationScheme
 126         (
 127             const fvMesh& mesh,
 128             const fieldTable& fields,
 129             const surfaceScalarField& faceFlux,
 130             Istream& schemeData
 131         );
 132
 133
 134     // Selectors
 135
 136         //- Return a pointer to a new gradScheme created on freestore
 137         static tmp<multivariateSurfaceInterpolationScheme<Type> > New
 138         (
 139             const fvMesh& mesh,
 140             const fieldTable& fields,
 141             const surfaceScalarField& faceFlux,
 142             Istream& schemeData
 143         );
 144
 145
 146     // Destructor
 147
 148         virtual ~multivariateSurfaceInterpolationScheme();
 149
 150
 151     // Member Functions
 152
 153         //- Return mesh reference
 154         const fvMesh& mesh() const
 155         {
 156             return mesh_;
 157         }
 158
 159         //- Return fields to be interpolated
 160         const fieldTable& fields() const
 161         {
 162             return fields_;
 163         }
 164
 165
 166     // Member Operators
 167
 168         //- surfaceInterpolationScheme sub-class returned by operator(field)
 169         //  which is used as the interpolation scheme for the field
 170         class fieldScheme
 171         :
 172             public surfaceInterpolationScheme<Type>
 173         {
 174
 175         public:
 176
 177             // Constructors
 178
 179                 fieldScheme
 180                 (
 181                     const GeometricField<Type, fvPatchField, volMesh>& field
 182                 )
 183                 :
 184                     surfaceInterpolationScheme<Type>(field.mesh())
 185                 {}
 186
 187
 188             // Member Functions
 189
 190                 //- Return the interpolation weighting factors
 191                 virtual tmp<surfaceScalarField> weights
 192                 (
 193                     const GeometricField<Type, fvPatchField, volMesh>& field
 194                 ) const = 0;
 195         };
 196
 197         virtual tmp<surfaceInterpolationScheme<Type> > operator()
 198         (
 199             const GeometricField<Type, fvPatchField, volMesh>& field
 200         ) const = 0;
 201 };
 202
 203
 204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 205
 206 } // End namespace Foam
 207
 208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 209
 210 // Add the patch constructor functions to the hash tables
 211
 212 #define makeMultivariateSurfaceInterpolationTypeScheme(SS, Type)               \
 213                                                                                \
 214 defineNamedTemplateTypeNameAndDebug(SS<Type>, 0);                              \
 215                                                                                \
 216 multivariateSurfaceInterpolationScheme<Type>::                                 \
 217 addIstreamConstructorToTable<SS<Type> >                                        \
 218     add##SS##Type##ConstructorToTable_;
 219
 220
 221 #define makeMultivariateSurfaceInterpolationScheme(SS)                         \
 222                                                                                \
 223 makeMultivariateSurfaceInterpolationTypeScheme(SS, scalar)                     \
 224 makeMultivariateSurfaceInterpolationTypeScheme(SS, vector)                     \
 225 makeMultivariateSurfaceInterpolationTypeScheme(SS, sphericalTensor)            \
 226 makeMultivariateSurfaceInterpolationTypeScheme(SS, symmTensor)                 \
 227 makeMultivariateSurfaceInterpolationTypeScheme(SS, tensor)
 228
 229
 230 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 231
 232 #ifdef NoRepository
 233 #   include "multivariateSurfaceInterpolationScheme.C"
 234 #endif
 235
 236 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 237
 238 #endif
 239
 240 // ************************************************************************* //