unknownTypeFunction1Templates.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) 2021-2024 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 "unknownTypeFunction1.H"
27 
28 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
29 
30 template<class Type>
31 void Foam::unknownTypeFunction1::build(const unitConversion& valueUnits) const
32 {
33  if (!functionPtr_.autoPtr<Function1<Type>>::valid())
34  {
35  functionPtr_.autoPtr<Function1<Type>>::set
36  (
38  (
39  name_,
40  xUnits_,
41  valueUnits,
42  topDict_.scopedDict(topDictKeyword_)
43  ).ptr()
44  );
45  }
46 }
47 
48 
49 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
50 
51 template<class Type>
53 (
54  const unitConversion& valueUnits
55 ) const
56 {
57  build<Type>(valueUnits);
58 }
59 
60 
61 template<class Type>
63 (
64  const scalar x
65 ) const
66 {
67  build<Type>(unitAny);
68 
69  return functionPtr_.autoPtr<Function1<Type>>::operator*().value(x);
70 }
71 
72 
73 template<class Type>
75 (
76  const scalarField& x
77 ) const
78 {
79  build<Type>(unitAny);
80 
81  return functionPtr_.autoPtr<Function1<Type>>::operator*().value(x);
82 }
83 
84 
85 template<class Type>
87 (
88  const scalar x1,
89  const scalar x2
90 ) const
91 {
92  build<Type>(unitAny);
93 
94  return functionPtr_.autoPtr<Function1<Type>>::operator*().integral(x1, x2);
95 }
96 
97 
98 template<class Type>
100 (
101  const scalarField& x1,
102  const scalarField& x2
103 ) const
104 {
105  build<Type>(unitAny);
106 
107  return functionPtr_.autoPtr<Function1<Type>>::operator*().integral(x1, x2);
108 }
109 
110 
111 // ************************************************************************* //
Run-time selectable general function of one variable.
Definition: Function1.H:125
static autoPtr< Function1< Type > > New(const word &name, const Function1s::unitConversions &units, const dictionary &dict)
Select from dictionary.
Definition: Function1New.C:32
const dictionary & scopedDict(const word &) const
Find and return a sub-dictionary by scoped lookup.
Definition: dictionary.C:938
A class for managing temporary objects.
Definition: tmp.H:55
Unit conversion structure. Contains the associated dimensions and the multiplier with which to conver...
Type integral(const scalar x1, const scalar x2) const
Integrate between two scalars.
Type value(const scalar x) const
Return value as a function of scalar x.
void setValueUnits(const unitConversion &) const
Set the value units.
bool valid(const PtrList< ModelType > &l)
const unitConversion unitAny