FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 InNamespace
00025     Foam::fvc
00026 
00027 Description
00028     Area-weighted average a surfaceField creating a volField
00029 
00030 SourceFiles
00031     fvcAverage.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 
00036 #ifndef fvcAverage_H
00037 #define fvcAverage_H
00038 
00039 #include <finiteVolume/volFieldsFwd.H>
00040 #include <finiteVolume/surfaceFieldsFwd.H>
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                      Namespace fvc functions Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 namespace fvc
00052 {
00053     //- Area-weighted average a surfaceField creating a volField
00054     template<class Type>
00055     tmp<GeometricField<Type, fvPatchField, volMesh> > average
00056     (
00057         const GeometricField<Type, fvsPatchField, surfaceMesh>&
00058     );
00059 
00060     //- Area-weighted average a surfaceField creating a volField
00061     template<class Type>
00062     tmp<GeometricField<Type, fvPatchField, volMesh> > average
00063     (
00064         const tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >&
00065     );
00066 
00067 
00068     //- Area-weighted average a surfaceField creating a volField
00069     template<class Type>
00070     tmp<GeometricField<Type, fvPatchField, volMesh> > average
00071     (
00072         const GeometricField<Type, fvPatchField, volMesh>&
00073     );
00074 
00075     //- Area-weighted average a surfaceField creating a volField
00076     template<class Type>
00077     tmp<GeometricField<Type, fvPatchField, volMesh> > average
00078     (
00079         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
00080     );
00081 }
00082 
00083 
00084 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00085 
00086 } // End namespace Foam
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 #ifdef NoRepository
00091 #   include <finiteVolume/fvcAverage.C>
00092 #endif
00093 
00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00095 
00096 #endif
00097 
00098 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines