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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 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 "uniform.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace distributionModels
36 {
37  defineTypeNameAndDebug(uniform, 0);
38  addToRunTimeSelectionTable(distributionModel, uniform, 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 {
54  check();
55 }
56 
57 
59 :
61  minValue_(p.minValue_),
62  maxValue_(p.maxValue_)
63 {}
64 
65 
66 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
67 
69 {}
70 
71 
72 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
73 
75 {
76  return rndGen_.position<scalar>(minValue_, maxValue_);
77 }
78 
79 
81 {
82  return minValue_;
83 }
84 
85 
87 {
88  return maxValue_;
89 }
90 
91 
93 {
94  return 0.5*(minValue_ + maxValue_);
95 }
96 
97 
98 // ************************************************************************* //
Foam::Random
Random number generator.
Definition: Random.H:59
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::distributionModels::uniform::maxValue
virtual scalar maxValue() const
Return the maximum value.
Definition: uniform.C:86
Foam::distributionModels::uniform::minValue
virtual scalar minValue() const
Return the minimum value.
Definition: uniform.C:80
Foam::distributionModels::addToRunTimeSelectionTable
addToRunTimeSelectionTable(distributionModel, binned, dictionary)
Foam::distributionModel
A library of runtime-selectable distribution models.
Definition: distributionModel.H:70
Foam::distributionModels::uniform::sample
virtual scalar sample() const
Sample the distributionModel.
Definition: uniform.C:74
uniform.H
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
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::distributionModels::uniform::uniform
uniform(const dictionary &dict, Random &rndGen)
Construct from components.
Definition: uniform.C:45
Foam::distributionModels::uniform
Uniform/equally-weighted distribution model.
Definition: uniform.H:52
Foam::distributionModels::defineTypeNameAndDebug
defineTypeNameAndDebug(binned, 0)
rndGen
Random rndGen
Definition: createFields.H:23
Foam::distributionModels::uniform::meanValue
virtual scalar meanValue() const
Return the mean value.
Definition: uniform.C:92
Foam::distributionModels::uniform::~uniform
virtual ~uniform()
Destructor.
Definition: uniform.C:68