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