src/OpenFOAM/primitives/random/Random.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::Random
  27
  28 Description
  29     Simple random number generator.
  30
  31 SourceFiles
  32     Random.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef Random_H
  37 #define Random_H
  38
  39 #include "vector.H"
  40 #include "tensor.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class Random Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class Random
  52 {
  53     // Private data
  54
  55         label Seed;
  56
  57
  58 public:
  59
  60
  61     // Constructors
  62
  63         //- Construct given seed
  64         Random(const label&);
  65
  66
  67     // Member functions
  68
  69         int bit();
  70
  71         //- scalar [0..1] (so including 0,1)
  72         scalar scalar01();
  73         //- vector with every component scalar01
  74         vector vector01();
  75         //- sphericalTensor with every component scalar01
  76         sphericalTensor sphericalTensor01();
  77         //- symmTensor with every component scalar01
  78         symmTensor symmTensor01();
  79         //- tensor with every component scalar01
  80         tensor tensor01();
  81         //- label [lower..upper]
  82         label integer(const label lower, const label upper);
  83
  84         vector position(const vector&, const vector&);
  85
  86         void randomise(scalar&);
  87         void randomise(vector&);
  88         void randomise(sphericalTensor&);
  89         void randomise(symmTensor&);
  90         void randomise(tensor&);
  91
  92         //- Return a normal Gaussian randon number
  93         //  with zero mean and unity variance N(0, 1)
  94         scalar GaussNormal();
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #endif
 105
 106 // ************************************************************************* //