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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::localMin
  26
  27 Description
  28     LocalMin-mean differencing scheme class.
  29
  30     This scheme interpolates 1/field using a scheme specified at run-time
  31     and return the reciprocal of the interpolate.
  32
  33 SourceFiles
  34     localMin.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef localMin_H
  39 #define localMin_H
  40
  41 #include "surfaceInterpolationScheme.H"
  42 #include "volFields.H"
  43 #include "surfaceFields.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class localMin Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class Type>
  55 class localMin
  56 :
  57     public surfaceInterpolationScheme<Type>
  58 {
  59     // Private Member Functions
  60
  61         //- Disallow default bitwise assignment
  62         void operator=(const localMin&);
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("localMin");
  69
  70
  71     // Constructors
  72
  73         //- Construct from mesh
  74         localMin(const fvMesh& mesh)
  75         :
  76             surfaceInterpolationScheme<Type>(mesh)
  77         {}
  78
  79         //- Construct from Istream.
  80         //  The name of the flux field is read from the Istream and looked-up
  81         //  from the mesh objectRegistry
  82         localMin
  83         (
  84             const fvMesh& mesh,
  85             Istream& is
  86         )
  87         :
  88             surfaceInterpolationScheme<Type>(mesh)
  89         {}
  90
  91         //- Construct from faceFlux and Istream
  92         localMin
  93         (
  94             const fvMesh& mesh,
  95             const surfaceScalarField& faceFlux,
  96             Istream& is
  97         )
  98         :
  99             surfaceInterpolationScheme<Type>(mesh)
 100         {}
 101
 102
 103     // Member Functions
 104
 105         //- Return the interpolation weighting factors
 106         virtual tmp<surfaceScalarField> weights
 107         (
 108             const GeometricField<Type, fvPatchField, volMesh>&
 109         ) const
 110         {
 111             notImplemented
 112             (
 113                 "localMin::weights"
 114                 "(const GeometricField<Type, fvPatchField, volMesh>&)"
 115             );
 116
 117             return tmp<surfaceScalarField>(NULL);
 118         }
 119
 120         //- Return the face-interpolate of the given cell field
 121         virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 122         interpolate
 123         (
 124             const GeometricField<Type, fvPatchField, volMesh>& vf
 125         ) const
 126         {
 127             const fvMesh& mesh = vf.mesh();
 128
 129             tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > tvff
 130             (
 131                 new GeometricField<Type, fvsPatchField, surfaceMesh>
 132                 (
 133                     IOobject
 134                     (
 135                         "localMin::interpolate(" + vf.name() + ')',
 136                         mesh.time().timeName(),
 137                         mesh
 138                     ),
 139                     mesh,
 140                     vf.dimensions()
 141                 )
 142             );
 143             GeometricField<Type, fvsPatchField, surfaceMesh>& vff = tvff();
 144
 145             forAll(vff.boundaryField(), patchi)
 146             {
 147                 vff.boundaryField()[patchi] = vf.boundaryField()[patchi];
 148             }
 149
 150             const labelUList& own = mesh.owner();
 151             const labelUList& nei = mesh.neighbour();
 152
 153             forAll(vff, facei)
 154             {
 155                 vff[facei] = minMod(vf[own[facei]], vf[nei[facei]]);
 156             }
 157
 158             return tvff;
 159         }
 160 };
 161
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 } // End namespace Foam
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 #endif
 170
 171 // ************************************************************************* //