SRIFallOffFunction.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 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 Istream
77  inline SRIFallOffFunction(Istream&);
78 
79  //- Construct from dictionary
80  inline SRIFallOffFunction(const dictionary& dict);
81 
82 
83  // Member Functions
84 
85  //- Return the type name
86  static word type()
87  {
88  return "SRI";
89  }
90 
91  inline scalar operator()
92  (
93  const scalar T,
94  const scalar Pr
95  ) const;
96 
97  //- Write to stream
98  inline void write(Ostream& os) const;
99 
100 
101  // Ostream Operator
102 
103  friend Ostream& operator<<(Ostream&, const SRIFallOffFunction&);
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #include "SRIFallOffFunctionI.H"
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
dimensionedScalar Pr("Pr", dimless, laminarTransport)
The SRI fall-off function.
const dimensionedScalar b
Wien displacement law constant: default SI units: [m.K].
Definition: createFields.H:28
SRIFallOffFunction(const scalar a, const scalar b, const scalar c, const scalar d, const scalar e)
Construct from components.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A class for handling words, derived from string.
Definition: word.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Ostream & operator<<(Ostream &, const edgeMesh &)
Definition: edgeMeshIO.C:133
Namespace for OpenFOAM.
dictionary dict
const double e
Elementary charge.
Definition: doubleFloat.H:78
friend Ostream & operator<<(Ostream &, const SRIFallOffFunction &)
void write(Ostream &os) const
Write to stream.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
const dimensionedScalar c
Speed of light in a vacuum.
static word type()
Return the type name.