FreeFOAM The Cross-Platform CFD Toolkit
uniform.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::uniform
26 
27 Description
28  uniform pdf
29 
30 SourceFiles
31  uniform.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef uniform_H
36 #define uniform_H
37 
38 #include <pdf/pdf.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace pdfs
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class uniform Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class uniform
52 :
53  public pdf
54 {
55  // Private data
56 
57  //- Distribution minimum
58  scalar minValue_;
59 
60  //- Distribution maximum
61  scalar maxValue_;
62 
63  //- Distribution range
64  scalar range_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("uniform");
71 
72 
73  // Constructors
74 
75  //- Construct from components
76  uniform
77  (
78  const dictionary& dict,
79  Random& rndGen
80  );
81 
82 
83  //- Destructor
84  virtual ~uniform();
85 
86 
87  // Member Functions
88 
89  //- Sample the pdf
90  virtual scalar sample() const;
91 
92  //- Return the minimum value
93  virtual scalar minValue() const;
94 
95  //- Return the maximum value
96  virtual scalar maxValue() const;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace pdfs
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************ vim: set sw=4 sts=4 et: ************************ //