massRosinRammler.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2016-2019 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 "massRosinRammler.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace distributionModels
34 {
35  defineTypeNameAndDebug(massRosinRammler, 0);
36  addToRunTimeSelectionTable(distributionModel, massRosinRammler, dictionary);
37 }
38 }
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const dictionary& dict,
45  Random& rndGen
46 )
47 :
48  distributionModel(typeName, dict, rndGen),
49  minValue_(distributionModelDict_.template lookup<scalar>("minValue")),
50  maxValue_(distributionModelDict_.template lookup<scalar>("maxValue")),
51  d_(distributionModelDict_.template lookup<scalar>("d")),
52  n_(distributionModelDict_.template lookup<scalar>("n"))
53 {
54  check();
55  info();
56 }
57 
58 
60 (
61  const massRosinRammler& p
62 )
63 :
65  minValue_(p.minValue_),
66  maxValue_(p.maxValue_),
67  d_(p.d_),
68  n_(p.n_)
69 {}
70 
71 
72 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
73 
75 {}
76 
77 
78 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
79 
81 {
82  scalar d;
83 
84  // Re-sample if the calculated d is out of the physical range
85  do
86  {
87  const scalar a = 3/n_ + 1;
88  const scalar P = rndGen_.sample01<scalar>();
89  const scalar x = invIncGamma(a, P);
90  d = d_*pow(x, 1/n_);
91  } while (d < minValue_ || d > maxValue_);
92 
93  return d;
94 }
95 
96 
98 {
99  return minValue_;
100 }
101 
102 
104 {
105  return maxValue_;
106 }
107 
108 
110 {
111  return d_;
112 }
113 
114 
115 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual scalar meanValue() const
Return the mean value.
Macros for easy insertion into run-time selection tables.
massRosinRammler(const dictionary &dict, Random &rndGen)
Construct from components.
Random number generator.
Definition: Random.H:57
scalar invIncGamma(const scalar a, const scalar P)
Inverse normalised incomplete gamma function.
Definition: invIncGamma.C:106
defineTypeNameAndDebug(exponential, 0)
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
A library of runtime-selectable distribution models.
addToRunTimeSelectionTable(distributionModel, exponential, dictionary)
virtual scalar maxValue() const
Return the maximum value.
virtual scalar minValue() const
Return the minimum value.
virtual scalar sample() const
Sample the distributionModel.
Mass-based Rosin-Rammler distributionModel.
Namespace for OpenFOAM.