src/thermophysicalModels/pdfs/exponential/exponential.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::exponential
  26
  27 Description
  28     exponential pdf
  29
  30 SourceFiles
  31     exponentialI.H
  32     exponential.C
  33     exponentialIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef exponential_H
  38 #define exponential_H
  39
  40 #include "pdf.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                         Class exponential Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class exponential
  52 :
  53     public pdf
  54 {
  55     // Private data
  56
  57         dictionary pdfDict_;
  58
  59         //- min and max values of the distribution
  60         scalar minValue_;
  61         scalar maxValue_;
  62
  63         List<scalar> lambda_;
  64         List<scalar> ls_;
  65
  66         scalar range_;
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("exponential");
  72
  73
  74     // Constructors
  75
  76         //- Construct from components
  77         exponential
  78         (
  79             const dictionary& dict,
  80             Random& rndGen
  81         );
  82
  83
  84     //- Destructor
  85     virtual ~exponential();
  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 //#include "exponentialI.H"
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //