Function1Evaluate.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "Function1Evaluate.H"
27 
28 // * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * * //
29 
30 template<class Type, template<class> class PatchField, class GeoMesh>
31 void Foam::evaluate
32 (
34  const Function1<Type>& func,
36 )
37 {
38  result.primitiveFieldRef() = func.value(x());
39 
41  result.boundaryFieldRef();
42 
44  x.boundaryField();
45 
46  forAll(bresult, patchi)
47  {
48  bresult[patchi] = func.value(bx[patchi]);
49  }
50 }
51 
52 
53 template<class Type, template<class> class PatchField, class GeoMesh>
55 (
56  const Function1<Type>& func,
57  const dimensionSet& dims,
59 )
60 {
62  (
64  (
65  func.name() + "(" + x.name() + ')',
66  x.mesh(),
67  dims
68  )
69  );
70 
71  evaluate(tresult.ref(), func, x);
72 
73  return tresult;
74 }
75 
76 
77 // ************************************************************************* //
Run-time selectable general function of one variable.
Definition: Function1.H:52
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
const word & name() const
Return name.
Definition: IOobject.H:315
void evaluate(GeometricField< Type, PatchField, GeoMesh > &result, const Function1< Type > &func, const GeometricField< Type, PatchField, GeoMesh > &x)
const Boundary & boundaryField() const
Return const-reference to the boundary field.
T & ref() const
Return non-const reference or generate a fatal error.
Definition: tmpI.H:181
const word & name() const
Return the name of the entry.
Definition: Function1.C:82
Generic GeometricField class.
Dimension set for the base types.
Definition: dimensionSet.H:121
virtual Type value(const scalar x) const =0
Return value as a function of scalar x.
void func(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Internal::FieldType & primitiveFieldRef()
Return a reference to the internal field.
const Mesh & mesh() const
Return mesh.
Generic GeometricBoundaryField class.
Definition: fvMesh.H:80
label patchi
Boundary & boundaryFieldRef()
Return a reference to the boundary field.
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:46
A class for managing temporary objects.
Definition: PtrList.H:53