RosinRammler.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-2013 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 "RosinRammler.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33  namespace distributionModels
34  {
35  defineTypeNameAndDebug(RosinRammler, 0);
36  addToRunTimeSelectionTable(distributionModel, RosinRammler, 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  d_(readScalar(distributionModelDict_.lookup("d"))),
52  n_(readScalar(distributionModelDict_.lookup("n")))
53 {
54  check();
55 }
56 
57 
59 :
61  minValue_(p.minValue_),
62  maxValue_(p.maxValue_),
63  d_(p.d_),
64  n_(p.n_)
65 {}
66 
67 
68 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
69 
71 {}
72 
73 
74 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
75 
77 {
78  scalar K = 1.0 - exp(-pow((maxValue_ - minValue_)/d_, n_));
79  scalar y = rndGen_.sample01<scalar>();
80  scalar x = minValue_ + d_*::pow(-log(1.0 - y*K), 1.0/n_);
81  return x;
82 }
83 
84 
86 {
87  return minValue_;
88 }
89 
90 
92 {
93  return maxValue_;
94 }
95 
96 
98 {
99  return d_;
100 }
101 
102 
103 // ************************************************************************* //
dimensionedScalar log(const dimensionedScalar &ds)
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
defineTypeNameAndDebug(distributionModel, 0)
Random number generator.
Definition: cachedRandom.H:63
CGAL::Exact_predicates_exact_constructions_kernel K
Macros for easy insertion into run-time selection tables.
virtual scalar meanValue() const
Return the mean value.
Definition: RosinRammler.C:97
scalar y
Type sample01()
Return a sample whose components lie in the range 0-1.
dimensionedScalar exp(const dimensionedScalar &ds)
bool readScalar(const char *buf, doubleScalar &s)
Read whole of buf as a scalar. Return true if succesful.
Definition: doubleScalar.H:63
RosinRammler(const dictionary &dict, cachedRandom &rndGen)
Construct from components.
Definition: RosinRammler.C:43
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
virtual scalar sample() const
Sample the distributionModel.
Definition: RosinRammler.C:76
virtual ~RosinRammler()
Destructor.
Definition: RosinRammler.C:70
virtual scalar minValue() const
Return the minimum value.
Definition: RosinRammler.C:85
cachedRandom & rndGen_
Reference to the random number generator.
addToRunTimeSelectionTable(distributionModel, exponential, dictionary)
volScalarField & p
Namespace for OpenFOAM.
virtual scalar maxValue() const
Return the maximum value.
Definition: RosinRammler.C:91