src/finiteVolume/interpolation/surfaceInterpolation/schemes/harmonic/harmonic.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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::harmonic
  27
  28 Description
  29     Harmonic-mean differencing scheme class.
  30
  31     This scheme interpolates 1/field using a scheme specified at run-time
  32     and return the reciprocal of the interpolate.
  33
  34 SourceFiles
  35     harmonic.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef harmonic_H
  40 #define harmonic_H
  41
  42 #include "surfaceInterpolationScheme.H"
  43 #include "volFields.H"
  44 #include "surfaceFields.H"
  45 #include "reverseLinear.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class harmonic Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class harmonic
  57 :
  58     public surfaceInterpolationScheme<scalar>
  59 {
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise assignment
  63         void operator=(const harmonic&);
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("harmonic");
  70
  71
  72     // Constructors
  73
  74         //- Construct from mesh
  75         harmonic(const fvMesh& mesh)
  76         :
  77             surfaceInterpolationScheme<scalar>(mesh)
  78         {}
  79
  80         //- Construct from Istream.
  81         //  The name of the flux field is read from the Istream and looked-up
  82         //  from the mesh objectRegistry
  83         harmonic
  84         (
  85             const fvMesh& mesh,
  86             Istream& is
  87         )
  88         :
  89             surfaceInterpolationScheme<scalar>(mesh)
  90         {}
  91
  92         //- Construct from faceFlux and Istream
  93         harmonic
  94         (
  95             const fvMesh& mesh,
  96             const surfaceScalarField& faceFlux,
  97             Istream& is
  98         )
  99         :
 100             surfaceInterpolationScheme<scalar>(mesh)
 101         {}
 102
 103
 104     // Member Functions
 105
 106         //- Return the interpolation weighting factors
 107         virtual tmp<surfaceScalarField> weights
 108         (
 109             const GeometricField<scalar, fvPatchField, volMesh>&
 110         ) const
 111         {
 112             notImplemented
 113             (
 114                 "harmonic::weights"
 115                 "(const GeometricField<scalar, fvPatchField, volMesh>&)"
 116             );
 117
 118             return tmp<surfaceScalarField>(NULL);
 119         }
 120
 121         //- Return the face-interpolate of the given cell field
 122         virtual tmp<GeometricField<scalar, fvsPatchField, surfaceMesh> >
 123         interpolate
 124         (
 125             const GeometricField<scalar, fvPatchField, volMesh>& vf
 126         ) const
 127         {
 128             return 1.0/(reverseLinear<scalar>(vf.mesh()).interpolate(1.0/vf));
 129         }
 130 };
 131
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 } // End namespace Foam
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 #endif
 140
 141 // ************************************************************************* //