uniform.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "uniform.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace distributionModels
34 {
35  defineTypeNameAndDebug(uniform, 0);
36  addToRunTimeSelectionTable(distributionModel, uniform, dictionary);
37 }
38 }
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const dictionary& dict,
45  cachedRandom& rndGen
46 )
47 :
48  distributionModel(typeName, dict, rndGen),
49  minValue_(readScalar(distributionModelDict_.lookup("minValue"))),
50  maxValue_(readScalar(distributionModelDict_.lookup("maxValue")))
51 {
52  check();
53 }
54 
55 
57 :
59  minValue_(p.minValue_),
60  maxValue_(p.maxValue_)
61 {}
62 
63 
64 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
65 
67 {}
68 
69 
70 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
71 
73 {
74  return rndGen_.position<scalar>(minValue_, maxValue_);
75 }
76 
77 
79 {
80  return minValue_;
81 }
82 
83 
85 {
86  return maxValue_;
87 }
88 
89 
91 {
92  return 0.5*(minValue_ + maxValue_);
93 }
94 
95 
96 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual scalar minValue() const
Return the minimum value.
Definition: uniform.C:78
Random number generator.
Definition: cachedRandom.H:63
cachedRandom & rndGen_
Reference to the random number generator.
Macros for easy insertion into run-time selection tables.
bool readScalar(const char *buf, doubleScalar &s)
Read whole of buf as a scalar. Return true if succesful.
Definition: doubleScalar.H:63
defineTypeNameAndDebug(exponential, 0)
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.
virtual ~uniform()
Destructor.
Definition: uniform.C:66
addToRunTimeSelectionTable(distributionModel, exponential, dictionary)
Type position(const Type &start, const Type &end)
Return a sample between start and end.
volScalarField & p
uniform(const dictionary &dict, cachedRandom &rndGen)
Construct from components.
Definition: uniform.C:43
Namespace for OpenFOAM.