NSRDS2.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) 2011-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 "NSRDS2.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace Function1s
34 {
36 }
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const word& name,
45  const scalar a,
46  const scalar b,
47  const scalar c,
48  const scalar d
49 )
50 :
51  FieldFunction1<scalar, NSRDS2>(name),
52  a_(a),
53  b_(b),
54  c_(c),
55  d_(d)
56 {}
57 
58 
60 (
61  const word& name,
62  const unitConversions& units,
63  const dictionary& dict
64 )
65 :
66  FieldFunction1<scalar, NSRDS2>(name),
67  a_(dict.lookup<scalar>("a")),
68  b_(dict.lookup<scalar>("b")),
69  c_(dict.lookup<scalar>("c")),
70  d_(dict.lookup<scalar>("d"))
71 {
72  assertNoConvertUnits(typeName, units, dict);
73 }
74 
75 
76 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
77 
79 (
80  const scalar x1,
81  const scalar x2
82 ) const
83 {
85  return 0;
86 }
87 
88 
90 (
91  Ostream& os,
92  const unitConversions& units
93 ) const
94 {
95  writeEntry(os, "a", a_);
96  writeEntry(os, "b", b_);
97  writeEntry(os, "c", c_);
98  writeEntry(os, "d", d_);
99 }
100 
101 
102 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
NSRDS function number 102.
Definition: NSRDS2.H:72
NSRDS2(const word &name, const scalar a, const scalar b, const scalar c, const scalar d)
Construct from components.
Definition: NSRDS2.C:43
virtual void write(Ostream &os, const unitConversions &units) const
Write the function coefficients.
Definition: NSRDS2.C:90
virtual scalar integral(const scalar x1, const scalar x2) const
Integrate between two scalar values.
Definition: NSRDS2.C:79
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class for handling words, derived from string.
Definition: word.H:62
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:381
volScalarField & b
Definition: createFields.H:25
void writeEntry(Ostream &os, const omega &a)
Definition: omega1.C:97
addScalarFunction1(laminarBL)
const dimensionedScalar c
Speed of light in a vacuum.
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
const HashTable< unitConversion > & units()
Get the table of unit conversions.
void assertNoConvertUnits(const word &typeName, const Function1s::unitConversions &units, const dictionary &dict)
Generate an error in an context where unit conversions are not supported.
dictionary dict