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