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

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