fvcCellReduce.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) 2013-2018 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  Construct a volume field from a surface field using a combine operator.
29 
30 SourceFiles
31  fvcCellReduce.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fvcCellReduce_H
36 #define fvcCellReduce_H
37 
38 #include "volFieldsFwd.H"
39 #include "surfaceFieldsFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Namespace fvc functions Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 namespace fvc
51 {
52  template<class Type, class CombineOp>
53  tmp<GeometricField<Type, fvPatchField, volMesh>> cellReduce
54  (
55  const GeometricField<Type, fvsPatchField, surfaceMesh>&,
56  const CombineOp& cop,
57  const Type& nullValue = pTraits<Type>::zero
58  );
59 
60  template<class Type, class CombineOp>
61  tmp<GeometricField<Type, fvPatchField, volMesh>> cellReduce
62  (
63  const tmp<GeometricField<Type, fvsPatchField, surfaceMesh>>&,
64  const CombineOp& cop,
65  const Type& nullValue = pTraits<Type>::zero
66  );
67 }
68 
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 } // End namespace Foam
73 
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76 #ifdef NoRepository
77  #include "fvcCellReduce.C"
78 #endif
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 #endif
83 
84 // ************************************************************************* //
tmp< GeometricField< Type, fvPatchField, volMesh > > cellReduce(const GeometricField< Type, fvsPatchField, surfaceMesh > &, const CombineOp &cop, const Type &nullValue=pTraits< Type >::zero)
Namespace for OpenFOAM.