FreeFOAM The Cross-Platform CFD Toolkit
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) 1991-2010 OpenCFD Ltd.
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 <OpenFOAM/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 
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 
95  // Ostream Operator
96 
97  friend Ostream& operator<<(Ostream&, const SRIFallOffFunction&);
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************ vim: set sw=4 sts=4 et: ************************ //