src/OpenFOAM/primitives/random/cachedRandom/cachedRandom.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 "cachedRandom.H"
  27 #include "OSspecific.H"
  28
  29 // * * * * * * * * * * * * * private Member Functions  * * * * * * * * * * * //
  30
  31 Foam::scalar Foam::cachedRandom::scalar01()
  32 {
  33     if (sampleI_ < 0)
  34     {
  35         return osRandomDouble();
  36     }
  37
  38     if (sampleI_ == samples_.size() - 1)
  39     {
  40         scalar s = samples_[sampleI_];
  41         sampleI_ = 0;
  42         return s;
  43     }
  44     else
  45     {
  46         scalar s = samples_[sampleI_];
  47         sampleI_++;
  48         return s;
  49     }
  50 }
  51
  52
  53 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  54
  55 Foam::cachedRandom::cachedRandom(const label seed, const label count)
  56 :
  57     seed_(1),
  58     samples_(0),
  59     sampleI_(-1)
  60 {
  61     if (seed > 1)
  62     {
  63         seed_ = seed;
  64     }
  65
  66     // Samples will be cached if count > 0
  67     if (count > 0)
  68     {
  69         samples_.setSize(count);
  70         sampleI_ = 0;
  71     }
  72
  73     // Initialise samples
  74     osRandomSeed(seed_);
  75     forAll(samples_, i)
  76     {
  77         samples_[i] = osRandomDouble();
  78     }
  79 }
  80
  81
  82 Foam::cachedRandom::cachedRandom(const cachedRandom& cr, const bool reset)
  83 :
  84     seed_(cr.seed_),
  85     samples_(cr.samples_),
  86     sampleI_(cr.sampleI_)
  87 {
  88     if (sampleI_ == -1)
  89     {
  90         WarningIn
  91         (
  92             "Foam::cachedRandom::cachedRandom(const cachedRandom& cr)"
  93         )   << "Copy constructor called, but samples not being cached. "
  94             << "This may lead to non-repeatable behaviour" << endl;
  95
  96         osRandomSeed(seed_);
  97     }
  98     else if (reset)
  99     {
 100         sampleI_ = 0;
 101     }
 102 }
 103
 104
 105 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 106
 107 Foam::cachedRandom::~cachedRandom()
 108 {}
 109
 110
 111 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 112
 113 template<>
 114 Foam::label Foam::cachedRandom::sample01()
 115 {
 116     return round(scalar01());
 117 }
 118
 119
 120 template<>
 121 Foam::scalar Foam::cachedRandom::sample01()
 122 {
 123     return scalar01();
 124 }
 125
 126
 127 template<>
 128 Foam::label Foam::cachedRandom::position(const label& start, const label& end)
 129 {
 130     return start + round(scalar01()*(end - start));
 131 }
 132
 133
 134 template<>
 135 Foam::scalar Foam::cachedRandom::position
 136 (
 137     const scalar& start,
 138     const scalar& end
 139 )
 140 {
 141     return start + scalar01()*(end - start);
 142 }
 143
 144
 145 void Foam::cachedRandom::operator=(const cachedRandom& cr)
 146 {
 147     seed_ = cr.seed_;
 148     samples_ = cr.samples_;
 149     sampleI_ = cr.sampleI_;
 150 }
 151
 152
 153 // ************************************************************************* //