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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 InNamespace
27  Foam::fvc
28 
29 Description
30  Volume integrate volField creating a volField.
31 
32  Volume integrate volField over the whole domain
33  creating a dimensioned<Type>
34 
35 SourceFiles
36  fvcVolumeIntegrate.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 
41 #ifndef fvcVolumeIntegrate_H
42 #define fvcVolumeIntegrate_H
43 
44 #include "volFieldsFwd.H"
45 #include "primitiveFieldsFwd.H"
46 #include "dimensionedTypes.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Namespace fvc functions Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 namespace fvc
58 {
59  template<class Type>
60  tmp<Field<Type>> volumeIntegrate
61  (
62  const GeometricField<Type, fvPatchField, volMesh>&
63  );
64 
65  template<class Type>
66  tmp<Field<Type>> volumeIntegrate
67  (
68  const tmp<GeometricField<Type, fvPatchField, volMesh>>&
69  );
70 
71 
72  template<class Type>
73  tmp<Field<Type>> volumeIntegrate
74  (
75  const DimensionedField<Type, volMesh>&
76  );
77 
78  template<class Type>
79  tmp<Field<Type>> volumeIntegrate
80  (
81  const tmp<DimensionedField<Type, volMesh>>&
82  );
83 
84 
85  template<class Type>
86  dimensioned<Type> domainIntegrate
87  (
88  const GeometricField<Type, fvPatchField, volMesh>&
89  );
90 
91  template<class Type>
92  dimensioned<Type> domainIntegrate
93  (
94  const tmp<GeometricField<Type, fvPatchField, volMesh>>&
95  );
96 
97 
98  template<class Type>
99  dimensioned<Type> domainIntegrate
100  (
101  const DimensionedField<Type, volMesh>&
102  );
103 
104  template<class Type>
105  dimensioned<Type> domainIntegrate
106  (
107  const tmp<DimensionedField<Type, volMesh>>&
108  );
109 }
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace Foam
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #ifdef NoRepository
119  #include "fvcVolumeIntegrate.C"
120 #endif
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
volFieldsFwd.H
primitiveFieldsFwd.H
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
Foam::fvc::domainIntegrate
dimensioned< Type > domainIntegrate(const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcVolumeIntegrate.C:88
fvcVolumeIntegrate.C
Foam::fvc::volumeIntegrate
tmp< Field< Type > > volumeIntegrate(const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcVolumeIntegrate.C:47
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
dimensionedTypes.H