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) 2011-2016 OpenFOAM Foundation
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/equally-weighted distribution model
29 
30 SourceFiles
31  uniform.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef uniform_H
36 #define uniform_H
37 
38 #include "distributionModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace distributionModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class uniform Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class uniform
52 :
53  public distributionModel
54 {
55  // Private data
56 
57  //- Distribution minimum
58  scalar minValue_;
59 
60  //- Distribution maximum
61  scalar maxValue_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("uniform");
68 
69 
70  // Constructors
71 
72  //- Construct from components
74 
75  //- Construct copy
76  uniform(const uniform& p);
77 
78  //- Construct and return a clone
79  virtual autoPtr<distributionModel> clone() const
80  {
81  return autoPtr<distributionModel>(new uniform(*this));
82  }
83 
84 
85  //- Destructor
86  virtual ~uniform();
87 
88 
89  // Member Functions
90 
91  //- Sample the distributionModel
92  virtual scalar sample() const;
93 
94  //- Return the minimum value
95  virtual scalar minValue() const;
96 
97  //- Return the maximum value
98  virtual scalar maxValue() const;
99 
100  //- Return the mean value
101  virtual scalar meanValue() const;
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace distributionModels
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual autoPtr< distributionModel > clone() const
Construct and return a clone.
Definition: uniform.H:78
virtual scalar minValue() const
Return the minimum value.
Definition: uniform.C:78
Random number generator.
Definition: cachedRandom.H:63
cachedRandom rndGen(label(0), -1)
virtual scalar meanValue() const
Return the mean value.
Definition: uniform.C:90
virtual scalar maxValue() const
Return the maximum value.
Definition: uniform.C:84
virtual scalar sample() const
Sample the distributionModel.
Definition: uniform.C:72
A library of runtime-selectable distribution models.
TypeName("uniform")
Runtime type information.
virtual ~uniform()
Destructor.
Definition: uniform.C:66
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
volScalarField & p
uniform(const dictionary &dict, cachedRandom &rndGen)
Construct from components.
Definition: uniform.C:43
Namespace for OpenFOAM.