OpenFOAM logo
Open Source CFD Toolkit

fvcAverage.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Namespace
00026     fvc
00027 
00028 Description
00029     Area-weighted average a surfaceField creating a volField
00030 
00031 SourceFiles
00032     fvcAverage.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 
00037 #ifndef fvcAverage_H
00038 #define fvcAverage_H
00039 
00040 #include "volFieldsFwd.H"
00041 #include "surfaceFieldsFwd.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                      Namespace fvc functions Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 namespace fvc
00053 {
00054     //- Area-weighted average a surfaceField creating a volField
00055     template<class Type>
00056     tmp<GeometricField<Type, fvPatchField, volMesh> > average
00057     (
00058         const GeometricField<Type, fvPatchField, surfaceMesh>&
00059     );
00060 
00061     //- Area-weighted average a surfaceField creating a volField
00062     template<class Type>
00063     tmp<GeometricField<Type, fvPatchField, volMesh> > average
00064     (
00065         const tmp<GeometricField<Type, fvPatchField, surfaceMesh> >&
00066     );
00067 
00068 
00069     //- Area-weighted average a surfaceField creating a volField
00070     template<class Type>
00071     tmp<GeometricField<Type, fvPatchField, volMesh> > average
00072     (
00073         const GeometricField<Type, fvPatchField, volMesh>&
00074     );
00075 
00076     //- Area-weighted average a surfaceField creating a volField
00077     template<class Type>
00078     tmp<GeometricField<Type, fvPatchField, volMesh> > average
00079     (
00080         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
00081     );
00082 }
00083 
00084 
00085 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00086 
00087 } // End namespace Foam
00088 
00089 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00090 
00091 #ifdef NoRepository
00092 #   include "fvcAverage.C"
00093 #endif
00094 
00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00096 
00097 #endif
00098 
00099 // ************************************************************************* //
For further information go to www.openfoam.org