NSRDS3.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-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::Function1s::NSRDS3
26 
27 Description
28  NSRDS function number 103
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 NSRDS3_H
55 #define NSRDS3_H
56 
57 #include "Function1.H"
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 namespace Foam
62 {
63 namespace Function1s
64 {
65 
66 /*---------------------------------------------------------------------------*\
67  Class NSRDS3 Declaration
68 \*---------------------------------------------------------------------------*/
69 
70 class NSRDS3
71 :
72  public FieldFunction1<scalar, NSRDS3>
73 {
74  // Private Data
75 
76  // NSRDS function 103 coefficients
77  scalar a_, b_, c_, d_;
78 
79 
80 public:
81 
82  //- Runtime type information
83  TypeName("NSRDS3");
84 
85 
86  // Constructors
87 
88  //- Construct from components
89  NSRDS3
90  (
91  const word& name,
92  const scalar a,
93  const scalar b,
94  const scalar c,
95  const scalar d
96  );
97 
98  //- Construct from name and dictionary
99  NSRDS3
100  (
101  const word& name,
102  const dictionary& dict
103  );
104 
105  //- Construct and return a clone
106  virtual tmp<Function1<scalar>> clone() const
107  {
108  return tmp<Function1<scalar>>(new NSRDS3(*this));
109  }
110 
111 
112  // Member Functions
113 
114  //- Evaluate the function and return the result
115  virtual scalar value(scalar T) const
116  {
117  return a_ + b_*exp(-c_/pow(T, d_));
118  }
119 
120  //- Integrate between two scalar values
121  virtual scalar integral(const scalar x1, const scalar x2) const;
122 
123  //- Write the function coefficients
124  virtual void write(Ostream& os) const;
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace Function1s
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
const word const dictionary & dict
Definition: Function1.H:84
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
const word & name() const
Return the name of the entry.
const dimensionedScalar b
Wien displacement law constant: default SI units: [m K].
Definition: createFields.H:27
NSRDS3(const word &name, const scalar a, const scalar b, const scalar c, const scalar d)
Construct from components.
Definition: NSRDS3.C:42
TypeName("NSRDS3")
Runtime type information.
const dimensionedScalar c
Speed of light in a vacuum.
virtual scalar integral(const scalar x1, const scalar x2) const
Integrate between two scalar values.
Definition: NSRDS3.C:75
virtual void write(Ostream &os) const
Write the function coefficients.
Definition: NSRDS3.C:85
dimensionedScalar exp(const dimensionedScalar &ds)
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual tmp< Function1< scalar > > clone() const
Construct and return a clone.
Definition: NSRDS3.H:105
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
NSRDS function number 103.
Definition: NSRDS3.H:69
A class for managing temporary objects.
Definition: PtrList.H:53
virtual scalar value(scalar T) const
Evaluate the function and return the result.
Definition: NSRDS3.H:114
Namespace for OpenFOAM.