OpenFOAM logo
Open Source CFD Toolkit

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-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     Volume integrate volField creating a volField.
00030     Volume integrate volField over the whole domain creating a dimensioned<Type>
00031 
00032 SourceFiles
00033     fvcVolumeIntegrate.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 
00038 #ifndef fvcVolumeIntegrate_H
00039 #define fvcVolumeIntegrate_H
00040 
00041 #include "volFieldsFwd.H"
00042 #include "primitiveFieldsFwd.H"
00043 #include "dimensionedTypes.H"
00044 
00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00046 
00047 namespace Foam
00048 {
00049 
00050 /*---------------------------------------------------------------------------*\
00051                      Namespace fvc functions Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 namespace fvc
00055 {
00056     template<class Type>
00057     tmp<Field<Type> > volumeIntegrate
00058     (
00059         const GeometricField<Type, fvPatchField, volMesh>&
00060     );
00061 
00062     template<class Type>
00063     tmp<Field<Type> > volumeIntegrate
00064     (
00065         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
00066     );
00067 
00068 
00069     template<class Type>
00070     dimensioned<Type> domainIntegrate
00071     (
00072         const GeometricField<Type, fvPatchField, volMesh>&
00073     );
00074 
00075     template<class Type>
00076     dimensioned<Type> domainIntegrate
00077     (
00078         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
00079     );
00080 }
00081 
00082 
00083 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00084 
00085 } // End namespace Foam
00086 
00087 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00088 
00089 #ifdef NoRepository
00090 #   include "fvcVolumeIntegrate.C"
00091 #endif
00092 
00093 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00094 
00095 #endif
00096 
00097 // ************************************************************************* //
For further information go to www.openfoam.org