OpenFOAM logo
Open Source CFD Toolkit

Random.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     Random
00027 
00028 Description
00029     Simple random number generator.
00030 
00031 SourceFiles
00032     Random.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef Random_H
00037 #define Random_H
00038 
00039 #include "vector.H"
00040 #include "tensor.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class Random Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class Random
00052 {
00053     // Private data
00054 
00055         label Seed;
00056 
00057 
00058 public:
00059 
00060 
00061     // Constructors
00062 
00063         //- Construct given seed
00064         Random(const label&);
00065 
00066 
00067     // Member functions
00068 
00069         int bit();
00070 
00071         //- scalar [0..1] (so including 0,1)
00072         scalar scalar01();
00073         //- vector with every component scalar01
00074         vector vector01();
00075         //- tensor with every component scalar01
00076         tensor tensor01();
00077         //- tensor with every component scalar01
00078         sphericalTensor sphericalTensor01();
00079         //- label [lower..upper]
00080         label integer(const label lower, const label upper);
00081 
00082         vector position(const vector&, const vector&);
00083 
00084         void randomise(scalar&);
00085         void randomise(vector&);
00086         void randomise(tensor&);
00087         void randomise(sphericalTensor&);
00088 
00089         //- Return a normal Gaussian randon number
00090         //  with zero mean and unity variance N(0, 1)
00091         scalar GaussNormal();
00092 };
00093 
00094 
00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00096 
00097 } // End namespace Foam
00098 
00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00100 
00101 #endif
00102 
00103 // ************************************************************************* //
For further information go to www.openfoam.org