File size: 3,095 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2024 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::restartableRandomGenerator
Description
Random number generator with the additional ability to go back to an
earlier stored state. Useful for processes that occur within converging
iteration loops to ensure that the random sequence is the same for each
iteration, and is not preventing convergence by "re-randomising" the
solution on each iteration.
\*---------------------------------------------------------------------------*/
#ifndef restartableRandomGenerator_H
#define restartableRandomGenerator_H
#include "randomGenerator.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class restartableRandomGenerator Declaration
\*---------------------------------------------------------------------------*/
class restartableRandomGenerator
:
public randomGenerator
{
// Private Data
//- The random generator state at the start of the current sequence
randomGenerator startRndGen_;
public:
// Constructors
//- Forward all constructors
template<class ... Args>
inline restartableRandomGenerator(Args&& ... args)
:
randomGenerator(std::forward<Args>(args) ...),
startRndGen_(static_cast<const randomGenerator&>(*this))
{}
// Member Functions
//- Start a sequence of random numbers. Either a new sequence, or a
// repeat of the previous, as indicated by the provided flag.
inline void start(const bool repeat)
{
repeat
? static_cast<randomGenerator&>(*this) = startRndGen_
: startRndGen_ = static_cast<randomGenerator&>(*this);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
#endif
// ************************************************************************* //
|