FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

RosinRammler.H

Go to the documentation of this file.
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::RosinRammler
00026 
00027 Description
00028     Rosin-Rammler pdf
00029 
00030    @f[
00031        cumulative pdf = (1.0 - exp( -((x - d0)/d)^n ) / (1.0 - exp( -((d1 - d0)/d)^n )
00032    @f]
00033 
00034 
00035 SourceFiles
00036     RosinRammler.C
00037 
00038 \*---------------------------------------------------------------------------*/
00039 
00040 #ifndef RosinRammler_H
00041 #define RosinRammler_H
00042 
00043 #include <pdf/pdf.H>
00044 
00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00046 
00047 namespace Foam
00048 {
00049 namespace pdfs
00050 {
00051 
00052 /*---------------------------------------------------------------------------*\
00053                        Class RosinRammler Declaration
00054 \*---------------------------------------------------------------------------*/
00055 
00056 class RosinRammler
00057 :
00058     public pdf
00059 {
00060     // Private data
00061 
00062         //- Distribution minimum
00063         scalar minValue_;
00064 
00065         //- Distribution maximum
00066         scalar maxValue_;
00067 
00068         // Model coefficients
00069 
00070             scalar d_;
00071             scalar n_;
00072 
00073 
00074 public:
00075 
00076     //- Runtime type information
00077     TypeName("RosinRammler");
00078 
00079 
00080     // Constructors
00081 
00082         //- Construct from components
00083         RosinRammler
00084         (
00085             const dictionary& dict,
00086             Random& rndGen
00087         );
00088 
00089 
00090     //- Destructor
00091     virtual ~RosinRammler();
00092 
00093 
00094     // Member Functions
00095 
00096          //- Sample the pdf
00097         virtual scalar sample() const;
00098 
00099         //- Return the minimum value
00100         virtual scalar minValue() const;
00101 
00102         //- Return the maximum value
00103         virtual scalar maxValue() const;
00104 };
00105 
00106 
00107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00108 
00109 } // End namespace pdfs
00110 } // End namespace Foam
00111 
00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00113 
00114 #endif
00115 
00116 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines