00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::SRIFallOffFunction 00026 00027 Description 00028 The SRI fall-off function 00029 00030 SourceFiles 00031 SRIFallOffFunctionI.H 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef SRIFallOffFunction_H 00036 #define SRIFallOffFunction_H 00037 00038 #include <OpenFOAM/scalar.H> 00039 00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00041 00042 namespace Foam 00043 { 00044 00045 // Forward declaration of friend functions and operators 00046 00047 class SRIFallOffFunction; 00048 Ostream& operator<<(Ostream&, const SRIFallOffFunction&); 00049 00050 00051 /*---------------------------------------------------------------------------*\ 00052 Class SRIFallOffFunction Declaration 00053 \*---------------------------------------------------------------------------*/ 00054 00055 class SRIFallOffFunction 00056 { 00057 // Private data 00058 00059 scalar a_, b_, c_, d_, e_; 00060 00061 00062 public: 00063 00064 // Constructors 00065 00066 //- Construct from components 00067 inline SRIFallOffFunction 00068 ( 00069 const scalar a, 00070 const scalar b, 00071 const scalar c, 00072 const scalar d, 00073 const scalar e 00074 ); 00075 00076 //- Construct from Istream 00077 inline SRIFallOffFunction(Istream&); 00078 00079 00080 // Member Functions 00081 00082 //- Return the type name 00083 static word type() 00084 { 00085 return "SRI"; 00086 } 00087 00088 inline scalar operator() 00089 ( 00090 const scalar T, 00091 const scalar Pr 00092 ) const; 00093 00094 00095 // Ostream Operator 00096 00097 friend Ostream& operator<<(Ostream&, const SRIFallOffFunction&); 00098 }; 00099 00100 00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00102 00103 } // End namespace Foam 00104 00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00106 00107 #include <specie/SRIFallOffFunctionI.H> 00108 00109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00110 00111 #endif 00112 00113 // ************************ vim: set sw=4 sts=4 et: ************************ //
