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

fvcVolumeIntegrate.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     Volume integrate volField creating a volField.
00029 
00030     Volume integrate volField over the whole domain
00031     creating a dimensioned<Type>
00032 
00033 SourceFiles
00034     fvcVolumeIntegrate.C
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 
00039 #ifndef fvcVolumeIntegrate_H
00040 #define fvcVolumeIntegrate_H
00041 
00042 #include <finiteVolume/volFieldsFwd.H>
00043 #include <OpenFOAM/primitiveFieldsFwd.H>
00044 #include <OpenFOAM/dimensionedTypes.H>
00045 
00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00047 
00048 namespace Foam
00049 {
00050 
00051 /*---------------------------------------------------------------------------*\
00052                      Namespace fvc functions Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 namespace fvc
00056 {
00057     template<class Type>
00058     tmp<Field<Type> > volumeIntegrate
00059     (
00060         const GeometricField<Type, fvPatchField, volMesh>&
00061     );
00062 
00063     template<class Type>
00064     tmp<Field<Type> > volumeIntegrate
00065     (
00066         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
00067     );
00068 
00069 
00070     template<class Type>
00071     dimensioned<Type> domainIntegrate
00072     (
00073         const GeometricField<Type, fvPatchField, volMesh>&
00074     );
00075 
00076     template<class Type>
00077     dimensioned<Type> domainIntegrate
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/fvcVolumeIntegrate.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