src/thermophysicalModels/pdfs/RosinRammler/RosinRammler.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::RosinRammler
  27
  28 Description
  29     Rosin-Rammler pdf
  30
  31    @f[
  32        pdf = ( x/d )^n \exp ( -( x/d )^n )
  33    @f]
  34
  35
  36 SourceFiles
  37     RosinRammlerI.H
  38     RosinRammler.C
  39     RosinRammlerIO.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef RosinRammler_H
  44 #define RosinRammler_H
  45
  46 #include "pdf.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class RosinRammler Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class RosinRammler
  58 :
  59     public pdf
  60 {
  61     // Private data
  62
  63         dictionary pdfDict_;
  64
  65         //- min and max values of the distribution
  66         scalar minValue_;
  67         scalar maxValue_;
  68
  69         List<scalar> d_;
  70         List<scalar> n_;
  71         List<scalar> ls_;
  72
  73         scalar range_;
  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
  93         ~RosinRammler();
  94
  95
  96     // Member Functions
  97
  98     scalar sample() const;
  99
 100     scalar minValue() const;
 101     scalar maxValue() const;
 102
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //