SRIFallOffFunction.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::SRIFallOffFunction
26 
27 Description
28  The SRI fall-off function
29 
30 SourceFiles
31  SRIFallOffFunctionI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef SRIFallOffFunction_H
36 #define SRIFallOffFunction_H
37 
38 #include "scalar.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of friend functions and operators
46 
47 class SRIFallOffFunction;
48 Ostream& operator<<(Ostream&, const SRIFallOffFunction&);
49 
50 
51 /*---------------------------------------------------------------------------*\
52  Class SRIFallOffFunction Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 {
57  // Private Data
58 
59  scalar a_, b_, c_, d_, e_;
60 
61 
62 public:
63 
64  // Constructors
65 
66  //- Construct from components
67  inline SRIFallOffFunction
68  (
69  const scalar a,
70  const scalar b,
71  const scalar c,
72  const scalar d,
73  const scalar e
74  );
75 
76  //- Construct from dictionary
77  inline SRIFallOffFunction(const dictionary& dict);
78 
79 
80  // Member Functions
81 
82  //- Return the type name
83  static word type()
84  {
85  return "SRI";
86  }
87 
88  inline scalar operator()
89  (
90  const scalar T,
91  const scalar Pr
92  ) const;
93 
94  inline scalar ddT
95  (
96  const scalar Pr,
97  const scalar F,
98  const scalar dPrdT,
99  const scalar T
100  ) const;
101 
102  inline scalar ddc
103  (
104  const scalar Pr,
105  const scalar F,
106  const scalar dPrdc,
107  const scalar T
108  ) const;
109 
110  //- Write to stream
111  inline void write(Ostream& os) const;
112 
113 
114  // Ostream Operator
115 
116  friend Ostream& operator<<(Ostream&, const SRIFallOffFunction&);
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #include "SRIFallOffFunctionI.H"
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
dictionary dict
The SRI fall-off function.
const dimensionedScalar F
Faraday constant: default SI units: [C/mol].
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
const dimensionedScalar b
Wien displacement law constant: default SI units: [m K].
Definition: createFields.H:27
scalar ddc(const scalar Pr, const scalar F, const scalar dPrdc, const scalar T) const
void write(Ostream &os) const
Write to stream.
const dimensionedScalar c
Speed of light in a vacuum.
SRIFallOffFunction(const scalar a, const scalar b, const scalar c, const scalar d, const scalar e)
Construct from components.
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
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
friend Ostream & operator<<(Ostream &, const SRIFallOffFunction &)
Ostream & operator<<(Ostream &, const ensightPart &)
const doubleScalar e
Elementary charge.
Definition: doubleScalar.H:105
scalar ddT(const scalar Pr, const scalar F, const scalar dPrdT, const scalar T) const
Namespace for OpenFOAM.
static word type()
Return the type name.