src/finiteArea/interpolation/edgeInterpolation/edgeInterpolate.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 Namespace
  26     fac
  27
  28 Description
  29
  30 SourceFiles
  31     edgeInterpolate.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef edgeInterpolate_H
  36 #define edgeInterpolate_H
  37
  38 #include "tmp.H"
  39 #include "areaFieldsFwd.H"
  40 #include "edgeFieldsFwd.H"
  41 #include "edgeInterpolationScheme.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                      Namespace fa functions Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 namespace fac
  53 {
  54     //- Return weighting factors for scheme given from Istream
  55     template<class Type>
  56     static tmp<edgeInterpolationScheme<Type> > scheme
  57     (
  58         const edgeScalarField& faceFlux,
  59         Istream& schemeData
  60     );
  61
  62     //- Return weighting factors for scheme given by name in dictionary
  63     template<class Type>
  64     static tmp<edgeInterpolationScheme<Type> > scheme
  65     (
  66         const edgeScalarField& faceFlux,
  67         const word& name
  68     );
  69
  70
  71     //- Return weighting factors for scheme given from Istream
  72     template<class Type>
  73     static tmp<edgeInterpolationScheme<Type> > scheme
  74     (
  75         const faMesh& mesh,
  76         Istream& schemeData
  77     );
  78
  79     //- Return weighting factors for scheme given by name in dictionary
  80     template<class Type>
  81     static tmp<edgeInterpolationScheme<Type> > scheme
  82     (
  83         const faMesh& mesh,
  84         const word& name
  85     );
  86
  87
  88     //- Interpolate field onto faces using scheme given by Istream
  89     template<class Type>
  90     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
  91     (
  92         const GeometricField<Type, faPatchField, areaMesh>& tvf,
  93         const edgeScalarField& faceFlux,
  94         Istream& schemeData
  95     );
  96
  97     //- Interpolate field onto faces using scheme given by name in faSchemes
  98     template<class Type>
  99     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 100     (
 101         const GeometricField<Type, faPatchField, areaMesh>& tvf,
 102         const edgeScalarField& faceFlux,
 103         const word& name
 104     );
 105
 106     //- Interpolate field onto faces using scheme given by name in faSchemes
 107     template<class Type>
 108     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 109     (
 110         const tmp<GeometricField<Type, faPatchField, areaMesh> >& tvf,
 111         const edgeScalarField& faceFlux,
 112         const word& name
 113     );
 114
 115     //- Interpolate field onto faces using scheme given by name in faSchemes
 116     template<class Type>
 117     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 118     (
 119         const GeometricField<Type, faPatchField, areaMesh>& tvf,
 120         const tmp<edgeScalarField>& faceFlux,
 121         const word& name
 122     );
 123
 124     //- Interpolate field onto faces using scheme given by name in faSchemes
 125     template<class Type>
 126     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 127     (
 128         const tmp<GeometricField<Type, faPatchField, areaMesh> >& tvf,
 129         const tmp<edgeScalarField>& faceFlux,
 130         const word& name
 131     );
 132
 133
 134     //- Interpolate field onto faces using scheme given by Istream
 135     template<class Type>
 136     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 137     (
 138         const GeometricField<Type, faPatchField, areaMesh>& tvf,
 139         Istream& schemeData
 140     );
 141
 142     //- Interpolate field onto faces using scheme given by name in faSchemes
 143     template<class Type>
 144     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 145     (
 146         const GeometricField<Type, faPatchField, areaMesh>& tvf,
 147         const word& name
 148     );
 149
 150     //- Interpolate field onto faces using scheme given by name in faSchemes
 151     template<class Type>
 152     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 153     (
 154         const tmp<GeometricField<Type, faPatchField, areaMesh> >& tvf,
 155         const word& name
 156     );
 157
 158
 159     //- Interpolate tmp field onto faces using central differencing
 160     template<class Type>
 161     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 162     (
 163         const tmp<GeometricField<Type, faPatchField, areaMesh> >& tvf
 164     );
 165
 166     //- Interpolate field onto faces using central differencing
 167     template<class Type>
 168     static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate
 169     (
 170         const GeometricField<Type, faPatchField, areaMesh>& tvf
 171     );
 172 }
 173
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 } // End namespace Foam
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #ifdef NoRepository
 182 #   include "edgeInterpolate.C"
 183 #endif
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 #endif
 188
 189 // ************************************************************************* //