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