TroeFallOffFunction.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-2021 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::TroeFallOffFunction
26 
27 Description
28  The Troe fall-off function
29 
30 SourceFiles
31  TroeFallOffFunctionI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef TroeFallOffFunction_H
36 #define TroeFallOffFunction_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 TroeFallOffFunction;
48 Ostream& operator<<(Ostream&, const TroeFallOffFunction&);
49 
50 
51 /*---------------------------------------------------------------------------*\
52  Class TroeFallOffFunction Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 {
57  // Private Data
58 
59  scalar alpha_;
60  scalar Tsss_, Ts_, Tss_;
61 
62 
63 public:
64 
65  // Constructors
66 
67  //- Construct from components
68  inline TroeFallOffFunction
69  (
70  const scalar alpha,
71  const scalar Tsss,
72  const scalar Ts,
73  const scalar Tss
74  );
75 
76  //- Construct from dictionary
77  inline TroeFallOffFunction(const dictionary& dict);
78 
79 
80  // Member Functions
81 
82  //- Return the type name
83  static word type()
84  {
85  return "Troe";
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 T,
97  const scalar Pr,
98  const scalar F
99  ) const;
100 
101  inline scalar ddPr
102  (
103  const scalar T,
104  const scalar Pr,
105  const scalar F
106  ) const;
107 
108  //- Write to stream
109  inline void write(Ostream& os) const;
110 
111 
112  // Ostream Operator
113 
114  friend Ostream& operator<<(Ostream&, const TroeFallOffFunction&);
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #include "TroeFallOffFunctionI.H"
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 #endif
129 
130 // ************************************************************************* //
dictionary dict
scalar ddPr(const scalar T, const scalar Pr, const scalar F) const
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
volScalarField alpha(IOobject("alpha", runTime.timeName(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
The Troe fall-off function.
void write(Ostream &os) const
Write to stream.
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
TroeFallOffFunction(const scalar alpha, const scalar Tsss, const scalar Ts, const scalar Tss)
Construct from components.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
scalar ddT(const scalar T, const scalar Pr, const scalar F) const
static word type()
Return the type name.
Ostream & operator<<(Ostream &, const ensightPart &)
Namespace for OpenFOAM.
friend Ostream & operator<<(Ostream &, const TroeFallOffFunction &)