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::exponential 00026 00027 Description 00028 exponential pdf 00029 00030 SourceFiles 00031 exponential.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef exponential_H 00036 #define exponential_H 00037 00038 #include <pdf/pdf.H> 00039 00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00041 00042 namespace Foam 00043 { 00044 namespace pdfs 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class exponential Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 class exponential 00052 : 00053 public pdf 00054 { 00055 // Private data 00056 00057 //- Distribution minimum 00058 scalar minValue_; 00059 00060 //- Distribution maximum 00061 scalar maxValue_; 00062 00063 00064 // Model coefficients 00065 00066 scalar lambda_; 00067 00068 00069 public: 00070 00071 //- Runtime type information 00072 TypeName("exponential"); 00073 00074 00075 // Constructors 00076 00077 //- Construct from components 00078 exponential 00079 ( 00080 const dictionary& dict, 00081 Random& rndGen 00082 ); 00083 00084 00085 //- Destructor 00086 virtual ~exponential(); 00087 00088 00089 // Member Functions 00090 00091 //- Sample the pdf 00092 virtual scalar sample() const; 00093 00094 //- Return the minimum value 00095 virtual scalar minValue() const; 00096 00097 //- Return the maximum value 00098 virtual scalar maxValue() const; 00099 }; 00100 00101 00102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00103 00104 } // End namespace pdfs 00105 } // End namespace Foam 00106 00107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00108 00109 #endif 00110 00111 // ************************ vim: set sw=4 sts=4 et: ************************ //
