OpenFOAM: API Guide
v2112
The open source CFD toolbox
RandomI.H
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) 2018 OpenCFD Ltd.
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
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
29
30
inline
Foam::scalar Foam::Random::scalar01()
31
{
32
return
uniform01_(generator_);
33
}
34
35
36
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
37
38
inline
int
Foam::Random::bit
()
39
{
40
return
generator_() & 0x1;
41
}
42
43
44
inline
Foam::label
Foam::Random::seed
()
const
45
{
46
return
seed_;
47
}
48
49
50
inline
void
Foam::Random::reset
(
const
label seedValue)
51
{
52
seed_ = seedValue;
53
generator_.seed(seed_);
54
uniform01_.reset();
// A no-op, but for completeness
55
}
56
57
58
// ************************************************************************* //
Foam::Random::reset
void reset(const label seedValue)
Reset the random number generator seed.
Definition:
RandomI.H:50
Foam::Random::seed
label seed() const
The initial random number seed that was used.
Definition:
RandomI.H:44
Foam::Random::bit
int bit()
Return a random bit.
Definition:
RandomI.H:38
src
OpenFOAM
primitives
random
Random
RandomI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.