NSRDS0.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) 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 Class
25  Foam::Function1s::NSRDS0
26 
27 Description
28  NSRDS function number 100
29 
30  Source:
31  \verbatim
32  NSRDS - AICHE
33  Data Compilation Tables
34  of Properties of
35  Pure Compounds
36 
37  Design Institute for Physical Property Data
38  American Institute of Chemical Engineers
39  345 East 47th Street
40  New York, New York 10017
41 
42  National Standard Reference Data System
43  American Institute of Chemical Engineers
44 
45  T.E. Daubert - R.P. Danner
46 
47  Department of Chemical Engineering
48  The Pennsylvania State University
49  University Park, PA 16802
50  \endverbatim
51 
52 \*---------------------------------------------------------------------------*/
53 
54 #ifndef NSRDS0_H
55 #define NSRDS0_H
56 
57 #include "Function1.H"
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 namespace Foam
62 {
63 namespace Function1s
64 {
65 
66 /*---------------------------------------------------------------------------*\
67  Class NSRDS0 Declaration
68 \*---------------------------------------------------------------------------*/
69 
70 class NSRDS0
71 :
72  public FieldFunction1<scalar, NSRDS0>
73 {
74  // Private Data
75 
76  // NSRDS function 100 coefficients
77  scalar a_, b_, c_, d_, e_, f_;
78 
79 
80 public:
81 
82  //- Runtime type information
83  TypeName("NSRDS0");
84 
85 
86  // Constructors
87 
88  //- Construct from components
89  NSRDS0
90  (
91  const word& name,
92  const scalar a,
93  const scalar b,
94  const scalar c,
95  const scalar d,
96  const scalar e,
97  const scalar f
98  );
99 
100  //- Construct from name and dictionary
101  NSRDS0
102  (
103  const word& name,
104  const unitConversions& units,
105  const dictionary& dict
106  );
107 
108  //- Construct and return a clone
109  virtual tmp<Function1<scalar>> clone() const
110  {
111  return tmp<Function1<scalar>>(new NSRDS0(*this));
112  }
113 
114 
115  // Member Functions
116 
117  //- Evaluate the function and return the result
118  virtual scalar value(scalar T) const
119  {
120  return ((((f_*T + e_)*T + d_)*T + c_)*T + b_)*T + a_;
121  }
122 
124 
125  //- Integrate between two scalar values
126  virtual scalar integral(const scalar x1, const scalar x2) const;
127 
128  //- Return the integral as a function. Note that this will error if the
129  // "f" coefficient is not zero.
130  NSRDS0 integral(const word& name, const scalar a) const;
131 
132  //- Write the function coefficients
133  virtual void write(Ostream& os, const unitConversions& units) const;
134 };
135 
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 } // End namespace Function1s
140 } // End namespace Foam
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #endif
145 
146 // ************************************************************************* //
const word & name() const
Return the name of the entry.
Definition: Function1.C:78
NSRDS function number 100.
Definition: NSRDS0.H:72
TypeName("NSRDS0")
Runtime type information.
virtual tmp< Function1< scalar > > clone() const
Construct and return a clone.
Definition: NSRDS0.H:108
virtual scalar value(scalar T) const
Evaluate the function and return the result.
Definition: NSRDS0.H:117
virtual void write(Ostream &os, const unitConversions &units) const
Write the function coefficients.
Definition: NSRDS0.C:114
NSRDS0(const word &name, const scalar a, const scalar b, const scalar c, const scalar d, const scalar e, const scalar f)
Construct from components.
Definition: NSRDS0.C:43
virtual scalar integral(const scalar x1, const scalar x2) const
Integrate between two scalar values.
Definition: NSRDS0.C:85
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 managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
volScalarField & b
Definition: createFields.H:25
const dimensionedScalar c
Speed of light in a vacuum.
Namespace for OpenFOAM.
const doubleScalar e
Definition: doubleScalar.H:106
const HashTable< unitConversion > & units()
Get the table of unit conversions.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
labelList f(nPoints)
dictionary dict