exponential.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) 2011-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 "exponential.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace distributionModels
34 {
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  lambda_(distributionModelDict_.template lookup<scalar>("lambda"))
52 {
53  check();
54  info();
55 }
56 
57 
59 :
61  minValue_(p.minValue_),
62  maxValue_(p.maxValue_),
63  lambda_(p.lambda_)
64 {}
65 
66 
67 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
68 
70 {}
71 
72 
73 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
74 
76 {
77  scalar y = rndGen_.sample01<scalar>();
78  scalar K = exp(-lambda_*maxValue_) - exp(-lambda_*minValue_);
79  return -(1.0/lambda_)*log(exp(-lambda_*minValue_) + y*K);
80 }
81 
82 
84 {
85  return minValue_;
86 }
87 
88 
90 {
91  return maxValue_;
92 }
93 
94 
96 {
97  return 1.0/lambda_;
98 }
99 
100 
101 // ************************************************************************* //
virtual scalar minValue() const
Return the minimum value.
Definition: exponential.C:83
dimensionedScalar log(const dimensionedScalar &ds)
Random & rndGen_
Reference to the random number generator.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual scalar maxValue() const
Return the maximum value.
Definition: exponential.C:89
virtual scalar sample() const
Sample the distributionModel.
Definition: exponential.C:75
CGAL::Exact_predicates_exact_constructions_kernel K
Macros for easy insertion into run-time selection tables.
virtual ~exponential()
Destructor.
Definition: exponential.C:69
scalar y
exponential distribution model
Definition: exponential.H:50
Type sample01()
Advance the state and return a sample of a given type from a.
Definition: RandomI.H:70
dimensionedScalar exp(const dimensionedScalar &ds)
virtual scalar meanValue() const
Return the mean value.
Definition: exponential.C:95
Random number generator.
Definition: Random.H:57
defineTypeNameAndDebug(exponential, 0)
A library of runtime-selectable distribution models.
addToRunTimeSelectionTable(distributionModel, exponential, dictionary)
volScalarField & p
exponential(const dictionary &dict, Random &rndGen)
Construct from components.
Definition: exponential.C:43
Namespace for OpenFOAM.