src/lagrangian/distributionModels/uniform/uniform.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::uniform
  26
  27 Description
  28     Uniform/equally-weighted distribution model
  29
  30 SourceFiles
  31     uniform.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef uniform_H
  36 #define uniform_H
  37
  38 #include "distributionModel.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44 namespace distributionModels
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class uniform Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class uniform
  52 :
  53     public distributionModel
  54 {
  55     // Private data
  56
  57         //- Distribution minimum
  58         scalar minValue_;
  59
  60         //- Distribution maximum
  61         scalar maxValue_;
  62
  63         //- Distribution range
  64         scalar range_;
  65
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("uniform");
  71
  72
  73     // Constructors
  74
  75         //- Construct from components
  76         uniform(const dictionary& dict, cachedRandom& rndGen);
  77
  78         //- Construct copy
  79         uniform(const uniform& p);
  80
  81         //- Construct and return a clone
  82         virtual autoPtr<distributionModel> clone() const
  83         {
  84             return autoPtr<distributionModel>(new uniform(*this));
  85         }
  86
  87
  88     //- Destructor
  89     virtual ~uniform();
  90
  91
  92     // Member Functions
  93
  94          //- Sample the distributionModel
  95         virtual scalar sample() const;
  96
  97         //- Return the minimum value
  98         virtual scalar minValue() const;
  99
 100         //- Return the maximum value
 101         virtual scalar maxValue() const;
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace distributionModels
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //