Function2Evaluate.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) 2020 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 Class
25  Foam::Function2Evaluate
26 
27 Description
28  Global functions to evaluate Function2 of GeometricFields
29 
30 SourceFiles
31  Function2Evaluate.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef Function2Evaluate_H
36 #define Function2Evaluate_H
37 
38 #include "Function2.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 template<class Type, template<class> class PatchField, class GeoMesh>
48 void evaluate
49 (
50  GeometricField<Type, PatchField, GeoMesh>& result,
51  const Function2<Type>& func,
52  const GeometricField<Type, PatchField, GeoMesh>& x,
53  const GeometricField<Type, PatchField, GeoMesh>& y
54 );
55 
56 template<class Type, template<class> class PatchField, class GeoMesh>
57 tmp<GeometricField<Type, PatchField, GeoMesh>> evaluate
58 (
59  const Function2<Type>& func,
60  const dimensionSet& dims,
61  const GeometricField<Type, PatchField, GeoMesh>& x,
62  const GeometricField<Type, PatchField, GeoMesh>& y
63 );
64 
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 } // End namespace Foam
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 #ifdef NoRepository
73  #include "Function2Evaluate.C"
74 #endif
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 #endif
79 
80 // ************************************************************************* //
void evaluate(GeometricField< Type, PatchField, GeoMesh > &result, const Function1< Type > &func, const GeometricField< Type, PatchField, GeoMesh > &x)
scalar y
void func(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Namespace for OpenFOAM.