File size: 8,471 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::randomGenerator
Description
Random number generator
This is a clone of the drand48 algorithm. This is significantly quicker
than drand48, presumably due to the compiler inlining the sampling methods.
It is also significantly quicker than the standard library linear
congruential engine, as it does not use Schrage's algorithm to prevent
overflow.
See <http://pubs.opengroup.org/onlinepubs/007908775/xsh/drand48.html> for
details of the seeding and iteration sequence.
SourceFiles
randomGenerator.C
randomGeneratorI.H
\*---------------------------------------------------------------------------*/
#ifndef randomGenerator_H
#define randomGenerator_H
#include "scalarField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class Istream;
class Ostream;
// Forward declaration of friend functions and operators
class randomGenerator;
Istream& operator>>(Istream&, randomGenerator&);
Ostream& operator<<(Ostream&, const randomGenerator&);
/*---------------------------------------------------------------------------*\
Class randomGenerator Declaration
\*---------------------------------------------------------------------------*/
class randomGenerator
{
public:
// Public Classes
//- Seed class
class seed
{
// Private Data
//- The seed value
const uint64_t s_;
// Private Member Functions
//- Return the initial integer
inline uint64_t x(const bool global) const;
public:
//- Allow randomGenerator to access the seed value
friend class randomGenerator;
// Constructors
//- Construct from a label
inline seed(const label s);
//- Construct from a word
inline seed(const word& s);
};
private:
// Private Static Data
//- The parameters of the linear congruential iteration
static const uint64_t A = 0x5DEECE66D, C = 0xB, M = uint64_t(1) << 48;
// Private Data
//- Is this generator global?
const bool global_;
//- The stored integer
uint64_t x_;
// Private Member Functions
//- Check the state is synchronised
void checkSync() const;
//- Advance the state and return an integer sample
inline uint64_t sample();
// Scalars
//- Return a scalar uniformly distributed between zero and one.
// Don't check synchronisation.
inline scalar scalar01NoCheckSync();
//- Return a scalar uniformly distributed between zero and one.
// Don't check synchronisation.
inline scalar scalarABNoCheckSync(const scalar a, const scalar b);
// Other Types
//- Return a type with components uniformly distributed between
// zero and one. Don't check synchronisation.
template<class Type>
inline Type sample01NoCheckSync();
//- Return a type with components uniformly distributed between two
// limits. Don't check synchronisation.
template<class Type>
inline Type sampleABNoCheckSync(const Type& a, const Type& b);
public:
// Constructors
//- Construct from a seed
inline randomGenerator(const seed s, const bool global = false);
//- Copy construct
inline randomGenerator(const randomGenerator&);
//- Move construct
inline randomGenerator(randomGenerator&&);
//- Construct from a stream
randomGenerator(Istream& is, const bool global = false);
//- Construct from a dictionary
randomGenerator
(
const word& name,
const dictionary& dict,
randomGenerator&& defaultRndGen
);
//- Construct from a dictionary
randomGenerator
(
const word& name,
const dictionary& dict,
const seed defaultS,
const bool global = false
);
//- Destructor
inline ~randomGenerator();
// Member Functions
// Scalars
//- Return a scalar uniformly distributed between zero and one
inline scalar scalar01();
//- Return scalars uniformly distributed between zero and one
inline tmp<scalarField> scalar01(const label n);
//- Return a scalar uniformly distributed between two limits
inline scalar scalarAB(const scalar a, const scalar b);
//- Return scalars uniformly distributed between two limits
inline tmp<scalarField> scalarAB
(
const label n,
const scalar a,
const scalar b
);
// Other Types
//- Return a type with components uniformly distributed between
// zero and one
template<class Type>
inline Type sample01();
//- Return types with components uniformly distributed between zero
// and one
template<class Type>
inline tmp<Field<Type>> sample01(const label n);
//- Return a type with components uniformly distributed between two
// limits
template<class Type>
inline Type sampleAB(const Type& a, const Type& b);
//- Return types with components uniformly distributed between two
// limits
template<class Type>
inline tmp<Field<Type>> sampleAB
(
const label n,
const Type& a,
const Type& b
);
//- Randomly permute a list
template<class Container>
inline void permute(Container& l);
//- Return a random permutation
inline labelList permutation(const label n);
//- Create a randomly seeded generator
inline randomGenerator generator();
// Member Operators
//- Copy-assignment
void operator=(const randomGenerator&);
//- Move-assignment
void operator=(randomGenerator&&);
// IOstream Operators
//- Read from stream
friend Istream& operator>>(Istream&, randomGenerator&);
//- Write to stream
friend Ostream& operator<<(Ostream&, const randomGenerator&);
};
template<>
inline scalar randomGenerator::sample01NoCheckSync();
template<>
inline label randomGenerator::sample01NoCheckSync();
template<>
inline scalar randomGenerator::sampleABNoCheckSync
(
const scalar& a,
const scalar& b
);
template<>
inline label randomGenerator::sampleABNoCheckSync
(
const label& a,
const label& b
);
void writeEntry(Ostream& os, const randomGenerator& rndGen);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "randomGeneratorI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|