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