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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2020 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "RosinRammler.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace distributionModels
36 {
37  defineTypeNameAndDebug(RosinRammler, 0);
38  addToRunTimeSelectionTable(distributionModel, RosinRammler, dictionary);
39 }
40 }
41 
42 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43 
45 (
46  const dictionary& dict,
47  Random& rndGen
48 )
49 :
50  distributionModel(typeName, dict, rndGen),
51  minValue_(distributionModelDict_.get<scalar>("minValue")),
52  maxValue_(distributionModelDict_.get<scalar>("maxValue")),
53  d_(distributionModelDict_.get<scalar>("d")),
54  n_(distributionModelDict_.get<scalar>("n"))
55 {
56  check();
57 }
58 
59 
61 :
63  minValue_(p.minValue_),
64  maxValue_(p.maxValue_),
65  d_(p.d_),
66  n_(p.n_)
67 {}
68 
69 
70 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
71 
73 {}
74 
75 
76 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
77 
79 {
80  const scalar minValueByDPowN = pow(minValue_/d_, n_);
81  const scalar K = 1 - exp(- pow(maxValue_/d_, n_) + minValueByDPowN);
82  const scalar y = rndGen_.sample01<scalar>();
83  return d_*pow(minValueByDPowN - log(1 - K*y), 1/n_);
84 }
85 
86 
88 {
89  return minValue_;
90 }
91 
92 
94 {
95  return maxValue_;
96 }
97 
98 
100 {
101  return d_;
102 }
103 
104 
105 // ************************************************************************* //
Foam::Random
Random number generator.
Definition: Random.H:59
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::distributionModels::RosinRammler::meanValue
virtual scalar meanValue() const
Return the mean value.
Definition: RosinRammler.C:99
Foam::distributionModels::RosinRammler::sample
virtual scalar sample() const
Sample the distributionModel.
Definition: RosinRammler.C:78
RosinRammler.H
Foam::distributionModels::addToRunTimeSelectionTable
addToRunTimeSelectionTable(distributionModel, binned, dictionary)
Foam::exp
dimensionedScalar exp(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:261
Foam::distributionModel
A library of runtime-selectable distribution models.
Definition: distributionModel.H:70
Foam::distributionModels::RosinRammler
Rosin-Rammler distributionModel.
Definition: RosinRammler.H:58
K
CGAL::Exact_predicates_exact_constructions_kernel K
Definition: CGALTriangulation3DKernel.H:58
Foam::distributionModels::RosinRammler::RosinRammler
RosinRammler(const dictionary &dict, Random &rndGen)
Construct from components.
Definition: RosinRammler.C:45
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:75
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::distributionModels::RosinRammler::minValue
virtual scalar minValue() const
Return the minimum value.
Definition: RosinRammler.C:87
Foam::log
dimensionedScalar log(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:262
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::distributionModels::RosinRammler::maxValue
virtual scalar maxValue() const
Return the maximum value.
Definition: RosinRammler.C:93
Foam::distributionModels::defineTypeNameAndDebug
defineTypeNameAndDebug(binned, 0)
rndGen
Random rndGen
Definition: createFields.H:23
Foam::distributionModels::RosinRammler::~RosinRammler
virtual ~RosinRammler()
Destructor.
Definition: RosinRammler.C:72
y
scalar y
Definition: LISASMDCalcMethod1.H:14