src/thermophysicalModels/pdfs/RosinRammler/RosinRammler.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::RosinRammler
  26
  27 Description
  28     Rosin-Rammler pdf
  29
  30    @f[
  31        pdf = ( x/d )^n \exp ( -( x/d )^n )
  32    @f]
  33
  34
  35 SourceFiles
  36     RosinRammlerI.H
  37     RosinRammler.C
  38     RosinRammlerIO.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef RosinRammler_H
  43 #define RosinRammler_H
  44
  45 #include "pdf.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class RosinRammler Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class RosinRammler
  57 :
  58     public pdf
  59 {
  60     // Private data
  61
  62         dictionary pdfDict_;
  63
  64         //- min and max values of the distribution
  65         scalar minValue_;
  66         scalar maxValue_;
  67
  68         List<scalar> d_;
  69         List<scalar> n_;
  70         List<scalar> ls_;
  71
  72         scalar range_;
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("RosinRammler");
  79
  80
  81     // Constructors
  82
  83         //- Construct from components
  84         RosinRammler
  85         (
  86             const dictionary& dict,
  87             Random& rndGen
  88         );
  89
  90
  91     //- Destructor
  92     virtual ~RosinRammler();
  93
  94
  95     // Member Functions
  96
  97          //- Sample the pdf
  98         virtual scalar sample() const;
  99
 100         //- Return the minimum value
 101         virtual scalar minValue() const;
 102
 103         //- Return the maximum value
 104         virtual scalar maxValue() const;
 105 };
 106
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 } // End namespace Foam
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #endif
 115
 116 // ************************************************************************* //