src/thermophysicalModels/pdfs/uniform/uniform.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::uniform
  27
  28 Description
  29     uniform pdf
  30
  31 SourceFiles
  32     uniformI.H
  33     uniform.C
  34     uniformIO.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef uniform_H
  39 #define uniform_H
  40
  41 #include "pdf.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class uniform Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class uniform
  53 :
  54     public pdf
  55 {
  56     // Private data
  57
  58         dictionary pdfDict_;
  59
  60         //- min and max values of the distribution
  61         scalar minValue_;
  62         scalar maxValue_;
  63
  64         // help-variable to avoid always having to calculate max-min
  65         scalar range_;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("uniform");
  72
  73
  74     // Constructors
  75
  76         //- Construct from components
  77         uniform
  78         (
  79             const dictionary& dict,
  80             Random& rndGen
  81         );
  82
  83
  84     //- Destructor
  85     virtual ~uniform();
  86
  87
  88     // Member Functions
  89
  90          //- Sample the pdf
  91         virtual scalar sample() const;
  92
  93         //- Return the minimum value
  94         virtual scalar minValue() const;
  95
  96         //- Return the maximum value
  97         virtual scalar maxValue() const;
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //