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 | 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  Surface integrate surfaceField creating a volField.
31  Surface sum a surfaceField creating a volField.
32 
33 SourceFiles
34  fvcSurfaceIntegrate.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 
39 #ifndef fvcSurfaceIntegrate_H
40 #define fvcSurfaceIntegrate_H
41 
42 #include "primitiveFieldsFwd.H"
43 #include "volFieldsFwd.H"
44 #include "surfaceFieldsFwd.H"
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  void surfaceIntegrate
59  (
60  Field<Type>&,
61  const GeometricField<Type, fvsPatchField, surfaceMesh>&
62  );
63 
64  template<class Type>
65  tmp<GeometricField<Type, fvPatchField, volMesh>>
67  (
68  const GeometricField<Type, fvsPatchField, surfaceMesh>&
69  );
70 
71  template<class Type>
72  tmp<GeometricField<Type, fvPatchField, volMesh>>
74  (
75  const tmp<GeometricField<Type, fvsPatchField, surfaceMesh>>&
76  );
77 
78  template<class Type>
79  tmp<GeometricField<Type, fvPatchField, volMesh>> surfaceSum
80  (
81  const GeometricField<Type, fvsPatchField, surfaceMesh>&
82  );
83 
84  template<class Type>
85  tmp<GeometricField<Type, fvPatchField, volMesh>> surfaceSum
86  (
87  const tmp<GeometricField<Type, fvsPatchField, surfaceMesh>>&
88  );
89 }
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #ifdef NoRepository
99  #include "fvcSurfaceIntegrate.C"
100 #endif
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
volFieldsFwd.H
Foam::fvc::surfaceSum
tmp< GeometricField< Type, fvPatchField, volMesh > > surfaceSum(const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)
Definition: fvcSurfaceIntegrate.C:135
primitiveFieldsFwd.H
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
fvcSurfaceIntegrate.C
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::fvc::surfaceIntegrate
void surfaceIntegrate(Field< Type > &ivf, const GeometricField< Type, fvsPatchField, surfaceMesh > &ssf)
Definition: fvcSurfaceIntegrate.C:46
surfaceFieldsFwd.H