fvcSurfaceIntegrate.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2025 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 "primitiveFieldsFwd.H"
41 #include "volFieldsFwd.H"
42 #include "surfaceFieldsFwd.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Namespace fvc functions Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 namespace fvc
54 {
55  template<class Type>
56  void surfaceIntegrate
57  (
58  Field<Type>&,
59  const SurfaceField<Type>&
60  );
61 
62  template<class Type>
63  tmp<VolInternalField<Type>>
65  (
66  const SurfaceField<Type>&
67  );
68 
69  template<class Type>
70  tmp<VolInternalField<Type>>
72  (
73  const tmp<SurfaceField<Type>>&
74  );
75 
76  template<class Type>
77  tmp<VolField<Type>>
79  (
80  const SurfaceField<Type>&
81  );
82 
83  template<class Type>
84  tmp<VolField<Type>>
86  (
87  const tmp<SurfaceField<Type>>&
88  );
89 
90  template<class Type>
91  tmp<VolInternalField<Type>> surfaceSum
92  (
93  const SurfaceField<Type>&
94  );
95 
96  template<class Type>
97  tmp<VolInternalField<Type>> surfaceSum
98  (
99  const tmp<SurfaceField<Type>>&
100  );
101 }
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #ifdef NoRepository
111  #include "fvcSurfaceIntegrate.C"
112 #endif
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
void surfaceIntegrate(Field< Type > &ivf, const SurfaceField< Type > &ssf)
tmp< VolField< Type > > surfaceIntegrateExtrapolate(const SurfaceField< Type > &ssf)
tmp< VolInternalField< Type > > surfaceSum(const SurfaceField< Type > &ssf)
Namespace for OpenFOAM.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.