src/finiteVolume/finiteVolume/fvc/fvcAverage.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 InNamespace
  26     Foam::fvc
  27
  28 Description
  29     Area-weighted average a surfaceField creating a volField
  30
  31 SourceFiles
  32     fvcAverage.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36
  37 #ifndef fvcAverage_H
  38 #define fvcAverage_H
  39
  40 #include "volFieldsFwd.H"
  41 #include "surfaceFieldsFwd.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                      Namespace fvc functions Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 namespace fvc
  53 {
  54     //- Area-weighted average a surfaceField creating a volField
  55     template<class Type>
  56     tmp<GeometricField<Type, fvPatchField, volMesh> > average
  57     (
  58         const GeometricField<Type, fvsPatchField, surfaceMesh>&
  59     );
  60
  61     //- Area-weighted average a surfaceField creating a volField
  62     template<class Type>
  63     tmp<GeometricField<Type, fvPatchField, volMesh> > average
  64     (
  65         const tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >&
  66     );
  67
  68
  69     //- Area-weighted average a surfaceField creating a volField
  70     template<class Type>
  71     tmp<GeometricField<Type, fvPatchField, volMesh> > average
  72     (
  73         const GeometricField<Type, fvPatchField, volMesh>&
  74     );
  75
  76     //- Area-weighted average a surfaceField creating a volField
  77     template<class Type>
  78     tmp<GeometricField<Type, fvPatchField, volMesh> > average
  79     (
  80         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
  81     );
  82 }
  83
  84
  85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  86
  87 } // End namespace Foam
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 #ifdef NoRepository
  92 #   include "fvcAverage.C"
  93 #endif
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 #endif
  98
  99 // ************************************************************************* //