src/thermophysicalModels/pdfs/pdf/pdf.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::pdf
  26
  27 Description
  28     A library of runtime-selectable pdf's.
  29
  30     Returns a sampled value given the expectation (nu) and variance (sigma^2)
  31
  32     Sample of planned pdfs (beta p. 374-375):
  33     - binomial
  34     - geometric
  35     - Poisson
  36     - hypergeometric
  37     - Pascal
  38     - uniform
  39     - exponential
  40     - normal
  41     - Gamma
  42     - chi
  43     - t?
  44     - F?
  45     - beta
  46     - Weibull
  47     - Rayleigh
  48     - Cauchy?
  49
  50     The pdf is tabulated in equidistant nPoints, in an interval.
  51     These values are integrated to obtain the cumulated pdf,
  52     which is then used to change the distribution from unifrom to
  53     the actual pdf.
  54
  55 SourceFiles
  56     pdfI.H
  57     pdf.C
  58     pdfIO.C
  59
  60 \*---------------------------------------------------------------------------*/
  61
  62 #ifndef pdf_H
  63 #define pdf_H
  64
  65 #include "IOdictionary.H"
  66 #include "autoPtr.H"
  67 #include "Random.H"
  68
  69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  70
  71 namespace Foam
  72 {
  73
  74 /*---------------------------------------------------------------------------*\
  75                            Class pdf Declaration
  76 \*---------------------------------------------------------------------------*/
  77
  78 class pdf
  79 {
  80
  81 protected:
  82
  83     // Protected data
  84
  85         const dictionary& dict_;
  86
  87         Random& rndGen_;
  88
  89
  90 public:
  91
  92     //-Runtime type information
  93     TypeName("pdf");
  94
  95
  96     //- Declare runtime constructor selection table
  97     declareRunTimeSelectionTable
  98     (
  99         autoPtr,
 100         pdf,
 101         dictionary,
 102         (
 103             const dictionary& dict,
 104             Random& rndGen
 105         ),
 106         (dict, rndGen)
 107     );
 108
 109
 110     // Constructors
 111
 112         //- Construct from dictionary
 113         pdf(const dictionary& dict, Random& rndGen);
 114
 115
 116     //- Selector
 117     static autoPtr<pdf> New(const dictionary& dict, Random& rndGen);
 118
 119
 120     //- Destructor
 121     virtual ~pdf();
 122
 123
 124     // Member Functions
 125
 126         //- Sample the pdf
 127         virtual scalar sample() const = 0;
 128
 129         //- Return the minimum value
 130         virtual scalar minValue() const = 0;
 131
 132         //- Return the maximum value
 133         virtual scalar maxValue() const = 0;
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #endif
 144
 145 // ************************************************************************* //