00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 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 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your 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, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::Random 00026 00027 Description 00028 Simple random number generator. 00029 00030 SourceFiles 00031 Random.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef Random_H 00036 #define Random_H 00037 00038 #include <OpenFOAM/vector.H> 00039 #include <OpenFOAM/tensor.H> 00040 00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00042 00043 namespace Foam 00044 { 00045 00046 /*---------------------------------------------------------------------------*\ 00047 Class Random Declaration 00048 \*---------------------------------------------------------------------------*/ 00049 00050 class Random 00051 { 00052 // Private data 00053 00054 label Seed; 00055 00056 00057 public: 00058 00059 00060 // Constructors 00061 00062 //- Construct given seed 00063 Random(const label&); 00064 00065 00066 // Member functions 00067 00068 int bit(); 00069 00070 //- scalar [0..1] (so including 0,1) 00071 scalar scalar01(); 00072 //- vector with every component scalar01 00073 vector vector01(); 00074 //- sphericalTensor with every component scalar01 00075 sphericalTensor sphericalTensor01(); 00076 //- symmTensor with every component scalar01 00077 symmTensor symmTensor01(); 00078 //- tensor with every component scalar01 00079 tensor tensor01(); 00080 //- label [lower..upper] 00081 label integer(const label lower, const label upper); 00082 00083 vector position(const vector&, const vector&); 00084 00085 void randomise(scalar&); 00086 void randomise(vector&); 00087 void randomise(sphericalTensor&); 00088 void randomise(symmTensor&); 00089 void randomise(tensor&); 00090 00091 //- Return a normal Gaussian randon number 00092 // with zero mean and unity variance N(0, 1) 00093 scalar GaussNormal(); 00094 }; 00095 00096 00097 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00098 00099 } // End namespace Foam 00100 00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00102 00103 #endif 00104 00105 // ************************ vim: set sw=4 sts=4 et: ************************ //
