FreeFOAM The Cross-Platform CFD Toolkit
fvcVolumeIntegrate.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 InNamespace
25  Foam::fvc
26 
27 Description
28  Volume integrate volField creating a volField.
29 
30  Volume integrate volField over the whole domain
31  creating a dimensioned<Type>
32 
33 SourceFiles
34  fvcVolumeIntegrate.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 
39 #ifndef fvcVolumeIntegrate_H
40 #define fvcVolumeIntegrate_H
41 
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Namespace fvc functions Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 namespace fvc
56 {
57  template<class Type>
58  tmp<Field<Type> > volumeIntegrate
59  (
60  const GeometricField<Type, fvPatchField, volMesh>&
61  );
62 
63  template<class Type>
64  tmp<Field<Type> > volumeIntegrate
65  (
66  const tmp<GeometricField<Type, fvPatchField, volMesh> >&
67  );
68 
69 
70  template<class Type>
71  dimensioned<Type> domainIntegrate
72  (
73  const GeometricField<Type, fvPatchField, volMesh>&
74  );
75 
76  template<class Type>
77  dimensioned<Type> domainIntegrate
78  (
79  const tmp<GeometricField<Type, fvPatchField, volMesh> >&
80  );
81 }
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #ifdef NoRepository
92 #endif
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************ vim: set sw=4 sts=4 et: ************************ //