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::normal 00026 00027 Description 00028 A normal pdf 00029 00030 @verbatim 00031 pdf = strength * exp(-0.5*((x - expectation)/variance)^2 ) 00032 @endverbatim 00033 00034 strength only has meaning if there's more than one pdf 00035 00036 SourceFiles 00037 normal.C 00038 00039 \*---------------------------------------------------------------------------*/ 00040 00041 #ifndef normal_H 00042 #define normal_H 00043 00044 #include <pdf/pdf.H> 00045 00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00047 00048 namespace Foam 00049 { 00050 namespace pdfs 00051 { 00052 00053 /*---------------------------------------------------------------------------*\ 00054 Class normal Declaration 00055 \*---------------------------------------------------------------------------*/ 00056 00057 class normal 00058 : 00059 public pdf 00060 { 00061 // Private data 00062 00063 00064 //- Distribution minimum 00065 scalar minValue_; 00066 00067 //- Distribution maximum 00068 scalar maxValue_; 00069 00070 00071 // Model coefficients 00072 00073 scalar expectation_; 00074 scalar variance_; 00075 00076 scalar a_; 00077 00078 00079 public: 00080 00081 //- Runtime type information 00082 TypeName("normal"); 00083 00084 00085 // Constructors 00086 00087 //- Construct from components 00088 normal 00089 ( 00090 const dictionary& dict, 00091 Random& rndGen 00092 ); 00093 00094 00095 //- Destructor 00096 virtual ~normal(); 00097 00098 00099 // Member Functions 00100 00101 //- Sample the pdf 00102 virtual scalar sample() const; 00103 00104 //- Return the minimum value 00105 virtual scalar minValue() const; 00106 00107 //- Return the maximum value 00108 virtual scalar maxValue() const; 00109 00110 scalar erfInv(const scalar y) const; 00111 }; 00112 00113 00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00115 00116 } // End namespace pdfs 00117 } // End namespace Foam 00118 00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00120 00121 #endif 00122 00123 // ************************ vim: set sw=4 sts=4 et: ************************ //
