fvcSurfaceIntegrate.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) 2011 OpenFOAM Foundation
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  Surface integrate surfaceField creating a volField.
29  Surface sum a surfaceField creating a volField.
30 
31 SourceFiles
32  fvcSurfaceIntegrate.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 
37 #ifndef fvcSurfaceIntegrate_H
38 #define fvcSurfaceIntegrate_H
39 
40 #include "volFieldsFwd.H"
41 #include "surfaceFieldsFwd.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Namespace fvc functions Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 namespace fvc
53 {
54  template<class Type>
55  void surfaceIntegrate
56  (
57  Field<Type>&,
58  const GeometricField<Type, fvsPatchField, surfaceMesh>&
59  );
60 
61  template<class Type>
62  tmp<GeometricField<Type, fvPatchField, volMesh> >
64  (
65  const GeometricField<Type, fvsPatchField, surfaceMesh>&
66  );
67 
68  template<class Type>
69  tmp<GeometricField<Type, fvPatchField, volMesh> >
71  (
72  const tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >&
73  );
74 
75  template<class Type>
76  tmp<GeometricField<Type, fvPatchField, volMesh> > surfaceSum
77  (
78  const GeometricField<Type, fvsPatchField, surfaceMesh>&
79  );
80 
81  template<class Type>
82  tmp<GeometricField<Type, fvPatchField, volMesh> > surfaceSum
83  (
84  const tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >&
85  );
86 }
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #ifdef NoRepository
96 # include "fvcSurfaceIntegrate.C"
97 #endif
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
tmp< GeometricField< Type, fvPatchField, volMesh > > surfaceSum(const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)
Namespace for OpenFOAM.
void surfaceIntegrate(Field< Type > &ivf, const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)